Enum socket_collection::Socket

pub enum Socket {
    Udp(UdpSock),
    Tcp(TcpSock),
}

Protocol agnostic socket that wraps UdpSock and TcpSock.

Variants

Udp(UdpSock)Tcp(TcpSock)

Methods

impl Socket

pub fn set_encrypt_ctx(&mut self, enc_ctx: EncryptContext) -> Res<()>

Specify data encryption context which will determine how outgoing data is encrypted.

pub fn set_decrypt_ctx(&mut self, dec_ctx: DecryptContext) -> Res<()>

Specify data decryption context which will determine how incoming data is decrypted.

pub fn local_addr(&self) -> Res<SocketAddr>

Get the local address socket is bound to.

pub fn peer_addr(&self) -> Res<SocketAddr>

Get the address socket was connected to.

pub fn set_ttl(&self, ttl: u32) -> Res<()>

Set Time To Live value for the underlying socket.

pub fn ttl(&self) -> Res<u32>

Retrieve Time To Live value.

pub fn take_error(&self) -> Res<Option<Error>>

Retrieve last socket error, if one exists.

pub fn read<T: DeserializeOwned + Serialize>(&mut self) -> Res<Option<T>>

Read message from the connected socket. Call this method once socket becomes readable.

Returns:

• Ok(Some(data)): data has been successfully read from the socket
• Ok(None): there is not enough data in the socket. Call read() again in the next invocation of the ready handler.
• Err(error): there was an error reading from the socket.

pub fn write<T: Serialize>(&mut self, msg: Option<(T, Priority)>) -> Res<bool>

Write a message to the connected socket.

Returns:

• Ok(true): the message has been successfully written.
• Ok(false): the message has been queued, but not yet fully written. will be attempted in the next write schedule.
• Err(error): there was an error while writing to the socket.

pub fn set_linger(&self, dur: Option<Duration>) -> Res<()>

Sets linger time for connection based protocols.

Trait Implementations

impl From<UdpSock> for Socket

fn from(sock: UdpSock) -> Socket

Performs the conversion.

impl From<TcpSock> for Socket

fn from(sock: TcpSock) -> Socket

Performs the conversion.