awtk/docs/manual/tk_ostream_shdlc_t.md

tk_ostream_shdlc_t

概述

reliable ostream base on simple HDLC

函数

函数名称	说明
action_queue_create	创建action_queue对象。
action_queue_destroy	销毁。
action_queue_recv	接收一个请求。
action_queue_send	发送一个请求。
tk_ostream_shdlc_create	创建ostream对象。

属性

属性名称	类型	说明
compress_threshold	uint32_t	激活压缩的阈值。
retry_times	uint32_t	失败重传次数。
timeout	uint32_t	读写超时时间(ms)

action_queue_create 函数

---

• 函数功能：

创建action_queue对象。

• 函数原型：

action_queue_t* action_queue_create (uint32_t capacity);

• 参数说明：

参数	类型	说明
返回值	action_queue_t*	action_queue对象。
capacity	uint32_t	action的容量。

action_queue_destroy 函数

---

• 函数功能：

销毁。

• 函数原型：

ret_t action_queue_destroy (action_queue_t* q);

• 参数说明：

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

action_queue_recv 函数

---

• 函数功能：

接收一个请求。

• 函数原型：

ret_t action_queue_recv (action_queue_t* q, qaction_t** action);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
q	action_queue_t*	action_queue对象。
action	qaction_t**	用于返回action对象。

action_queue_send 函数

---

• 函数功能：

发送一个请求。

• 函数原型：

ret_t action_queue_send (action_queue_t* q, qaction_t* action);

• 参数说明：

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

tk_ostream_shdlc_create 函数

---

• 函数功能：

创建ostream对象。

只能由iostream_shdlc调用。

• 函数原型：

tk_ostream_t* tk_ostream_shdlc_create (tk_iostream_shdlc_t* iostream);

• 参数说明：

参数	类型	说明
返回值	tk_ostream_t*	返回ostream对象。
iostream	tk_iostream_shdlc_t*	iostream对象。

compress_threshold 属性

---

激活压缩的阈值。

• 类型：uint32_t

retry_times 属性

---

失败重传次数。

• 类型：uint32_t

timeout 属性

---

读写超时时间(ms)

• 类型：uint32_t