ZLink Framework C++ — Documentation¶
The documentation hub for the zlink::framework C++ artifact.
| Document | Scope |
|---|---|
| 01 System Structure | Packages/build targets, application host, DI container, configuration, logging, HTTP scope/middleware order, feature registration |
| Exact Interface Per Feature | App/Host, builder, messaging, Spot, Actor, STREAM, Location, and monitoring's exact public contract |
| 60 HTTP Hosting | The HTTP hosting contract |
| 61 Embedded HTTP Server | The embedded server |
The meaning and behavioral rules of a feature are owned by the common spec. The C++ documents fix the exact public surface that meaning takes in C++.
Sample and E2E JSON config files, the ban on environment variables, and typed-binding criteria follow the Sample/E2E Configuration Policy.
Why C++ has more documentation than the other languages — .NET borrows ASP.NET Core,
Node borrows NestJS, and Java borrows Spring Boot, but C++ has no host to borrow, so the
framework provides host, DI, configuration, logging, and HTTP directly.
Documentation For Separate Artifacts¶
| Artifact | Documentation |
|---|---|
HTTP client (zlink::http_client) |
Guide · Spec |
Stream connector (zlink::stream_connector) |
User guide |
Internals List¶
Common Internals · Backend Dependency Policy · Regression Test Matrix
The role, DTOs, and verification criteria of the 6 common samples are found in the common sample.
For the framework's top-level common documents, see the guide home.