C++ SDK
Reading Guide
| Chapter | Focus | Best For |
|---|---|---|
| Overview and Setup | SDK scope, quick start, connection semantics, thread model, and minimal examples | Developers integrating the SDK for the first time |
| Data Structures | Status codes, common types, business structures, topic constants, and return conventions | Developers who need to understand API input and output |
| C++17 Methods | Method signatures, parameters, return values, limitations, and compatible versions by module | Developers building applications with the C++17 facade |
| C99 API | C-style API overview, module grouping, handle lifecycle, and out-parameter rules | Developers integrating a C ABI or cross-language binding |
| Examples and Verification | Example usage, test entries, and the mapping between docs and samples | Developers validating behavior or troubleshooting integration |
Reading Conventions
Method pages use the following structure:
| Item | Meaning |
|---|---|
| C++17 Signature | The real signature exposed by the current public headers |
| Reference Source | Supplemental source for cross-checking the current SDK |
| Input | Parameter name, type, meaning, nullability, and value requirements |
| Output | Meaning of STATUS_CODE , std::pair<T, STATUS_CODE> , or void |
| Limits and Behavior | Preconditions, default values, failure data, and differences from other SDKs or old docs |
| Related Types | Direct links to the data structure pages for return-value structures |