Expand description
Client-facing subc channel-0 control wire shapes.
This crate is the client ↔ subc control-plane boundary. It depends only on
[subc-protocol] for shared primitives such as RouteTarget and
BindIdentity; clients can use it without depending on the
daemon implementation.
Modules§
- ops
- Reserved dotted operation prefixes for the v0.4 control vocabulary.
Structs§
- Activity
Actor - Verified identity stamped by the daemon, not supplied by a recording module.
- Activity
Cursor - A live-feed position. Query continuation positions are sequence numbers only.
- Activity
Entry - One durably appended event.
previs reserved for a future hash chain and is deliberately absent from this format. Identity is (daemon_incarnation, seq), and entries are ordered by seq rather than by their wall-clock timestamps. - Activity
Query Request - Filter a newest-first scan.
cursoris exclusive: only lower seqs follow it. - Activity
Query Response - A page plus the current incarnation’s head at scan capture, even on an empty page. Subscribe from head to move from the scan to live entries without a gap.
- Activity
Record Request - Report an event. Shape checking lives here; kind, size, ownership and rate validation remain the daemon’s responsibility. There is no actor field.
- Activity
Record Response - Sent only after the assigned sequence has been durably appended.
- Activity
Route - A route binding owned by the recording module, checked at this epoch.
- Activity
Scope - A live scope owned by the recording module, checked at this epoch.
- Activity
Subject - A short typed pointer, never a secret value.
- Activity
Subscribe Request - Replay after since and remain open for live entries. A refused or lagged feed ends with an Error frame carrying one of the activity refusal-code constants.
- Activity
Subscribe Response - One successful append delivered on the subscription’s correlation id. There is no separate acknowledgement; each response is one streamed entry.
- AppOpen
Reply - A successful
app.openreply. - AppOpen
Request - Ask the daemon to start the operator app named
app. - Busy
Gauge Reading - A declared busy gauge’s last reading from the daemon’s health cache.
- Capability
Requirement Status - Catalog
Entry - A registered module’s catalog projection.
- Child
Resource Reading - One reading of a module process’s memory and CPU time.
- Connection
Describe Reply - The daemon’s current view of the caller’s connection.
- Connection
Describe Request - Ask the daemon what it knows about this connection.
- Consumer
Identity - Daemon-spawned consumer identity presented on route.open.
- Daemon
Build Provenance - Build metadata embedded in the daemon binary.
- Daemon
Observed Process - Runtime process facts observed for the daemon itself.
- Live
Spawn - One process present in an atomic supervisor spawn snapshot.
- NotReady
Reason - Why a registered module is not accepting new route binds.
- Ordered
Json Object - Ordered JSON members retained for an unknown tagged value.
- Pending
Reload Verdict - Independent comparisons of configured path, launch spec and running image at list time. An absent verdict means the daemon predates this field, not agreement.
- Rescan
Expect - What must still match for the daemon to accept an apply of this preview, so the apply does what the preview described.
- Rescan
Module Action - One module’s entry in a candidate preview.
- Scope
Served ByReply - Volatile bind history in one daemon incarnation; unknown never means served.
- Scope
Served ByRequest - Ask about an epoch owned by the registered module sending the request.
- Spawn
Cursor - A daemon-incarnation-scoped position in the supervised spawn event stream.
- Spawn
Event - One retained or live spawn event.
- Spawn
Snapshot - Atomic live-process census and the cursor at which it was observed.
- Staged
Generation - Names one state of the daemon’s staged configuration. The counter alone is not enough: it starts again at zero when the daemon restarts, and a restarted daemon may hold different staged specs under the same number.
- Stderr
Tail - A module’s retained stderr, oldest entry first.
- Supervisor
Daemon Provenance - Daemon provenance paired with its runtime process observation.
- Supervisor
Entry - A supervised module’s current state and process observations.
- Supervisor
Health Entry - Supervisor
Module Provenance - Source-tagged provenance for one supervised module.
- Supervisor
Observed Process - Process facts observed by the daemon for a supervised module.
- Supervisor
Rescan Result - Supervisor
Route - One live consumer route in a
SupervisorRouteModule. - Supervisor
Route Module - Live routes served by one module.
- Terminal
Entry - One terminal child exit and the supervisor action it selected.
- Terminal
History - Bounded terminal history for one module, oldest retained record first.
Enums§
- Activity
On - Exactly one citation from which the daemon resolves the actor.
- AppOpen
Status - What an
app.opencall did. - Child
Memory Kind - What
ChildResourceReading::memory_bytesmeasures. - Child
Resource Unavailable Reason - Why a module process’s resources could not be read.
- Child
Resource Usage - A module process’s memory and CPU time as read at list time, or why none could be read.
- Client
Control Push - Daemon-originated channel-0 control push body.
- Client
Control Request - Client-originated channel-0 control RPC body.
- Client
Control Response - subc’s channel-0 response body for client control RPCs.
- Launch
Spec Agreement - Comparison of the configured launch inputs with the inputs recorded at spawn. No digest or configured env values are sent to clients.
- Launch
Spec Unavailable Reason - Module
Declared Provenance - A module’s declared build metadata, if its HELLO manifest carried it.
- Module
Protocol - Which wire protocol a supervised module speaks to subc, as DECLARED in daemon config. Never inferred from observed behaviour.
- Ordered
Json Value - JSON values whose object members retain wire order at every depth.
- Poll
Kind - Reload
Path Agreement - Whether the running process was spawned from the currently configured program.
- Reload
Path Unavailable Reason - Why configured and spawned paths cannot be compared.
- Rescan
Module Action Kind - What applying a candidate would do to one module.
- Route
Close Reason - Why subc is closing a module’s client routes.
- Running
Image Agreement - Whether the executable currently running agrees with the spawned image.
- Running
Image Evidence - Platform-specific evidence used to compare a running image with its spawn path.
- Running
Image Unavailable Reason - Reasons why an executable identity could not be observed.
- Scope
Served ByAnswer - Only
Servedestablishes that the target acknowledged a scoped bind. - Spawn
Event Kind - Fact observed by the supervisor when a child process starts or exits.
- Stderr
Capture State - Whether stderr is being captured for a module, and if not, why not.
- Stderr
Tail Entry - Supervisor
Health Status - Supervisor
Route Consumer - The identity tier the daemon can honestly report for a route consumer.
- Terminal
Disposition - The supervisor disposition selected after observing a terminal exit.
- Terminal
Exit Kind - Exit classification carried by supervisor history and census records.
Constants§
- ACTIVITY_
ACTOR_ UNKNOWN - ACTIVITY_
CURSOR_ INCARNATION_ MISMATCH - ACTIVITY_
CURSOR_ TOO_ OLD - ACTIVITY_
KIND_ FORBIDDEN - ACTIVITY_
LEDGER_ CAPABILITY - Advertised in HELLO_ACK and server.describe before activity operations are used.
- ACTIVITY_
MALFORMED - ACTIVITY_
RATE_ LIMITED - ACTIVITY_
READ_ FORBIDDEN - ACTIVITY_
SUBSCRIBER_ LAGGED - ACTIVITY_
TOO_ LARGE - ACTIVITY_
UNAVAILABLE - APP_
NOT_ INSTALLED - Refusal code for a known app that is not installed where the daemon looks.
- APP_
OPEN_ DISABLED - Refusal code when the platform supports
app.openbut this daemon build has it switched off. - APP_
OPEN_ ERROR_ CODES - Every
app.openrefusal code, in the order the daemon checks them. - APP_
OPEN_ NOT_ USED - Refusal code on a platform that never launches apps through the daemon.
- APP_
UNKNOWN - Refusal code for an app id the daemon does not know.
- APP_
VERIFICATION_ FAILED - Refusal code for an installed binary that failed the daemon’s checks. No process was started.
- CONFIG_
CHANGED_ SINCE_ PREVIEW - Refusal code for an apply whose
expectno longer matches the daemon: the file it reads hashes differently, or the staged generation has moved since the preview (another rescan with module changes ran, even one that failed partway, or the daemon restarted). Nothing was applied. - RESCAN_
CANDIDATE_ MAX_ BYTES - The largest candidate text, in bytes, a preview accepts. A daemon config file is a few kilobytes; the cap bounds what one request can make the daemon parse.
- RESCAN_
CANDIDATE_ PREVIEW_ CAPABILITY - Advertised in
server.describeby a daemon that servessupervisor.rescan_checked. A client sends that op only when this is listed: an older daemon refuses the unknown op, so a client that skipped the check would fail closed rather than preview the file on disk. - RESCAN_
CANDIDATE_ TOO_ LARGE - Refusal code for a preview whose candidate is longer than
RESCAN_CANDIDATE_MAX_BYTES. - SCOPE_
SERVED_ BY_ OP