Trait kwap::socket::Socket

pub trait Socket {
    type Error: Debug;
    fn connect<A: ToSocketAddrs>(&mut self, addr: A) -> Result<(), Self::Error>;
    fn send(&self, msg: &[u8]) -> Result<(), Self::Error>;
    fn recv(
        &self, 
        buffer: &mut [u8]
    ) -> Result<(usize, SocketAddr), Self::Error>;

    fn poll(
        &self
    ) -> Result<Option<(ArrayVec<[u8; 1152]>, SocketAddr)>, Self::Error> { ... }
}

A CoAP network socket

This mirrors the Udp socket traits in embedded-nal, but allows us to implement them for foreign types (like std::net::UdpSocket).

One notable difference is that connecting is expected to modify the internal state of a Socket, not yield a connected socket type (like std::net::UdpSocket::connect).

Associated Types

type Error: Debug

The error yielded by socket operations

Required methods

fn connect<A: ToSocketAddrs>(&mut self, addr: A) -> Result<(), Self::Error>

Connect as a client to some remote host

fn send(&self, msg: &[u8]) -> Result<(), Self::Error>

Send a message to the connected host

fn recv(&self, buffer: &mut [u8]) -> Result<(usize, SocketAddr), Self::Error>

Pull a buffered datagram from the socket, along with the address to the sender.

Provided methods

fn poll(
    &self
) -> Result<Option<(ArrayVec<[u8; 1152]>, SocketAddr)>, Self::Error>

Poll the socket for a datagram

Implementations on Foreign Types

impl Socket for UdpSocket

type Error = Error

fn connect<A: ToSocketAddrs>(&mut self, addr: A) -> Result<(), Self::Error>

fn send(&self, msg: &[u8]) -> Result<(), Self::Error>

fn recv(&self, buffer: &mut [u8]) -> Result<(usize, SocketAddr), Self::Error>

Implementors