Struct UdpRelay

pub struct UdpRelay<B, I> { /* private fields */ }

Only “useful” public Socks5UdpAssociator implementation, which actually is able to accept udp-relay requests and process them.

The Default implementation opens a new (udp) socket for accepting 1 incoming connection. Once received it will relay incoming packets to the target udp socket and relay received packets from the latter back to the socks5 server cient. Prefixing these upd packets using [UdpHeader].

You can customise the UdpRelay fully by creating it using UdpRelay::new or overwrite any of the default components using either or both of UdpRelay::with_binder and [Binder::with_inspector].

Implementations

impl<B> UdpRelay<B, DirectUdpRelay>

pub fn new(binder: B) -> UdpRelay<B, DirectUdpRelay>

Create a new UdpRelay.

pub fn with_sync_inspector<T>( self, inspector: T, ) -> UdpRelay<B, SyncUdpInspector<T>>

Overwrite the [Connector]’s [Inspector] that can be used to inspect / modify a udp packet to be relayed synchronously.

pub fn with_async_inspector<T>( self, inspector: T, ) -> UdpRelay<B, AsyncUdpInspector<T>>

Overwrite the [Connector]’s [Inspector] that can be used to inspect / modify a udp packet to be relayed asynchronously.

impl<B, I> UdpRelay<B, I>

pub fn with_binder<T>(self, binder: T) -> UdpRelay<T, I>

Overwrite the UdpRelay’s [UdpBinder], used to open a socket, return the address and wait for an incoming connection which it will return.

pub fn set_bind_interface( &mut self, interface: impl Into<Interface>, ) -> &mut UdpRelay<B, I>

Define the (network) Interface to bind to, for both north and south direction.

Use:

• UdpRelay::set_bind_north_interface: to only set Interface for the north direction;
• UdpRelay::set_bind_south_interface: to only set Interface for the south direction.

By default it binds the udp sockets at 0.0.0.0:0.

pub fn with_bind_interface( self, interface: impl Into<Interface>, ) -> UdpRelay<B, I>

Define the (network) Interface to bind to, for both north and south direction.

Use:

• UdpRelay::with_bind_north_interface: to only set Interface for the north direction;
• UdpRelay::with_bind_south_interface: to only set Interface for the south direction.

By default it binds the udp sockets at 0.0.0.0:0.

pub fn set_bind_north_interface( &mut self, interface: impl Into<Interface>, ) -> &mut UdpRelay<B, I>

Define the (network) Interface to bind to, for the north direction.

Use:

• UdpRelay::set_bind_interface: to only set Interface for both the north and south direction;
• UdpRelay::set_bind_south_interface: to only set Interface for the south direction.

By default it binds the udp sockets at 0.0.0.0:0.

pub fn with_bind_north_interface( self, interface: impl Into<Interface>, ) -> UdpRelay<B, I>

Define the (network) Interface to bind to, for the north direction.

Use:

• UdpRelay::with_bind_interface: to only set Interface for both the north and south direction;
• UdpRelay::with_bind_south_interface: to only set Interface for the south direction.

By default it binds the udp sockets at 0.0.0.0:0.

pub fn set_bind_south_interface( &mut self, interface: impl Into<Interface>, ) -> &mut UdpRelay<B, I>

Define the (network) Interface to bind to, for the south direction.

Use:

• UdpRelay::set_bind_interface: to only set Interface for both the north and south direction;
• UdpRelay::set_bind_north_interface: to only set Interface for the north direction.

By default it binds the udp sockets at 0.0.0.0:0.

pub fn with_bind_south_interface( self, interface: impl Into<Interface>, ) -> UdpRelay<B, I>

Define the (network) Interface to bind to, for the south direction.

Use:

• UdpRelay::with_bind_interface: to only set Interface for both the north and south direction;
• UdpRelay::with_bind_north_interface: to only set Interface for the north direction.

By default it binds the udp sockets at 0.0.0.0:0.

pub fn set_buffer_size_south(&mut self, n: usize) -> &mut UdpRelay<B, I>

Set the size of the buffer used to read south traffic.

Use:

• UdpRelay::set_buffer_size: to only set the buffer size for both the north and south direction;
• UdpRelay::set_buffer_size_north: to only set the buffer size for the north direction.

