Struct oni_simulator::Socket

pub struct Socket<MTU: ArrayLength<u8> = DefaultMTU> { /* fields omitted */ }

Simulated unreliable unordered connectionless UDP-like socket.

Methods

impl<MTU: ArrayLength<u8>> Socket<MTU>

pub fn take_send_bytes(&self) -> usize

Takes the value of the counter sent bytes and clear counter.

pub fn take_recv_bytes(&self) -> usize

Takes the value of the counter received bytes and clear counter.

pub fn local_addr(&self) -> SocketAddr

Returns the socket address that this socket was created from.

pub fn send_to(&self, buf: &[u8], addr: SocketAddr) -> Result<usize>

Sends data on the socket to the given address. On success, returns the number of bytes written.

This will return an error when the length of buf is greater than MTU.

pub fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>

Receives a single datagram message on the socket. On success, returns the number of bytes read and the origin.

The function must be called with valid byte array buf of sufficient size to hold the message bytes. If a message is too long to fit in the supplied buffer, excess bytes may be discarded.

Trait Implementations

impl<MTU: ArrayLength<u8>> Drop for Socket<MTU>

fn drop(&mut self)

Executes the destructor for this type.