Struct socket_collection::UdpSock

pub struct UdpSock { /* fields omitted */ }

Asynchronous UDP socket wrapper with some specific behavior to our use cases:

• The maximum message length is as long as max UDP payload size.
• Incoming/outgoing messages are buffered.
• All messages are encrypted with EncryptContext and decrypted with DecryptContext that can be changed at any time.

Methods

impl UdpSock

pub fn wrap(sock: UdpSocket) -> Self

Wrap UdpSocket and use the default socket configuration.

pub fn wrap_with_conf(sock: UdpSocket, conf: SocketConfig) -> Self

Wrap UdpSocket and use given socket configuration.

pub fn bind(addr: &SocketAddr) -> Res<Self>

Create new UdpSock bound to the given address with default configuration.

pub fn bind_with_conf(addr: &SocketAddr, conf: SocketConfig) -> Res<Self>

Create new UdpSock bound to the given address with given configuration.

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 connect(&mut self, addr: &SocketAddr) -> Res<()>

Set default destination address for UDP socket.

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

Get the local address UDP socket is bound to.

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

Get the address UdpSock was connected to.

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

Set Time To Live value for the underlying UDP 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 from inside the ready handler.

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 read_frm<T: DeserializeOwned + Serialize>(     &mut self ) -> Res<Option<(T, SocketAddr)>>

Read message from the socket. Call this from inside the ready handler.

Returns:

• Ok(Some((data, peer_address))): 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 write_to<T: Serialize>(     &mut self,     msg: Option<(T, SocketAddr, Priority)> ) -> Res<bool>

Write a message to the socket to the given address.

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 into_underlying_sock(self) -> Res<UdpSocket>

Retrieve the underlying mio UdpSocket.

Trait Implementations

impl From<UdpSock> for Socket

fn from(sock: UdpSock) -> Socket

Performs the conversion.

impl Default for UdpSock

fn default() -> Self

Returns the "default value" for a type.

impl Debug for UdpSock

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Evented for UdpSock

fn register(     &self,     poll: &Poll,     token: Token,     interest: Ready,     opts: PollOpt ) -> Result<()>

Register self with the given Poll instance.

fn reregister(     &self,     poll: &Poll,     token: Token,     interest: Ready,     opts: PollOpt ) -> Result<()>

Re-register self with the given Poll instance.

fn deregister(&self, poll: &Poll) -> Result<()>

Deregister self from the given Poll instance