Struct sopht::ipc::Connection

pub struct Connection { /* private fields */ }

structure containing the state of a connection to the sopht socket

Implementations

impl Connection

pub fn new(stream: UnixStream) -> Result<Self>

consumes a UnixStream and tries to create a Connection. this function calls try_clone on the stream and, if this fails, returns a SocketError. otherwise, the connection is successfully created

pub fn send(&mut self, cmd: &Message) -> Result<()>

sends a Message over the connection. this function can fail if

• the message fails to serialize (SerializeError)
• the connection is closed (ConnectionClosed)
• there is some other internal error on the UnixStream (SocketError)

pub fn recv(&mut self) -> Result<Message>

attempts to receieve a Message over the connection. this function can fail if

• the received message fails to deserialize (SerializeError)
• the connection is closed (ConnectionClosed)
• there is some other internal error on the UnixStream (SocketError)

pub fn recv_command(&mut self) -> Result<Command>

helper function that internally calls recv, then attempts to pull a Command out of the Message. if the message is not a command, this function returns WrongMessageKind

pub fn recv_response(&mut self) -> Result<Response>

helper function that internally calls recv, then attempts to pull a Response out of the Message. if the message is not a command, this function returns WrongMessageKind