queue.h

概述

声明队列的C接口。

引用文件：<ffrt/queue.h>

库： libffrt.z.so

系统能力： SystemCapability.Resourceschedule.Ffrt.Core

起始版本： 10

相关模块：FFRT

汇总

类型定义

名称	描述
typedef void * ffrt_queue_t	队列句柄。

枚举

名称	描述
ffrt_queue_type_t { ffrt_queue_serial, ffrt_queue_concurrent, ffrt_queue_max }	队列类型。

函数

名称	描述
FFRT_C_API int ffrt_queue_attr_init (ffrt_queue_attr_t *attr)	初始化队列属性。
FFRT_C_API void ffrt_queue_attr_destroy (ffrt_queue_attr_t *attr)	销毁队列属性。
FFRT_C_API void ffrt_queue_attr_set_qos (ffrt_queue_attr_t *attr, ffrt_qos_t qos)	设置队列QoS属性。
FFRT_C_API ffrt_qos_t ffrt_queue_attr_get_qos (const ffrt_queue_attr_t *attr)	获取队列QoS属性。
FFRT_C_API void ffrt_queue_attr_set_timeout (ffrt_queue_attr_t *attr, uint64_t timeout_us)	设置串行队列timeout属性。
FFRT_C_API uint64_t ffrt_queue_attr_get_timeout (const ffrt_queue_attr_t *attr)	获取串行队列任务执行的timeout时间。
FFRT_C_API void ffrt_queue_attr_set_callback (ffrt_queue_attr_t *attr, ffrt_function_header_t *f)	设置串行队列超时回调方法。
FFRT_C_API ffrt_function_header_t * ffrt_queue_attr_get_callback (const ffrt_queue_attr_t *attr)	获取串行队列超时回调方法。
FFRT_C_API void ffrt_queue_attr_set_max_concurrency (ffrt_queue_attr_t *attr, const int max_concurrency)	设置并行队列最大并发度。
FFRT_C_API int ffrt_queue_attr_get_max_concurrency (const ffrt_queue_attr_t *attr)	获取并行队列最大并发度。
FFRT_C_API ffrt_queue_t ffrt_queue_create (ffrt_queue_type_t type, const char *name, const ffrt_queue_attr_t *attr)	创建队列。
FFRT_C_API void ffrt_queue_destroy (ffrt_queue_t queue)	销毁队列。
FFRT_C_API void ffrt_queue_submit (ffrt_queue_t queue, ffrt_function_header_t *f, const ffrt_task_attr_t *attr)	提交一个任务到队列中调度执行。
FFRT_C_API ffrt_task_handle_t ffrt_queue_submit_h (ffrt_queue_t queue, ffrt_function_header_t *f, const ffrt_task_attr_t *attr)	提交一个任务到队列中调度执行，并返回任务句柄。
FFRT_C_API void ffrt_queue_wait (ffrt_task_handle_t handle)	等待队列中一个任务执行完成。
FFRT_C_API int ffrt_queue_cancel (ffrt_task_handle_t handle)	取消队列中一个任务。
FFRT_C_API ffrt_queue_t ffrt_get_main_queue (void)	获取主线程队列。
FFRT_C_API ffrt_queue_t ffrt_get_current_queue (void)	获取应用Worker(ArkTs)线程队列。