Struct Socket

pub struct Socket<Tx, Rx> {
    pub send: Tx,
    pub recv: Rx,
    pub local_addr: SocketAddr,
    pub peer_addr: SocketAddr,
    pub capabilities: SocketCapabilities,
}

A connected datagram socket with separate send and recv halves.

Socket abstracts over both real UDP-based connections and in-process tunneled flows like (multi-hop) MASQUE flows. It uses the datagram_socket traits for this purpose.

Fields

send: Tx

The sending half of the connection. This generally supports concurrent senders.

recv: Rx

The receiving half of the connection. This is generally owned by a single caller.

local_addr: SocketAddr

The address of the local endpoint.

peer_addr: SocketAddr

The address of the remote endpoint.

capabilities: SocketCapabilities

The SocketCapabilities to use for this socket.

By default, Sockets are constructed with all capabilities disabled. On Linux, you can use apply_max_capabilities() to (try to) enable all supported capabilities.

Implementations

impl<Tx, Rx> Socket<Tx, Rx>

pub fn from_udp( socket: UdpSocket, ) -> Result<Socket<Arc<UdpSocket>, Arc<UdpSocket>>>

Creates a Socket from a [UdpSocket] by wrapping the file descriptor in an Arc.

impl<Tx, Rx> Socket<Tx, Rx>

where Tx: DatagramSocketSend, Rx: DatagramSocketRecv,

pub fn as_udp_socket(&self) -> Option<&UdpSocket>

Checks whether both send and recv refer to the same underlying UDP socket FD and returns a reference to that socket.

Note

The file descriptor numbers have to be identical. A pair of FDs created by dup(2) will return None.

pub fn apply_max_capabilities(&mut self, max_send_udp_payload_size: usize)

Tries to enable all sockopts supported by the crate for this socket.

This does nothing unless send and recv refer to the same UDP socket FD. See SocketCapabilities::apply_all_and_get_compatibility for details.

Trait Implementations

impl<Tx: Debug, Rx: Debug> Debug for Socket<Tx, Rx>

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

Formats the value using the given formatter.

impl TryFrom<UdpSocket> for Socket<Arc<UdpSocket>, Arc<UdpSocket>>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(socket: UdpSocket) -> Result<Self, Self::Error>

Performs the conversion.