awtk/docs/manual/waitable_action_queue_t.md

waitable_action_queue_t

概述

waitable actionqueue

函数

函数名称	说明
waitable_action_queue_create	创建waitable_action_queue对象。
waitable_action_queue_destroy	销毁。
waitable_action_queue_recv	接收一个请求。
waitable_action_queue_send	发送一个请求。

waitable_action_queue_create 函数

---

• 函数功能：

创建waitable_action_queue对象。

• 函数原型：

waitable_action_queue_t* waitable_action_queue_create (uint16_t capacity);

• 参数说明：

参数	类型	说明
返回值	waitable_action_queue_t*	waitable_action_queue对象。
capacity	uint16_t	action的容量。

waitable_action_queue_destroy 函数

---

• 函数功能：

销毁。

• 函数原型：

ret_t waitable_action_queue_destroy (waitable_action_queue_t* q);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
q	waitable_action_queue_t*	waitable_action_queue对象。

waitable_action_queue_recv 函数

---

• 函数功能：

接收一个请求。

• 函数原型：

ret_t waitable_action_queue_recv (waitable_action_queue_t* q, qaction_t** action, uint32_t timeout_ms);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
q	waitable_action_queue_t*	waitable_action_queue对象。
action	qaction_t**	用于返回action对象。
timeout_ms	uint32_t	超时时间(ms)

waitable_action_queue_send 函数

---

• 函数功能：

发送一个请求。

• 函数原型：

ret_t waitable_action_queue_send (waitable_action_queue_t* q, qaction_t* action, uint32_t timeout_ms);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
q	waitable_action_queue_t*	waitable_action_queue对象。
action	qaction_t*	action对象。
timeout_ms	uint32_t	超时时间(ms)