Expand description
v1 broker module — schemas are FROZEN FOREVER once v1.0 ships.
Phase 0 of #228: this module exposes the prost-generated wire types (envelope, manifest, service definition) for every later phase to depend on. No consumers ship yet — Phases 1+ wire them in.
See proto/broker_v1_*.proto and the parent issue for the rationale
behind every field number and reserved range.
Modules§
- adopt
- One-call broker adoption: negotiate → dial → ready-to-talk client (#433 R1).
- backend_
handle - Public handle for a verified backend daemon.
- backend_
lib - Backend-facing helpers for v1 broker consumers.
- backend_
lifecycle - Shared backend lifecycle primitives used by broker and direct clients.
- backend_
sdk - Backend integration SDK (#412).
- broker_
http_ port - v2 broker HTTP port mode resolution (slice 9 of #488).
- broker_
http_ server - Broker HTTP server scaffold (slice 7 of #488).
- brokered_
backend - Structurally-enforced fast-bind contract for v2 brokered daemons (#497).
- builders
- Ergonomic builders for the two registration messages a consumer must
produce to join the broker:
ServiceDefinitionandCacheManifest(#433 R2). - capabilities
- Shared capability bitmap constants for the v1 Hello/Negotiated exchange.
- client
- Client-side helpers for the v1 broker Hello path.
- client_
v2 - v2 broker client (slice 4 of #488).
- doctor
- Read-only
broker doctorenvironment diagnostics (#354, v1.x-5 from #228). - fs_
health - Filesystem-health probes for status/doctor visibility (#390).
- get_
http_ endpoint_ dispatch GetBrokerHttpEndpointRPC dispatch (slice 6 of #488).- host_
identity - Host identity values stored in v1 CacheManifest files.
- http_
endpoint_ registry - Per-backend HTTP endpoint registry for the v2 broker (slice 5 of #488).
- lifecycle
- Per-user, per-machine derivations for broker pipe naming and SID hashing.
- manifest
- CacheManifest persistence and central-registry helpers.
- protocol
- v1 broker protocol module.
- protocol_
v2 - v2 broker protocol module.
- server
- Broker server foundation for
running-process-broker-v1.
Constants§
- FRAMING_
VERSION_ V1 - Framing byte for every v1 broker connection. Wire layout:
[u8 framing_version=1][u32 LE body_length][prost body]. - LIFECYCLE_
EVENT_ PIPE_ BUF_ FLOOR - Upper bound on a LifecycleEvent’s prost-encoded size, set to the
minimum POSIX
PIPE_BUFso atomic-append into the event log is guaranteed on every platform. Linux raises this to 4096 in practice, but the cross-platform floor is 512. - MAX_
FRAME_ SIZE_ BYTES - Hard ceiling on any single broker frame. Broker disconnects on overflow. See #228 “Wire-level commitments”.
- MAX_
HELLO_ SIZE_ BYTES - Hard ceiling on the Hello envelope specifically. Broker returns
Refusedon overflow. See #228 “Wire-level commitments”.