Struct ublox_cellular::sockets::UdpSocket

pub struct UdpSocket<L: ArrayLength<u8>> { /* fields omitted */ }

A User Datagram Protocol socket.

A UDP socket is bound to a specific endpoint, and owns transmit and receive packet buffers.

Implementations

impl<L: ArrayLength<u8>> UdpSocket<L>

pub fn new(socket_id: u8) -> UdpSocket<L>

Create an UDP socket with the given buffers.

pub fn handle(&self) -> SocketHandle

Return the socket handle.

pub fn endpoint(&self) -> SocketAddr

Return the bound endpoint.

pub fn set_available_data(&mut self, available_data: usize)

Set available data.

pub fn get_available_data(&self) -> usize

Get the number of bytes available to ingress.

pub fn rx_window(&self) -> usize

pub fn bind<T: Into<SocketAddr>>(&mut self, endpoint: T) -> Result<(), Error>

Bind the socket to the given endpoint.

This function returns Err(Error::Illegal) if the socket was open (see is_open), and Err(Error::Unaddressable) if the port in the given endpoint is zero.

pub fn is_open(&self) -> bool

Check whether the socket is open.

pub fn can_recv(&self) -> bool

Check whether the receive buffer is full.

pub fn recv<'b, F, R>(&'b mut self, f: F) -> Result<R, Error> where
    F: FnOnce(&'b mut [u8]) -> (usize, R), 

Dequeue a packet received from a remote endpoint, and return the endpoint as well as a pointer to the payload.

This function returns Err(Error::Exhausted) if the receive buffer is empty.

pub fn recv_slice(&mut self, data: &mut [u8]) -> Result<usize, Error>

Dequeue a packet received from a remote endpoint, copy the payload into the given slice, and return the amount of octets copied as well as the endpoint.

See also recv.

pub fn rx_enqueue_slice(&mut self, data: &[u8]) -> usize

pub fn peek(&mut self, size: usize) -> Result<&[u8], Error>

Peek at a packet received from a remote endpoint, and return the endpoint as well as a pointer to the payload without removing the packet from the receive buffer. This function otherwise behaves identically to recv.

It returns Err(Error::Exhausted) if the receive buffer is empty.

pub fn peek_slice(&mut self, data: &mut [u8]) -> Result<usize, Error>

Peek at a packet received from a remote endpoint, copy the payload into the given slice, and return the amount of octets copied as well as the endpoint without removing the packet from the receive buffer. This function otherwise behaves identically to recv_slice.

See also peek.

pub fn close(&mut self)

Trait Implementations

impl<L: ArrayLength<u8>> AnySocket<L> for UdpSocket<L>

pub fn downcast(
    ref_: SocketRef<'_, Socket<L>>
) -> Result<SocketRef<'_, Self>, Error>

impl<L: ArrayLength<u8>> Into<Socket<L>> for UdpSocket<L>

pub fn into(self) -> Socket<L>

Performs the conversion.