xxq250
/
homework-jianmu
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

remove useless docs

This commit is contained in:
WANG MINGMING 2025-01-03 13:54:19 +08:00 committed by GitHub
parent 4984a6ceba
commit 3398035c7b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/zh/14-reference/05-connector/10-cpp.mdx
View File

@ -1125,11 +1125,8 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
- conf：[入参] 指向一个有效的 tmq_conf_t 结构体指针，该结构体代表一个 TMQ 配置对象。 - conf：[入参] 指向一个有效的 tmq_conf_t 结构体指针，该结构体代表一个 TMQ 配置对象。
- cb：[入参] 指向一个有效的 tmq_commit_cb 回调函数指针，该函数将在消息被消费后调用以确认消息处理状态。 - cb：[入参] 指向一个有效的 tmq_commit_cb 回调函数指针，该函数将在消息被消费后调用以确认消息处理状态。
- param：[入参] 传递给回调函数的用户自定义参数。 - param：[入参] 传递给回调函数的用户自定义参数。
- 设置自动提交回调函数的定义如下：
设置自动提交回调函数的定义如下： `typedef void(tmq_commit_cb(tmq_t *tmq, int32_t code, void *param))`
```
typedef void(tmq_commit_cb(tmq_t *tmq, int32_t code, void *param))
```
- `void tmq_conf_destroy(tmq_conf_t *conf)` - `void tmq_conf_destroy(tmq_conf_t *conf)`
- **接口说明**：销毁一个 TMQ 配置对象并释放相关资源。 - **接口说明**：销毁一个 TMQ 配置对象并释放相关资源。
@ -1243,11 +1240,6 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
- cb：[入参] 一个回调函数指针，当提交完成时会被调用。 - cb：[入参] 一个回调函数指针，当提交完成时会被调用。
- param：[入参] 一个用户自定义的参数，将在回调函数中传递给 cb。 - param：[入参] 一个用户自定义的参数，将在回调函数中传递给 cb。
**说明**
- commit接口分为两种类型，每种类型有同步和异步接口：
- 第一种类型：根据消息提交，提交消息里的进度，如果消息传 NULL，提交当前 consumer 所有消费的 vgroup 的当前进度 : tmq_commit_sync/tmq_commit_async
- 第二种类型：根据某个 topic 的某个 vgroup 的 offset 提交 : tmq_commit_offset_sync/tmq_commit_offset_async
- `int64_t tmq_position(tmq_t *tmq, const char *pTopicName, int32_t vgId)` - `int64_t tmq_position(tmq_t *tmq, const char *pTopicName, int32_t vgId)`
- **接口说明**：获取当前消费位置，即已消费到的数据位置的下一个位置. - **接口说明**：获取当前消费位置，即已消费到的数据位置的下一个位置.
- tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。 - tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。
@ -1255,7 +1247,7 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
- vgId：[入参] 虚拟组 vgroup 的 ID。 - vgId：[入参] 虚拟组 vgroup 的 ID。
- **返回值**：`>=0`：成功，返回一个 int64_t 类型的值，表示当前位置的偏移量。`<0`：失败，返回值就是错误码，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。 - **返回值**：`>=0`：成功，返回一个 int64_t 类型的值，表示当前位置的偏移量。`<0`：失败，返回值就是错误码，可调用函数 `char *tmq_err2str(int32_t code)` 获取更详细的错误信息。
- `int32_t tmq_offset_seek(tmq_t *tmq, const char *pTopicName, int32_t vgId, int64_t offset)` - `int32_t tmq_offset_seek(tmq_t *tmq, const char *pTopicName, int32_t vgId, int64_t offset)`
- **接口说明**：将 TMQ 消费者对象在某个特定 topic 和 vgroup 的偏移量设置到指定的位置。 - **接口说明**：将 TMQ 消费者对象在某个特定 topic 和 vgroup 的偏移量设置到指定的位置。
- tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。 - tmq：[入参] 指向一个有效的 tmq_t 结构体指针，该结构体代表一个 TMQ 消费者对象。
- pTopicName：[入参] 要查询当前位置的主题名称。 - pTopicName：[入参] 要查询当前位置的主题名称。