C++ client guide#
This page is not written yet
This page is a stub. It lists the planned contents and the source material.
Content is written after the v1.0 tag, when the normative section describes the shipped protocol.
Planned contents#
The embedded and native client: the header-only library, the injected clock and randomness, and the transport interface a caller implements.
Source material: lib/valence/README.md (how to vendor the library), lib/valence/include/valence/client.hpp, and examples/valence_demo/demo.cpp.
DEMO-CANDIDATE:
examples/valence_demo/demo.cppwalked step by step as a live connect-and-print session.
Common outline#
Every client guide covers these seven steps in this order.
- Open the transport and complete the handshake.
- Handle the catalog: fetch, cache by etag, or pin it.
- Pass the ready gate.
- Adopt retained STATE before rendering anything.
- Send an intent and render the echo, never the request.
- Keep the session alive, and honor the deadman if you own a source.
- Handle NACKs, including the range fallback for a code you do not know.
Where to go next#
- Quickstart: a worked example, end to end.
- Hub implementer guide: using the same library to build a hub, making firmware a conforming hub instead of a client.
- CLI guide: graph the motion your client produced.