type_def.h

Overview

The type_def.h file declares the common types.

File to include: <ffrt/type_def.h>

Library: libffrt.z.so

System capability: SystemCapability.Resourceschedule.Ffrt.Core

Since: 10

Related module: FFRT

Summary

Variables

Name	typedef Keyword	Description
int	ffrt_timer_t	Handle to the timer.
int	ffrt_qos_t	QoS type.
using qos = int	-	QoS type. Since: 10

Structs

Name	typedef Keyword	Description
ffrt_function_header_t	ffrt_function_header_t	Describes a task execution function.
ffrt_dependence_t	ffrt_dependence_t	Describes dependency data.
ffrt_deps_t	ffrt_deps_t	Describes dependencies.
ffrt_task_attr_t	ffrt_task_attr_t	Describes a task attribute.
ffrt_queue_attr_t	ffrt_queue_attr_t	Describes a serial queue attribute.
ffrt_condattr_t	ffrt_condattr_t	Describes a condition variable attribute.
ffrt_mutexattr_t	ffrt_mutexattr_t	Describes a mutex attribute.
ffrt_rwlockattr_t	ffrt_rwlockattr_t	Describes a read-write lock attribute.
ffrt_mutex_t	ffrt_mutex_t	Describes a mutex.
ffrt_rwlock_t	ffrt_rwlock_t	Describes a read-write lock.
ffrt_cond_t	ffrt_cond_t	Describes a condition variable.
void*	ffrt_task_handle_t	Defines the handle to a task.
ffrt_fiber_t	ffrt_fiber_t	Fiber structure.

Enums

Name	typedef Keyword	Description
ffrt_queue_priority_t	ffrt_queue_priority_t	Enumerates the task priority types.
ffrt_qos_default_t	ffrt_qos_default_t	Enumerates the task QoS types.
ffrt_storage_size_t	ffrt_storage_size_t	Enumerates the storage sizes available for different types of structs.
ffrt_function_kind_t	ffrt_function_kind_t	Enumerates the task types.
ffrt_dependence_type_t	ffrt_dependence_type_t	Enumerates the dependency types.
ffrt_error_t	ffrt_error_t	Enumerates the FFRT error codes.
ffrt_mutex_type	ffrt_mutex_type	Enumerates the mutex types. ffrt_mutex_normal indicates a normal mutex, ffrt_mutex_recursive indicates a recursive mutex, and ffrt_mutex_default indicates a default mutex.
qos_default	-	Enumerates the task QoS types.

Function

Name	typedef Keyword	Description
typedef void(*ffrt_function_t)(void*)	ffrt_function_t	Defines the type of the pointer to a task execution function.
typedef void (*ffrt_poller_cb)(void* data, uint32_t event)	ffrt_poller_cb	Defines the poller callback function.
typedef void (*ffrt_timer_cb)(void* data)	ffrt_timer_cb	Defines the timer callback function.

Enum Description

ffrt_queue_priority_t

enum ffrt_queue_priority_t

Description

Enumerates the task priority types.

Since: 12

Enum Item	Description
ffrt_queue_priority_immediate = 0	Immediate priority.
ffrt_queue_priority_high	High priority.
ffrt_queue_priority_low	Low priority.
ffrt_queue_priority_idle	Lowest priority.

ffrt_qos_default_t

enum ffrt_qos_default_t

Description

Enumerates the task QoS types.

Since: 10

Enum Item	Description
ffrt_qos_inherit = -1	Inherited task QoS.
ffrt_qos_background	Background task.
ffrt_qos_utility	Real-time utility.
ffrt_qos_default	Default type.
ffrt_qos_user_initiated	User initiated.
ffrt_qos_deadline_request	Time limit request. Since: 23
ffrt_qos_user_interactive	User interaction. Since: 23
ffrt_qos_max = ffrt_qos_user_interactive	Highest QoS level. Since: 23

ffrt_storage_size_t

enum ffrt_storage_size_t

Description

Enumerates the storage sizes available for different types of structs.

Since: 10

