Skip to main content

Module control

Module control 

Source
Expand description

Host-only control protocol, independent of the guest agent’s generation.

Structs§

BranchCreate
Capture directly into a reserved child-owned local handoff directory.
BranchResult
Completed direct local branch handoff.
Capabilities
Facilities available for this runtime and VM configuration.
CheckpointCreate
Create one same-epoch full checkpoint.
CheckpointResult
Full-checkpoint completion, including a published result whose source recovery failed.
CheckpointState
Published full-checkpoint state.
ControlError
A recoverable peer error. Codes stay strings for future interoperability.
ControlHello
Opening framed-control offer. The envelope generation is always one.
ControlMessageTypeIter
An iterator over the variants of ControlMessageType
ControlWelcome
Selected generation and limits. The welcome envelope is always generation one.
CpuState
CPU capacity, accepted target, observation, and enforcement.
CpuTarget
Native CPU-target payload.
DiskCheckpointCreate
Seal the owned root disk without capturing RAM or execution state.
DiskCheckpointState
Complete disk-only capture result.
DiskCompact
Compact selected sandbox-owned disk chains.
Empty
Empty map payload for state and capability queries.
JsonControlResponse
Existing JSON response with an additive discovery advertisement.
MemoryState
Accepted and observed memory quantities, all in MiB.
MemoryTarget
Native memory-target payload, without SDK convergence policy.
Pause
Pause the runtime, optionally requiring guest writeback first.
PauseState
Host-confirmed resident suspension state.
RootDiskGrow
Grow the owned root disk and its mounted filesystem.
RootDiskState
Verified root-disk growth and measured phases.
RuntimeCapabilities
Complete generation-two runtime facility inventory.
SecretValue
Secret material that is redacted in diagnostics and cleared on drop.
SecretsUpdate
Sequential, non-transactional secret modifications.

Enums§

CheckpointCaptureIntent
Purpose of a full checkpoint capture.
ControlMessageType
Known control wire names. The strum spelling is the authoritative mapping.
ControlOperation
One decoded application operation across all negotiated control generations.
ControlRequest
Legacy JSON request, also used as a checked dispatch representation.
ErrorEffect
State mutation certainty reported by an operation error.
SecretChange
One ordered host secret modification, preserving the JSON operation tags.
SecretsResult
Completion of a sequential secret batch.

Constants§

CONTROL_GENERATION
Current framed host-control generation.
CONTROL_GENERATION_TWO_MESSAGES
Application messages introduced by framed control generation two.
CONTROL_HANDSHAKE_GENERATION
Stable generation of hello, welcome, and setup errors.
CONTROL_PROTOCOL
Stable protocol discriminator; it does not authenticate a peer.
DEFAULT_MAX_IN_FLIGHT
Maximum outstanding control IDs on a default connection.
DEFAULT_REQUEST_TIMEOUT
Default local request wait, which never cancels or retries a mutation.
DEFAULT_SETUP_TIMEOUT
Default deadline for the complete automatic connection setup.
MAX_DISCOVERY_RESPONSE_SIZE
Bound for JSON capability responses consumed during discovery.
MAX_HANDSHAKE_FRAME_SIZE
The opening frame stays small and zero-prefixed across future generations.
MIN_CONTROL_GENERATION
Oldest framed host-control generation retained for released 0.7.x peers.

Functions§

control_message_min_generation
Generation in which a known application message first became available.

Type Aliases§

DiskCompactionResult
Aggregate disk-compaction result shared with SDK-facing types.