awtk/docs/manual/object_rbuffer_t.md

69 lines
1.8 KiB
Markdown
Raw Normal View History

2021-01-11 08:23:05 +08:00
## object\_rbuffer\_t
### 概述
![image](images/object_rbuffer_t_0.png)
将rbuffer包装成object。
----------------------------------
### 函数
<p id="object_rbuffer_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
2022-12-05 12:10:53 +08:00
| <a href="#object_rbuffer_t_object_rbuffer_cast">object\_rbuffer\_cast</a> | 转换为object_rbuffer对象。 |
2021-01-11 08:23:05 +08:00
| <a href="#object_rbuffer_t_object_rbuffer_create">object\_rbuffer\_create</a> | 创建rbuffer对象。 |
### 属性
<p id="object_rbuffer_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#object_rbuffer_t_rbuffer">rbuffer</a> | rbuffer\_t* | rbuffer对象。 |
2022-12-05 12:10:53 +08:00
#### object\_rbuffer\_cast 函数
-----------------------
* 函数功能:
> <p id="object_rbuffer_t_object_rbuffer_cast">转换为object_rbuffer对象。
* 函数原型:
```
object_rbuffer_t* object_rbuffer_cast (tk_object_t* obj);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | object\_rbuffer\_t* | object\_rbuffer对象。 |
| obj | tk\_object\_t* | object\_rbuffer对象。 |
2021-01-11 08:23:05 +08:00
#### object\_rbuffer\_create 函数
-----------------------
* 函数功能:
> <p id="object_rbuffer_t_object_rbuffer_create">创建rbuffer对象。
* 函数原型:
```
2022-12-05 12:10:53 +08:00
tk_object_t* object_rbuffer_create (const uint8_t* data, uint16_t capacity);
2021-01-11 08:23:05 +08:00
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
2022-12-05 12:10:53 +08:00
| 返回值 | tk\_object\_t* | 返回object对象。 |
2021-01-11 08:23:05 +08:00
| data | const uint8\_t* | 缓冲区。 |
| capacity | uint16\_t | 缓冲区的容量。 |
#### rbuffer 属性
-----------------------
> <p id="object_rbuffer_t_rbuffer">rbuffer对象。
* 类型rbuffer\_t*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |