Skip to main content

Crate keepty_protocol

Crate keepty_protocol 

Source
Expand description

keepty wire protocol

Length-prefixed binary frames over Unix sockets. Frame: [u32 len (BE)][u8 version][u8 kind][payload…]

Zero external dependencies — implement a client in any language by following this specification.

Structs§

Frame
A parsed keepty protocol frame.

Enums§

MsgKind
Message types in the keepty protocol.
Role
Client role when connecting to a keepty broker.

Constants§

MAX_FRAME_BODY_SIZE
Maximum frame body size (payload + version byte + kind byte).
MAX_PAYLOAD_SIZE
Maximum payload size (1MB, matches ring buffer capacity).
PROTOCOL_VERSION
SOCKET_DIR
Deprecated: use socket_dir() for the runtime-resolved directory. Kept for backward compatibility with code that imports this constant.

Functions§

decode_exit
decode_hello
decode_hello_ack
decode_resize
decode_resize_ack
encode_exit
encode_hello
encode_hello_ack
encode_resize
encode_resize_ack
socket_dir
Resolve the runtime socket directory. Priority: $XDG_RUNTIME_DIR/keepty → $TMPDIR/keepty (via std::env::temp_dir)
socket_path
Construct the broker socket path for a session.