1# queue.h 2 3 4## 概述 5 6声明队列的C接口。 7 8**引用文件：**<ffrt/queue.h> 9 10**库：** libffrt.z.so 11 12**系统能力：** SystemCapability.Resourceschedule.Ffrt.Core 13 14**起始版本：** 10 15 16**相关模块：**[FFRT](_f_f_r_t.md) 17 18 19## 汇总 20 21 22### 类型定义 23 24| 名称 | 描述 | 25| -------- | -------- | 26| typedef void \* [ffrt_queue_t](_f_f_r_t.md#ffrt_queue_t) | 队列句柄。 | 27 28 29### 枚举 30 31| 名称 | 描述 | 32| -------- | -------- | 33| [ffrt_queue_type_t](_f_f_r_t.md#ffrt_queue_type_t) {<br/>ffrt_queue_serial,<br/>ffrt_queue_concurrent,<br/>ffrt_queue_max<br/>} | 队列类型。 | 34 35 36### 函数 37 38| 名称 | 描述 | 39| -------- | -------- | 40| FFRT_C_API int [ffrt_queue_attr_init](_f_f_r_t.md#ffrt_queue_attr_init) ([ffrt_queue_attr_t](ffrt__queue__attr__t.md) \*attr) | 初始化队列属性。 | 41| FFRT_C_API void [ffrt_queue_attr_destroy](_f_f_r_t.md#ffrt_queue_attr_destroy) ([ffrt_queue_attr_t](ffrt__queue__attr__t.md) \*attr) | 销毁队列属性。 | 42| FFRT_C_API void [ffrt_queue_attr_set_qos](_f_f_r_t.md#ffrt_queue_attr_set_qos) ([ffrt_queue_attr_t](ffrt__queue__attr__t.md) \*attr, [ffrt_qos_t](_f_f_r_t.md#ffrt_qos_t) qos) | 设置队列QoS属性。 | 43| FFRT_C_API [ffrt_qos_t](_f_f_r_t.md#ffrt_qos_t) [ffrt_queue_attr_get_qos](_f_f_r_t.md#ffrt_queue_attr_get_qos) (const [ffrt_queue_attr_t](ffrt__queue__attr__t.md) \*attr) | 获取队列QoS属性。 | 44| FFRT_C_API void [ffrt_queue_attr_set_timeout](_f_f_r_t.md#ffrt_queue_attr_set_timeout) ([ffrt_queue_attr_t](ffrt__queue__attr__t.md) \*attr, uint64_t timeout_us) | 设置串行队列timeout属性。 | 45| FFRT_C_API uint64_t [ffrt_queue_attr_get_timeout](_f_f_r_t.md#ffrt_queue_attr_get_timeout) (const [ffrt_queue_attr_t](ffrt__queue__attr__t.md) \*attr) | 获取串行队列任务执行的timeout时间。 | 46| FFRT_C_API void [ffrt_queue_attr_set_callback](_f_f_r_t.md#ffrt_queue_attr_set_callback) ([ffrt_queue_attr_t](ffrt__queue__attr__t.md) \*attr, [ffrt_function_header_t](ffrt__function__header__t.md) \*f) | 设置串行队列超时回调方法。 | 47| FFRT_C_API [ffrt_function_header_t](ffrt__function__header__t.md) \* [ffrt_queue_attr_get_callback](_f_f_r_t.md#ffrt_queue_attr_get_callback) (const [ffrt_queue_attr_t](ffrt__queue__attr__t.md) \*attr) | 获取串行队列超时回调方法。 | 48| FFRT_C_API void [ffrt_queue_attr_set_max_concurrency](_f_f_r_t.md#ffrt_queue_attr_set_max_concurrency) ([ffrt_queue_attr_t](ffrt__queue__attr__t.md) \*attr, const int max_concurrency) | 设置并行队列最大并发度。 | 49| FFRT_C_API int [ffrt_queue_attr_get_max_concurrency](_f_f_r_t.md#ffrt_queue_attr_get_max_concurrency) (const [ffrt_queue_attr_t](ffrt__queue__attr__t.md) \*attr) | 获取并行队列最大并发度。 | 50| FFRT_C_API [ffrt_queue_t](_f_f_r_t.md#ffrt_queue_t) [ffrt_queue_create](_f_f_r_t.md#ffrt_queue_create) ([ffrt_queue_type_t](_f_f_r_t.md#ffrt_queue_type_t) type, const char \*name, const [ffrt_queue_attr_t](ffrt__queue__attr__t.md) \*attr) | 创建队列。 | 51| FFRT_C_API void [ffrt_queue_destroy](_f_f_r_t.md#ffrt_queue_destroy) ([ffrt_queue_t](_f_f_r_t.md#ffrt_queue_t) queue) | 销毁队列。 | 52| FFRT_C_API void [ffrt_queue_submit](_f_f_r_t.md#ffrt_queue_submit) ([ffrt_queue_t](_f_f_r_t.md#ffrt_queue_t) queue, [ffrt_function_header_t](ffrt__function__header__t.md) \*f, const [ffrt_task_attr_t](ffrt__task__attr__t.md) \*attr) | 提交一个任务到队列中调度执行。 | 53| FFRT_C_API [ffrt_task_handle_t](_f_f_r_t.md#ffrt_task_handle_t) [ffrt_queue_submit_h](_f_f_r_t.md#ffrt_queue_submit_h) ([ffrt_queue_t](_f_f_r_t.md#ffrt_queue_t) queue, [ffrt_function_header_t](ffrt__function__header__t.md) \*f, const [ffrt_task_attr_t](ffrt__task__attr__t.md) \*attr) | 提交一个任务到队列中调度执行，并返回任务句柄。 | 54| FFRT_C_API void [ffrt_queue_wait](_f_f_r_t.md#ffrt_queue_wait) ([ffrt_task_handle_t](_f_f_r_t.md#ffrt_task_handle_t) handle) | 等待队列中一个任务执行完成。 | 55| FFRT_C_API int [ffrt_queue_cancel](_f_f_r_t.md#ffrt_queue_cancel) ([ffrt_task_handle_t](_f_f_r_t.md#ffrt_task_handle_t) handle) | 取消队列中一个任务。 | 56| FFRT_C_API [ffrt_queue_t](_f_f_r_t.md#ffrt_queue_t) [ffrt_get_main_queue](_f_f_r_t.md#ffrt_get_main_queue) (void) | 获取主线程队列。 | 57| FFRT_C_API [ffrt_queue_t](_f_f_r_t.md#ffrt_queue_t) [ffrt_get_current_queue](_f_f_r_t.md#ffrt_get_current_queue) (void) | 获取应用Worker(ArkTs)线程队列。 | 58