[][src]Crate stund_protocol

The stund client-server communication protocol.

Stund is a simple daemon for maintaining SSH tunnels. This crate defines the communication protocol used between the CLI client and the daemon that acts as the parent to SSH processes.

The protocol only has a handful of commands at the moment. These are defined in this main module. The client submodule implements the client protocol.

Modules

client

Communication with the daemon.

codecs

Codec helpers for the communication protocol.

Structs

CloseParameters

Parameters to the "Close" command.

OpenParameters

Parameters to the "Open" command.

StatusInformation

Information about the current status of the server.

TunnelInformation

Information about a single tunnel opened by the server.

Enums

ClientMessage

A message that the client may send to the server.

CloseResult

Possible outcomes of the "Close" command.

OpenResult

Possible outcomes of the "Open" command.

ServerMessage

A message that the server may send to the client.

TunnelState

The state of a single tunnel opened by the server.

Functions

get_socket_path

Get the path to the Unix domain socket used for client/server communication.