type_def.h

Overview

The type_def.h file declares the common types.

Since: 10

Related module: FFRT

Summary

Structs

Name Description
struct  ffrt_function_header_t Describes a task execution function.
struct  ffrt_dependence_t Describes dependency data.
struct  ffrt_deps_t Describes dependencies.
struct  ffrt_task_attr_t Describes a task attribute.
struct  ffrt_queue_attr_t Describes a queue attribute.
struct  ffrt_condattr_t Describes a condition variable attribute.
struct  ffrt_mutexattr_t Describes a mutex attribute.
struct  ffrt_mutex_t Describes a mutex.
struct  ffrt_cond_t Describes a condition variable.

Types

Name Description
typedef int ffrt_qos_t Defines the QoS type.
typedef void(* ffrt_function_t) (void *) Defines the type of the pointer to a task execution function.
typedef void * ffrt_task_handle_t Defines the handle to a task.

Enums

Name Description
ffrt_qos_default_t {
ffrt_qos_inherit = -1, ffrt_qos_background, ffrt_qos_utility, ffrt_qos_default,
ffrt_qos_user_initiated
}		 Enumerates the task QoS types.
ffrt_storage_size_t {
ffrt_task_attr_storage_size = 128, ffrt_auto_managed_function_storage_size = 64 + sizeof(ffrt_function_header_t), ffrt_mutex_storage_size = 64, ffrt_cond_storage_size = 64,
ffrt_queue_attr_storage_size = 128
}		 Enumerates the storage sizes available for different types of structs.
ffrt_function_kind_t { ffrt_function_kind_general, ffrt_function_kind_queue } Enumerates the task types.
ffrt_dependence_type_t { ffrt_dependence_data, ffrt_dependence_task } Enumerates the dependency types.
ffrt_error_t {
ffrt_error = -1, ffrt_success = 0, ffrt_error_nomem = ENOMEM, ffrt_error_timedout = ETIMEDOUT,
ffrt_error_busy = EBUSY, ffrt_error_inval = EINVAL
}		 Enumerates the FFRT error codes.