Struct tokio_socks::tcp::Socks5Listener

pub struct Socks5Listener { /* fields omitted */ }

A SOCKS5 BIND client.

Once you get an instance of Socks5Listener, you should send the bind_addr to the remote process via the primary connection. Then, call the accept function and wait for the other end connecting to the rendezvous address.

Methods

impl Socks5Listener

pub fn bind<'t, P, T>(
    proxy: P,
    target: T
) -> Result<BindFuture<'static, 't, P::Output>, Error> where
    P: ToProxyAddrs,
    T: IntoTargetAddr<'t>, 

Initiates a BIND request to the specified proxy.

The proxy will filter incoming connections based on the value of target.

Error

It propagates the error that occurs in the conversion from T to TargetAddr.

pub fn bind_with_password<'a, 't, P, T>(
    proxy: P,
    target: T,
    username: &'a str,
    password: &'a str
) -> Result<BindFuture<'a, 't, P::Output>, Error> where
    P: ToProxyAddrs,
    T: IntoTargetAddr<'t>, 

Initiates a BIND request to the specified proxy using given username and password.

The proxy will filter incoming connections based on the value of target.

Error

It propagates the error that occurs in the conversion from T to TargetAddr.

pub fn bind_addr(&self) -> TargetAddr

Returns the address of the proxy-side TCP listener.

This should be forwarded to the remote process, which should open a connection to it.

pub fn accept(
    self
) -> impl Future<Item = Socks5Stream, Error = Error>

Consumes this listener, returning a Future which resolves to the Socks5Stream connected to the target server through the proxy.

The value of bind_addr should be forwarded to the remote process before this method is called.