C++ SDK
章节概览
| 章节 | 阅读重点 | 适合读者 |
|---|---|---|
| 概览与接入 | SDK 版本范围、快速接入、连接语义、线程模型和最小示例 | 首次接入 SDK 的开发者 |
| 数据结构 | 状态码、公共类型、业务数据结构、topic 常量和返回值约定 | 需要理解接口输入输出的开发者 |
| C++17 方法 | 按模块说明方法签名、参数、返回值、限制行为和兼容版本 | 使用 C++17 封装接口开发业务应用的开发者 |
| C99 接口 | C 风格接口总览、模块分组、句柄生命周期和 out 参数约束 | 需要接入 C ABI 或跨语言绑定的开发者 |
| 示例与验证 | Example 使用方式、测试入口、文档与样例的对应关系 | 需要快速验证接口行为或排查集成问题的开发者 |
阅读约定
方法页统一包含以下信息：
| 项 | 含义 |
|---|---|
| C++17 签名 | 公开头文件里的真实签名 |
| 说明依据 | 公开头文件、参数约束和返回值约定 |
| 输入 | 参数名、类型、含义、是否可空、取值要求 |
| 输出 | STATUS_CODE / std::pair<T, STATUS_CODE> / void 的具体解释 |
| 限制与行为 | 前置条件、默认值、失败返回和兼容性要求 |
| 相关类型 | 返回值结构、枚举和公共类型名称 |