C++ Stream Connector Guide¶
This is the official user guide for the C++ STREAM client connector family.
Table Of Contents¶
| Document | Content |
|---|---|
| 01 — Overview | Product family composition, deployment unit, supported engines |
| 02 — Getting Started | Installation, CMake integration, first connection and request |
| 03 — Connector Options | Endpoint, timeout, heartbeat, reconnect, dispatch mode |
| 04 — Sending Packets | send, request, metadata, compression, codec |
| 05 — Receiving Packets | on(), dispatch(), wait_for(), event callbacks |
| 06 — Connection Lifecycle | connect, close, state transitions, reconnect, heartbeat |
| 07 — Error Handling | result_t, error_code_t, per-error handling |
| 08 — E2E Client | async(), co_await, task_t, perf scenarios |
| 09 — Engine Adapters | Using the Unreal, Godot, Axmol wrappers |
| 10 — Packaging | vcpkg, Conan, CMake find_package, build features |
| 11 — Performance Testing | Running smoke/scale, interpreting reports |
Quick Reference¶
General C++ client: Getting Started → Sending Packets → Receiving Packets
Server e2e/perf scenario: E2E Client → Performance Testing
Engine integration: Engine Adapters → Connection Lifecycle
Deployment/build: Packaging