Struct UdpSocketRelay

pub struct UdpSocketRelay<S> { /* private fields */ }

UdpSocketRelay ready to relay udp packets.

This relay is not designed to be shared, as such it cannot be cloned and requires exclusive access.

Implementations

impl<S> UdpSocketRelay<S>

where S: Stream + Unpin,

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

Returns the local address that this socket is bound to.

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

Returns the address of the (socks5) server connected to.

pub async fn send_to<A>( &mut self, b: &[u8], addr: A, ) -> Result<usize, Box<dyn Error + Sync + Send>>

where A: TryInto<SocketAddress>, <A as TryInto<SocketAddress>>::Error: Into<Box<dyn Error + Sync + Send>>,

Sends data relayed via the socks5 udp associate proxy. On success, returns the number of bytes written.

pub fn poll_send_to<A>( &mut self, cx: &mut Context<'_>, b: &[u8], addr: A, ) -> Poll<Result<usize, Box<dyn Error + Sync + Send>>>

where A: TryInto<SocketAddress>, <A as TryInto<SocketAddress>>::Error: Into<Box<dyn Error + Sync + Send>>,

Same as Self::send_to but polled.

pub async fn recv_from( &mut self, buf: &mut [u8], ) -> Result<(usize, SocketAddress), Box<dyn Error + Sync + Send>>

Receives a single datagram message from the socks5 udp associate proxy. On success, returns the number of bytes read and the origin.

The function must be called with valid byte array buf of sufficient size to hold the message bytes. If a message is too long to fit in the supplied buffer, excess bytes may be discarded.

pub fn poll_recv_from( &mut self, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<SocketAddress, Box<dyn Error + Sync + Send>>>

Same as Self::recv_from but polled.

Note that on multiple calls to a poll_* method in the recv direction, only the Waker from the Context passed to the most recent call will be scheduled to receive a wakeup.

Return value

The function returns:

• Poll::Pending if the socket is not ready to read
• Poll::Ready(Ok(addr)) reads data from addr into ReadBuf if the socket is ready
• Poll::Ready(Err(e)) if an error is encountered.

Errors

This function may encounter any standard I/O error except WouldBlock.

pub fn into_framed<C>(self, codec: C) -> UdpFramedRelay<C, S>

Consume this UdpSocketRelay into a UdpFramedRelay using the given C codec.

Trait Implementations

impl<S> Debug for UdpSocketRelay<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<S> Socket for UdpSocketRelay<S>

where S: Send + Sync + 'static,

fn local_addr(&self) -> Result<SocketAddr, Error>

Try to get the local address of the socket.

fn peer_addr(&self) -> Result<SocketAddr, Error>

Try to get the remote address of the socket.