Crate shpool_protocol

Structs

• AttachHeader
  AttachHeader is the blob of metadata that a client transmits when it first dials into the shpool daemon indicating which shell it wants to attach to.
• AttachReplyHeader
  AttachReplyHeader is the blob of metadata that the shpool service prefixes the data stream with after an attach. In can be used to indicate a connection error.
• Chunk
  Chunk represents of a chunk of data in the output stream
• DetachReply
• DetachRequest
  DetachRequest represents a request to detach from the given named sessions.
• KillReply
• KillRequest
  KillRequest represents a request to kill the given named sessions.
• ListReply
  ListReply is contains a list of active sessions to be displayed to the user.
• ResizeRequest
  ResizeRequest resizes the pty for a given named session. We use an out-of-band request rather than doing this in the input stream because we don’t want to have to introduce a framing protocol for the input stream.
• Session
  Session describes an active session.
• SessionMessageRequest
  SessionMessageRequest represents a request that ought to be routed to the session indicated by session_name.
• TtySize

Enums

• AttachStatus
  AttachStatus indicates what happened during an attach attempt.
• ChunkKind
  ChunkKind is a tag that indicates what type of frame is being transmitted through the socket.
• ConnectHeader
  ConnectHeader is the blob of metadata that a client transmits when it first connections. It uses an enum to allow different connection types to be initiated on the same socket. The ConnectHeader is always prefixed with a 4 byte little endian unsigned word to indicate length.
• ResizeReply
  A reply to a resize message
• SessionMessageDetachReply
  A reply to a detach message
• SessionMessageReply
• SessionMessageRequestPayload
  SessionMessageRequestPayload contains a request for a running session.
• SessionStatus
  Indicates if a shpool session currently has a client attached.

Constants

• VERSION