awtk/docs/manual/tk_istream_t.md

tk_istream_t

概述

输入流的接口。

---

函数

函数名称	说明
tk_istream_flush	刷新数据。
tk_istream_read	读取数据。
tk_istream_read_len	读取指定长度的数据。
tk_istream_read_line	读取一行数据。
tk_istream_seek	设置偏移量。
tk_istream_wait_for_data	等待数据。

tk_istream_flush 函数

---

• 函数功能：

刷新数据。

• 函数原型：

ret_t tk_istream_flush (tk_istream_t* stream);

• 参数说明：

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

tk_istream_read 函数

---

• 函数功能：

读取数据。

• 函数原型：

int32_t tk_istream_read (tk_istream_t* stream, uint8_t* buff, uint32_t max_size);

• 参数说明：

参数	类型	说明
返回值	int32_t	返回负数表示读取失败，否则返回实际读取数据的长度。
stream	tk_istream_t*	istream对象。
buff	uint8_t*	返回数据的缓冲区。
max_size	uint32_t	缓冲区的大小。

tk_istream_read_len 函数

---

• 函数功能：

读取指定长度的数据。

• 函数原型：

int32_t tk_istream_read_len (tk_istream_t* stream, uint8_t* buff, uint32_t max_size, uint32_t timeout_ms);

• 参数说明：

参数	类型	说明
返回值	int32_t	返回负数表示读取失败，否则返回实际读取数据的长度。
stream	tk_istream_t*	istream对象。
buff	uint8_t*	返回数据的缓冲区。
max_size	uint32_t	缓冲区的大小。
timeout_ms	uint32_t	timeout.

tk_istream_read_line 函数

---

• 函数功能：

读取一行数据。

• 函数原型：

int32_t tk_istream_read_line (tk_istream_t* stream, uint8_t* buff, uint32_t max_size, uint32_t timeout_ms);

• 参数说明：

参数	类型	说明
返回值	int32_t	返回负数表示读取失败，否则返回实际读取数据的长度。
stream	tk_istream_t*	istream对象。
buff	uint8_t*	返回数据的缓冲区。
max_size	uint32_t	缓冲区的大小。
timeout_ms	uint32_t	timeout.

tk_istream_seek 函数

---

• 函数功能：

设置偏移量。

• 函数原型：

ret_t tk_istream_seek (tk_istream_t* stream, uint32_t offset);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
stream	tk_istream_t*	istream对象。
offset	uint32_t	偏移量。

tk_istream_wait_for_data 函数

---

• 函数功能：

等待数据。

• 函数原型：

ret_t tk_istream_wait_for_data (tk_istream_t* stream, uint32_t timeout_ms);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
stream	tk_istream_t*	istream对象。
timeout_ms	uint32_t	超时时间。