mirror of
https://gitee.com/zlgopen/awtk.git
synced 2024-12-11 06:53:32 +08:00
5.6 KiB
5.6 KiB
tk_istream_t
概述
输入流的接口。
函数
函数名称 | 说明 |
---|---|
tk_istream_eos | 判断数据是否读完。 |
tk_istream_flush | 刷新数据。 |
tk_istream_read | 读取数据。 |
tk_istream_read_len | 读取指定长度的数据。 |
tk_istream_read_line | 读取一行数据。 |
tk_istream_read_line_str | 读取一行数据。 |
tk_istream_seek | 设置偏移量。 |
tk_istream_tell | 获取当前读取位置。 |
tk_istream_wait_for_data | 等待数据。 |
tk_istream_eos 函数
- 函数功能:
判断数据是否读完。
- 函数原型:
bool_t tk_istream_eos (tk_istream_t* stream);
- 参数说明:
参数 | 类型 | 说明 |
---|---|---|
返回值 | bool_t | 返回TRUE表示数据读完,否则表示还有数据。 |
stream | tk_istream_t* | istream对象。 |
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, void* buff, uint32_t max_size);
- 参数说明:
参数 | 类型 | 说明 |
---|---|---|
返回值 | int32_t | 返回负数表示读取失败,否则返回实际读取数据的长度。 |
stream | tk_istream_t* | istream对象。 |
buff | void* | 返回数据的缓冲区。 |
max_size | uint32_t | 缓冲区的大小。 |
tk_istream_read_len 函数
- 函数功能:
读取指定长度的数据。
- 函数原型:
int32_t tk_istream_read_len (tk_istream_t* stream, void* buff, uint32_t max_size, uint32_t timeout_ms);
- 参数说明:
参数 | 类型 | 说明 |
---|---|---|
返回值 | int32_t | 返回负数表示读取失败,否则返回实际读取数据的长度。 |
stream | tk_istream_t* | istream对象。 |
buff | void* | 返回数据的缓冲区。 |
max_size | uint32_t | 缓冲区的大小。 |
timeout_ms | uint32_t | timeout. |
tk_istream_read_line 函数
- 函数功能:
读取一行数据。
- 函数原型:
int32_t tk_istream_read_line (tk_istream_t* stream, void* buff, uint32_t max_size, uint32_t timeout_ms);
- 参数说明:
参数 | 类型 | 说明 |
---|---|---|
返回值 | int32_t | 返回负数表示读取失败,否则返回实际读取数据的长度。 |
stream | tk_istream_t* | istream对象。 |
buff | void* | 返回数据的缓冲区。 |
max_size | uint32_t | 缓冲区的大小。 |
timeout_ms | uint32_t | timeout. |
tk_istream_read_line_str 函数
- 函数功能:
读取一行数据。 istream必须支持随机读写(seek/tell)。
- 函数原型:
ret_t tk_istream_read_line_str (tk_istream_t* stream, str_t* str);
- 参数说明:
参数 | 类型 | 说明 |
---|---|---|
返回值 | ret_t | 返回RET_OK表示成功,否则表示失败。 |
stream | tk_istream_t* | istream对象。 |
str | str_t* | 返回数据的str对象。 |
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_tell 函数
- 函数功能:
获取当前读取位置。
- 函数原型:
int32_t tk_istream_tell (tk_istream_t* stream);
- 参数说明:
参数 | 类型 | 说明 |
---|---|---|
返回值 | int32_t | 返回负数表示失败,否则返回当前读取位置。 |
stream | tk_istream_t* | istream对象。 |
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 | 超时时间。 |