Struct socks5_server::connection::associate::AssociateUdpSocket

pub struct AssociateUdpSocket { /* private fields */ }

This is a helper for managing the associated UDP socket.

It will add the socks5 UDP header to every UDP packet it sends, also try to parse the socks5 UDP header from any UDP packet received.

The receiving buffer size for each UDP packet can be set with set_recv_buffer_size(), and be read with get_max_packet_size().

You can create this struct by using AssociateUdpSocket::from::<(UdpSocket, usize)>(), the first element of the tuple is the UDP socket, the second element is the receiving buffer size.

This struct can also be revert into a raw tokio UDP socket with UdpSocket::from::<AssociateUdpSocket>().

Implementations

impl AssociateUdpSocket

pub async fn connect<A: ToSocketAddrs>(&self, addr: A) -> Result<()>

Connects the UDP socket setting the default destination for send() and limiting packets that are read via recv from the address specified in addr.

pub fn local_addr(&self) -> Result<SocketAddr>

Returns the local address that this socket is bound to.

pub fn peer_addr(&self) -> Result<SocketAddr>

Returns the socket address of the remote peer this socket was connected to.

pub fn get_max_packet_size(&self) -> usize

Get the maximum UDP packet size, with socks5 UDP header included.

pub fn set_max_packet_size(&self, size: usize)

Set the maximum UDP packet size, with socks5 UDP header included, for adjusting the receiving buffer size.

pub async fn recv(&self) -> Result<(Bytes, u8, Address)>

Receives a socks5 UDP relay packet on the socket from the remote address to which it is connected. On success, returns the packet itself, the fragment number and the remote target address.

The connect method will connect this socket to a remote address. This method will fail if the socket is not connected.

pub async fn recv_from(&self) -> Result<(Bytes, u8, Address, SocketAddr)>

Receives a socks5 UDP relay packet on the socket from the any remote address. On success, returns the packet itself, the fragment number, the remote target address and the source address.

pub async fn send<P: AsRef<[u8]>>(
    &self,
    pkt: P,
    frag: u8,
    from_addr: Address
) -> Result<usize>

Sends a UDP relay packet to the remote address to which it is connected. The socks5 UDP header will be added to the packet.

pub async fn send_to<P: AsRef<[u8]>>(
    &self,
    pkt: P,
    frag: u8,
    from_addr: Address,
    to_addr: SocketAddr
) -> Result<usize>

Sends a UDP relay packet to a specified remote address to which it is connected. The socks5 UDP header will be added to the packet.

Trait Implementations

impl Debug for AssociateUdpSocket

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

Formats the value using the given formatter.

impl From<(UdpSocket, usize)> for AssociateUdpSocket

fn from(from: (UdpSocket, usize)) -> Self

Converts to this type from the input type.

impl From<AssociateUdpSocket> for UdpSocket

fn from(from: AssociateUdpSocket) -> Self

Converts to this type from the input type.