Skip to main content

Module agent

Module agent 

Source
Expand description

The guest-agent port: how the runtime reaches the agent inside a Computer.

Everything above this seam — the boot readiness gate, exec, files, clock sync, the post-restore network reconfiguration — speaks GuestAgent and GuestFiles. Nothing above it knows that today’s only implementation, vm_proto, reaches the guest over a vsock connection the driver port hands out. A Computer that is not reachable that way — no vsock device at all, or an agent that answers on its own network address — supplies another factory through NodeEnvironment::agent.

Readiness is the part that differs most between transports, so it has a vocabulary of its own: Readiness says how a guest announces that it is serving, GuestAgentFactory::arm_readiness arms the observer before the guest starts, and ReadyGate::wait is what the boot flow waits on afterwards under its own deadline.

Re-exports§

pub use vm_proto::VmProtoAgent;
pub use vm_proto::VmProtoAgentFactory;

Modules§

vm_proto
Host-side vsock client for communicating with the in-VM guest agent.

Structs§

DirWatch
A live directory watch inside one Computer.
ProbeGate
Readiness::Probe: one agent round trip, which is the whole of what this shape can observe.
StartCommand
The command vocabulary the guest agent starts processes from, shared with vm-agent through arcbox-vm-proto. Parameters forwarded to the guest agent as the session-start frame.

Enums§

ClockSync
Outcome of a completed clock-sync round trip.
ExecInputMsg
A message the host sends to the guest during an exec/run session.
ExitStatus
How a guest workload terminated.
OutputChunk
A chunk of output emitted by a guest process.
PortWait
Outcome of a guest listen-table wait.
Readiness
How a guest announces that its agent is serving.

Traits§

FsEvents
One implementation’s directory-watch event stream.
GuestAgent
The agent inside one running Computer.
GuestAgentFactory
Builds the agent client for one Computer, and knows how that Computer’s guest announces it is serving.
GuestFiles
File operations inside one running Computer.
ReadyGate
An armed readiness observer, awaited once.

Type Aliases§

ExecInput
The write half of an interactive session: stdin bytes, TTY resizes, signals, and the EOF that closes the process’s stdin.