Struct smoltcp::socket::RawSocket [−][src]
pub struct RawSocket<'a> { /* fields omitted */ }
Expand description
A raw IP socket.
A raw socket is bound to a specific IP protocol, and owns transmit and receive packet buffers.
Implementations
pub fn new(
ip_version: IpVersion,
ip_protocol: IpProtocol,
rx_buffer: RawSocketBuffer<'a>,
tx_buffer: RawSocketBuffer<'a>
) -> RawSocket<'a>
pub fn new(
ip_version: IpVersion,
ip_protocol: IpProtocol,
rx_buffer: RawSocketBuffer<'a>,
tx_buffer: RawSocketBuffer<'a>
) -> RawSocket<'a>
Create a raw IP socket bound to the given IP version and datagram protocol, with the given buffers.
Register a waker for receive operations.
The waker is woken on state changes that might affect the return value
of recv
method calls, such as receiving data, or the socket closing.
Notes:
- Only one waker can be registered at a time. If another waker was previously registered, it is overwritten and will no longer be woken.
- The Waker is woken only once. Once woken, you must register it again to receive more wakes.
- “Spurious wakes” are allowed: a wake doesn’t guarantee the result of
recv
has necessarily changed.
Register a waker for send operations.
The waker is woken on state changes that might affect the return value
of send
method calls, such as space becoming available in the transmit
buffer, or the socket closing.
Notes:
- Only one waker can be registered at a time. If another waker was previously registered, it is overwritten and will no longer be woken.
- The Waker is woken only once. Once woken, you must register it again to receive more wakes.
- “Spurious wakes” are allowed: a wake doesn’t guarantee the result of
send
has necessarily changed.
Return the socket handle.
Return the IP version the socket is bound to.
Return the IP protocol the socket is bound to.
Return the maximum number packets the socket can receive.
Return the maximum number packets the socket can transmit.
Return the maximum number of bytes inside the recv buffer.
Return the maximum number of bytes inside the transmit buffer.
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.
Enqueue a packet to send, and fill it from a slice.
See also send.
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.
Trait Implementations
Auto Trait Implementations
impl<'a> RefUnwindSafe for RawSocket<'a>
impl<'a> !UnwindSafe for RawSocket<'a>