2019-09-04 14:17:18 +08:00
|
|
|
|
## tk\_ostream\_t
|
|
|
|
|
|
### 概述
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-09-30 17:11:53 +08:00
|
|
|
|
|
|
|
|
|
|
input stream interface
|
|
|
|
|
|
|
2019-09-04 14:17:18 +08:00
|
|
|
|
|
|
|
|
|
|
----------------------------------
|
|
|
|
|
|
### 函数
|
|
|
|
|
|
<p id="tk_ostream_t_methods">
|
|
|
|
|
|
|
|
|
|
|
|
| 函数名称 | 说明 |
|
|
|
|
|
|
| -------- | ------------ |
|
|
|
|
|
|
| <a href="#tk_ostream_t_tk_ostream_flush">tk\_ostream\_flush</a> | |
|
|
|
|
|
|
| <a href="#tk_ostream_t_tk_ostream_seek">tk\_ostream\_seek</a> | |
|
|
|
|
|
|
| <a href="#tk_ostream_t_tk_ostream_write">tk\_ostream\_write</a> | |
|
|
|
|
|
|
| <a href="#tk_ostream_t_tk_ostream_write_len">tk\_ostream\_write\_len</a> | |
|
|
|
|
|
|
#### tk\_ostream\_flush 函数
|
|
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
|
|
|
|
* 函数功能：
|
|
|
|
|
|
|
2019-09-30 17:11:53 +08:00
|
|
|
|
> <p id="tk_ostream_t_tk_ostream_flush">
|
|
|
|
|
|
刷新数据。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-09-04 14:17:18 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* 函数原型：
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
ret_t tk_ostream_flush (tk_ostream_t* stream);
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
* 参数说明：
|
|
|
|
|
|
|
|
|
|
|
|
| 参数 | 类型 | 说明 |
|
|
|
|
|
|
| -------- | ----- | --------- |
|
|
|
|
|
|
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
|
|
|
|
|
| stream | tk\_ostream\_t* | ostream对象。 |
|
|
|
|
|
|
#### tk\_ostream\_seek 函数
|
|
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
|
|
|
|
* 函数功能：
|
|
|
|
|
|
|
2019-09-30 17:11:53 +08:00
|
|
|
|
> <p id="tk_ostream_t_tk_ostream_seek">
|
|
|
|
|
|
设置偏移量。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-09-04 14:17:18 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* 函数原型：
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
ret_t tk_ostream_seek (tk_ostream_t* stream, uint32_t offset);
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
* 参数说明：
|
|
|
|
|
|
|
|
|
|
|
|
| 参数 | 类型 | 说明 |
|
|
|
|
|
|
| -------- | ----- | --------- |
|
|
|
|
|
|
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
|
|
|
|
|
| stream | tk\_ostream\_t* | ostream对象。 |
|
|
|
|
|
|
| offset | uint32\_t | 偏移量。 |
|
|
|
|
|
|
#### tk\_ostream\_write 函数
|
|
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
|
|
|
|
* 函数功能：
|
|
|
|
|
|
|
2019-09-30 17:11:53 +08:00
|
|
|
|
> <p id="tk_ostream_t_tk_ostream_write">
|
|
|
|
|
|
写入数据。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-09-04 14:17:18 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* 函数原型：
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
int32_t tk_ostream_write (tk_ostream_t* stream, const uint8_t* buff, uint32_t max_size);
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
* 参数说明：
|
|
|
|
|
|
|
|
|
|
|
|
| 参数 | 类型 | 说明 |
|
|
|
|
|
|
| -------- | ----- | --------- |
|
|
|
|
|
|
| 返回值 | int32\_t | 返回负数表示写入失败，否则返回实际写入数据的长度。 |
|
|
|
|
|
|
| stream | tk\_ostream\_t* | ostream对象。 |
|
|
|
|
|
|
| buff | const uint8\_t* | 返回数据的缓冲区。 |
|
|
|
|
|
|
| max\_size | uint32\_t | 缓冲区的大小。 |
|
|
|
|
|
|
#### tk\_ostream\_write\_len 函数
|
|
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
|
|
|
|
* 函数功能：
|
|
|
|
|
|
|
2019-09-30 17:11:53 +08:00
|
|
|
|
> <p id="tk_ostream_t_tk_ostream_write_len">
|
|
|
|
|
|
写入指定长度的数据。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-09-04 14:17:18 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* 函数原型：
|
|
|
|
|
|
|
|
|
|
|
|
```
|
2019-09-30 17:11:53 +08:00
|
|
|
|
int32_t tk_ostream_write_len (tk_ostream_t* stream, const uint8_t* buff, uint32_t max_size, uint32_t timeout_ms);
|
2019-09-04 14:17:18 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
* 参数说明：
|
|
|
|
|
|
|
|
|
|
|
|
| 参数 | 类型 | 说明 |
|
|
|
|
|
|
| -------- | ----- | --------- |
|
|
|
|
|
|
| 返回值 | int32\_t | 返回负数表示写入失败，否则返回实际写入数据的长度。 |
|
|
|
|
|
|
| stream | tk\_ostream\_t* | ostream对象。 |
|
|
|
|
|
|
| buff | const uint8\_t* | 返回数据的缓冲区。 |
|
|
|
|
|
|
| max\_size | uint32\_t | 缓冲区的大小。 |
|
2019-09-30 17:11:53 +08:00
|
|
|
|
| timeout\_ms | uint32\_t | timeout. |
|
