Struct socks5_server::connection::associate::AssociatedUdpSocket

pub struct AssociatedUdpSocket { /* private fields */ }

A wrapper of a tokio UDP socket dealing with SOCKS5 UDP header.

(UdpSocket, usize) and AssociatedUdpSocket can be converted to each other with From trait, in which usize is the maximum receiving UDP packet size, with SOCKS5 UDP header included.

It only provides handful of methods to send / receive UDP packets with SOCKS5 UDP header. However, the underlying UdpSocket can be accessed with AsRef and AsMut trait, so you can use all methods provided by UdpSocket.

Implementations

impl AssociatedUdpSocket

pub fn get_max_pkt_size(&self) -> usize

Get the maximum receiving UDP packet size, with SOCKS5 UDP header included.

pub fn set_max_pkt_size(&self, size: usize)

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

pub async fn recv( &self ) -> Result<(Bytes, UdpHeader), (Socks5Error, Option<Vec<u8>>)>

Receives a SOCKS5 UDP packet on the socket from the remote address which it is connected.

On success, it returns the packet payload and the SOCKS5 UDP header. On error, it returns the error alongside an Option<Vec<u8>>. If the error occurs before / when receiving the raw UDP packet, the Option<Vec<u8>> will be None. Otherwise, it will be Some(Vec<u8>) containing the received raw UDP packet.

pub async fn recv_from( &self ) -> Result<(Bytes, UdpHeader, SocketAddr), (Socks5Error, Option<Vec<u8>>)>

Receives a SOCKS5 UDP packet on the socket from a remote address.

On success, it returns the packet payload, the SOCKS5 UDP header and the source address. On error, it returns the error alongside an Option<Vec<u8>>. If the error occurs before / when receiving the raw UDP packet, the Option<Vec<u8>> will be None. Otherwise, it will be Some(Vec<u8>) containing the received raw UDP packet.

pub async fn send<P: AsRef<[u8]>>( &self, pkt: P, header: &UdpHeader ) -> Result<usize, Error>

Sends a UDP packet to the remote address 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, header: &UdpHeader, addr: SocketAddr ) -> Result<usize, Error>

Sends a UDP packet to a specified remote address. The SOCKS5 UDP header will be added to the packet.

Trait Implementations

impl AsMut<UdpSocket> for AssociatedUdpSocket

fn as_mut(&mut self) -> &mut UdpSocket

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<UdpSocket> for AssociatedUdpSocket

fn as_ref(&self) -> &UdpSocket

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for AssociatedUdpSocket

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

Formats the value using the given formatter.

impl From<(UdpSocket, usize)> for AssociatedUdpSocket

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

Converts to this type from the input type.

impl From<AssociatedUdpSocket> for (UdpSocket, usize)

fn from(from: AssociatedUdpSocket) -> Self

Converts to this type from the input type.