Struct smoltcp::socket::RawSocket

pub struct RawSocket<'a, 'b: 'a> { /* fields omitted */ }

A raw IP socket.

A raw socket is bound to a specific IP protocol, and owns transmit and receive packet buffers.

Methods

impl<'a, 'b> RawSocket<'a, 'b>

pub fn new(
    ip_version: IpVersion,
    ip_protocol: IpProtocol,
    rx_buffer: RawSocketBuffer<'a, 'b>,
    tx_buffer: RawSocketBuffer<'a, 'b>
) -> RawSocket<'a, 'b>

Create a raw IP socket bound to the given IP version and datagram protocol, with the given buffers.

pub fn handle(&self) -> SocketHandle

Return the socket handle.

pub fn ip_version(&self) -> IpVersion

Return the IP version the socket is bound to.

pub fn ip_protocol(&self) -> IpProtocol

Return the IP protocol the socket is bound to.

pub fn can_send(&self) -> bool

Check whether the transmit buffer is full.

pub fn can_recv(&self) -> bool

Check whether the receive buffer is not empty.

pub fn packet_recv_capacity(&self) -> usize

Return the maximum number packets the socket can receive.

pub fn packet_send_capacity(&self) -> usize

Return the maximum number packets the socket can transmit.

pub fn payload_recv_capacity(&self) -> usize

Return the maximum number of bytes inside the recv buffer.

pub fn payload_send_capacity(&self) -> usize

Return the maximum number of bytes inside the transmit buffer.

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

Enqueue a packet to send, and return a pointer to its payload.

This function returns Err(Error::Exhausted) if the transmit buffer is full, and Err(Error::Truncated) if there is not enough transmit buffer capacity to ever send this packet.

If the buffer is filled in a way that does not match the socket's IP version or protocol, the packet will be silently dropped.

Note: The IP header is parsed and reserialized, and may not match the header actually transmitted bit for bit.

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

Enqueue a packet to send, and fill it from a slice.

See also send.

pub fn recv(&mut self) -> Result<&[u8]>

Dequeue a packet, and return a pointer to the payload.

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

Note: The IP header is parsed and reserialized, and may not match the header actually received bit for bit.

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

Dequeue a packet, and copy the payload into the given slice.

See also recv.

Trait Implementations

impl<'a, 'b> AnySocket<'a, 'b> for RawSocket<'a, 'b>

fn downcast<'c>(
    ref_: SocketRef<'c, Socket<'a, 'b>>
) -> Option<SocketRef<'c, Self>>

impl<'a, 'b: 'a> Debug for RawSocket<'a, 'b>

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

Formats the value using the given formatter.

impl<'a, 'b> Into<Socket<'a, 'b>> for RawSocket<'a, 'b>

fn into(self) -> Socket<'a, 'b>

Performs the conversion.