Skip to main content

Crate podbox_protocol

Crate podbox_protocol 

Source

Modules§

sysutil
Unix-only helpers shared by the host CLI and the guest daemon. Unix-only process helpers both the host CLI and the guest daemon need.

Structs§

FrameReader
Incremental frame reader that survives read timeouts.
NotifyAction

Enums§

ExecStream
Which pipe of a streaming host-exec child a chunk came from.
FrameRead
What a FrameReader::read call produced.
GuestMessage
Messages sent from guest to host.
HostMessage
Messages sent from host to guest.

Constants§

ALL_CAPABILITIES
All known capabilities in negotiation order.
CAP_CLIPBOARD
CAP_HOST_EXEC
CAP_HOST_EXEC_FDS
Host-exec with the child’s stdio supplied by the guest: a HostExecV2 frame with three descriptors attached via SCM_RIGHTS, plus HostExecSignal relay while the child runs. Old hosts leave it in the rejected list and the guest falls back to plain HostExec.
CAP_HOST_EXEC_STREAM
Streaming host-exec output (HostExecOutput byte chunks instead of one buffered HostExecStdout/HostExecStderr frame). Requested alongside host_exec; old hosts leave it in the rejected list and the guest falls back to buffered frames.
CAP_NOTIFY
Guest protocol capability identifiers.
CAP_XDG_OPEN
INTERCEPTORS
Interceptor binaries and the capability each needs: (binary, capability).
MAX_CLIPBOARD_BYTES
Largest clipboard payload either side will send or accept (8 MiB). Beyond this the host answers with an Error frame and the guest refuses locally with a clear message, instead of failing the frame. A fixed constant (not a config key): raising it needs the matching host/guest rollout, and the frame cap bounds it anyway.
PROTOCOL_VERSION
Increment on breaking wire-format changes. Backwards-compatible additions (new optional message types) do NOT increment this.

Functions§

read_frame
Read a length-prefixed JSON frame.
write_frame
Write a length-prefixed JSON frame.