Enum Item	Description
ffrt_task_attr_storage_size = 128	Storage size for the task attribute struct.
ffrt_auto_managed_function_storage_size = 64 + sizeof(ffrt_function_header_t)	Storage size for the task execution function struct.
ffrt_mutex_storage_size = 64	Storage size for the mutex struct.
ffrt_cond_storage_size = 64	Storage size for the condition variable struct.
ffrt_queue_attr_storage_size = 128	Storage size for the queue attribute struct.
ffrt_rwlock_storage_size = 64	Read-write lock. Since: 18
ffrt_fiber_storage_size	Fiber size across different platforms (in bytes). AArch64 architecture: 22 bytes; Arm architecture: 64 bytes; x86_64 architecture: 8 bytes; other platforms: not supported. Since: 20

ffrt_function_kind_t

enum ffrt_function_kind_t

Description

Task type.

Since: 10

Enum Item	Description
ffrt_function_kind_general	General task.
ffrt_function_kind_queue	Queue task.

ffrt_dependence_type_t

enum ffrt_dependence_type_t

Description

Enumerates the dependency types.

Since: 10

Enum Item	Description
ffrt_dependence_data	Data dependency.
ffrt_dependence_task	Task dependency.

ffrt_error_t

enum ffrt_error_t

Description

Enumerates the FFRT error codes.

Since: 10

Enum Item	Description
ffrt_error = -1	Failure.
ffrt_success = 0	Success.
ffrt_error_nomem = ENOMEM	Insufficient memory.
ffrt_error_timedout = ETIMEDOUT	Timeout.
ffrt_error_busy = EBUSY	Try again.
ffrt_error_inval = EINVAL	Invalid value.

ffrt_mutex_type

enum ffrt_mutex_type

Description

Enumerates the mutex types. ffrt_mutex_normal indicates a normal mutex, ffrt_mutex_recursive indicates a recursive mutex, and ffrt_mutex_default indicates a default mutex.

Since: 12

Enum Item	Description
ffrt_mutex_normal = 0	Normal mutex.
ffrt_mutex_recursive = 2	Recursive mutex.
ffrt_mutex_default = ffrt_mutex_normal	Default mutex.

qos_default

enum qos_default

Description

Enumerates the task QoS types.

Since: 10

Enum Item	Description
qos_inherit = ffrt_qos_inherit	Inherited task QoS.
qos_background = ffrt_qos_background	Background task.
qos_utility = ffrt_qos_utility	Real-time utility.
qos_default = ffrt_qos_default	Default type.
qos_user_initiated = ffrt_qos_user_initiated	User initiated.
qos_deadline_request = ffrt_qos_deadline_request	Time limit request. Since: 23
qos_user_interactive = ffrt_qos_user_interactive	User interaction. Since: 23
qos_max = ffrt_qos_user_interactive	Highest QoS level. Since: 23

Function Description

ffrt_function_t()

typedef void(*ffrt_function_t)(void*)

Description

Defines the type of the pointer to a task execution function.

Since: 10

ffrt_poller_cb()

typedef void (*ffrt_poller_cb)(void* data, uint32_t event)

Description

Defines the poller callback function.

Since: 12

ffrt_timer_cb()

typedef void (*ffrt_timer_cb)(void* data)

Description

Defines the timer callback function.

Since: 12

你可能感兴趣的鸿蒙文章

openharmony 鸿蒙 capi-fiber-h

openharmony 鸿蒙 capi-ffrt-ffrt-mutex-t

openharmony 鸿蒙 capi-ffrt-ffrt-rwlockattr-t

openharmony 鸿蒙 capi-loop-h

openharmony 鸿蒙 Readme-EN

openharmony 鸿蒙 capi-ffrt-ffrt-rwlock-t

openharmony 鸿蒙 capi-shared-mutex-h

openharmony 鸿蒙 capi-ffrt-ffrt-queue-attr-t

openharmony 鸿蒙 capi-ffrt

openharmony 鸿蒙 capi-ffrt-ffrt-fiber-t