Expand description
The management-plane contract of zenoh-modem (#119): the registry, its
payload types, and the schemas describe serves — compiled once, for
every driver that serves it.
No Zenoh runtime. zenkey is linked without its zenoh feature, so what
is here is the key grammar, the registry slice type and the RFC 08 §7
schema envelope: pure data. A driver that links this crate — this
repository’s, or one for a device the kernel drives — gets the contract
and nothing that could open a session; modem-mgmt is where the session
is.
Nothing here knows how a value is produced. LinkState::of and its
siblings take the facts, not the driver, which is what lets a second
driver serve the same documents from a different plane.
Modules§
- config
- The configuration plane’s documents (#125): a device’s schema and read-back, in the convention’s own types (zenkey RFC 05 §5.1).
- documents
- The management plane’s payloads, as types.
- registry
- Typed key builders generated from
registry/byzenkey-build. - schema
- What every payload on this producer’s keyspace looks like (RFC 08 §7).
Macros§
- zenkey_
for_ each_ payload_ type - Invoke
$cb!("TypeName")once per distinct payload type name across every registry in this build (RFC 08 §5’s type table, mechanically).
Constants§
- PRODUCER
- The producer name every driver of this contract publishes under.
- ZENKEY_
VERSION - The zenkey this contract was compiled against, as
Cargo.lockpins it — read bybuild.rs, published instate/modem/sensor(#122).
Statics§
- PROFILE
- The application identity every key is minted under.