Skip to content

C++ SDK

Reading Guide

ChapterFocusBest For
Overview and SetupSDK scope, quick start, connection semantics, thread model, and minimal examplesDevelopers integrating the SDK for the first time
Data StructuresStatus codes, common types, business structures, topic constants, and return conventionsDevelopers who need to understand API input and output
C++17 MethodsMethod signatures, parameters, return values, limitations, and compatible versions by moduleDevelopers building applications with the C++17 facade
C99 APIC-style API overview, module grouping, handle lifecycle, and out-parameter rulesDevelopers integrating a C ABI or cross-language binding
Examples and VerificationExample usage, test entries, and the mapping between docs and samplesDevelopers validating behavior or troubleshooting integration

Reading Conventions

Method pages use the following structure:

ItemMeaning
C++17 SignatureThe real signature exposed by the current public headers
Reference SourceSupplemental source for cross-checking the current SDK
InputParameter name, type, meaning, nullability, and value requirements
OutputMeaning of STATUS_CODE , std::pair<T, STATUS_CODE> , or void
Limits and BehaviorPreconditions, default values, failure data, and differences from other SDKs or old docs
Related TypesDirect links to the data structure pages for return-value structures