Struct tari_comms::socks::Socks5Client

pub struct Socks5Client<TSocket> { /* fields omitted */ }

A SOCKS5 socket connection.

Implementations

impl<TSocket> Socks5Client<TSocket> where
    TSocket: AsyncRead + AsyncWrite + Unpin, 

pub fn new(socket: TSocket) -> Self

Create a new socks5 client with a socket already connected to the target proxy

pub fn with_authentication(
    &mut self,
    auth: Authentication
) -> Result<&mut Self, SocksError>

pub async fn connect(
    self,
    address: &Multiaddr
) -> Result<(TSocket, Multiaddr), SocksError>

Connects to a address through a SOCKS5 proxy and returns the 'upgraded' socket. This consumes the Socks5Client as once connected, the socks protocol does not recognise any further commands.

pub async fn tor_resolve(
    &mut self,
    address: &Multiaddr
) -> Result<Multiaddr, SocksError>

Requests the tor proxy to resolve a DNS address is resolved into an IP address. This operation only works with the tor SOCKS proxy.

pub async fn tor_resolve_ptr(
    &mut self,
    address: &Multiaddr
) -> Result<Multiaddr, SocksError>

Requests the tor proxy to reverse resolve an IP address into a DNS address if it is able. This operation only works with the tor SOCKS proxy.