pub fn set_buffer_size_north(&mut self, n: usize) -> &mut UdpRelay<B, I>

Set the size of the buffer used to read north traffic.

Use:

• UdpRelay::set_buffer_size: to only set the buffer size for both the north and south direction;
• UdpRelay::set_buffer_size_south: to only set the buffer size for the south direction.

pub fn set_buffer_size(&mut self, n: usize) -> &mut UdpRelay<B, I>

Set the size of the buffer used to read both north and south traffic.

Use:

• UdpRelay::set_buffer_size_north: to only set the buffer size for the north direction.
• UdpRelay::set_buffer_size_south: to only set the buffer size for the south direction.

pub fn with_buffer_size_south(self, n: usize) -> UdpRelay<B, I>

Set the size of the buffer used to read south traffic.

Use:

• UdpRelay::with_buffer_size: to only set the buffer size for both the north and south direction;
• UdpRelay::with_buffer_size_north: to only set the buffer size for the north direction.

pub fn with_buffer_size_north(self, n: usize) -> UdpRelay<B, I>

Set the size of the buffer used to read north traffic.

Use:

• UdpRelay::with_buffer_size: to only set the buffer size for both the north and south direction;
• UdpRelay::with_buffer_size_south: to only set the buffer size for the south direction.

pub fn with_buffer_size(self, n: usize) -> UdpRelay<B, I>

Set the size of the buffer used to read both north and south traffic.

Use:

• UdpRelay::with_buffer_size_north: to only set the buffer size for the north direction.
• UdpRelay::with_buffer_size_south: to only set the buffer size for the south direction.

pub fn set_relay_timeout( &mut self, relay_timeout: Duration, ) -> &mut UdpRelay<B, I>

Set field with Some(value)

pub fn with_relay_timeout(self, relay_timeout: Duration) -> UdpRelay<B, I>

Replace field with Some(value)

pub fn maybe_with_relay_timeout( self, relay_timeout: Option<Duration>, ) -> UdpRelay<B, I>

Replace field with the provided option

impl<B, I> UdpRelay<B, I>

pub fn with_default_dns_resolver(self) -> UdpRelay<B, I>

Attach a the Default DnsResolver to this UdpRelay.

It will be used to best-effort resolve the domain name, in case a domain name is passed to forward to the target server.

pub fn set_default_dns_resolver(&mut self) -> &mut UdpRelay<B, I>

Attach a the Default DnsResolver to this UdpRelay.

It will be used to best-effort resolve the domain name, in case a domain name is passed to forward to the target server.

pub fn with_dns_resolver( self, resolver: impl DnsResolver<Error = OpaqueError>, ) -> UdpRelay<B, I>

Attach a DnsResolver to this UdpRelay.

It will be used to best-effort resolve the domain name, in case a domain name is passed to forward to the target server.

pub fn set_dns_resolver( &mut self, resolver: impl DnsResolver<Error = OpaqueError>, ) -> &mut UdpRelay<B, I>

Attach a DnsResolver to this UdpRelay.

It will be used to best-effort resolve the domain name, in case a domain name is passed to forward to the target server.

Trait Implementations

impl<B, I> Clone for UdpRelay<B, I>

where B: Clone, I: Clone,

fn clone(&self) -> UdpRelay<B, I>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<B, I> Debug for UdpRelay<B, I>

where B: Debug, I: Debug,

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

Formats the value using the given formatter.

impl Default for UdpRelay<Timeout<DefaultUdpBinder, LayerErrorStatic<Elapsed>>, DirectUdpRelay>

fn default() -> UdpRelay<Timeout<DefaultUdpBinder, LayerErrorStatic<Elapsed>>, DirectUdpRelay>

Returns the “default value” for a type.

impl<B, I, S, State> Socks5UdpAssociatorSeal<S, State> for UdpRelay<B, I>

where B: SocketService<State, Socket = UdpSocket>, I: UdpPacketProxy<State>, S: Stream + Unpin, State: Clone + Send + Sync + 'static,

async fn accept_udp_associate( &self, ctx: Context<State>, stream: S, destination: Authority, ) -> Result<(), Error>