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§
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.