Struct socks5_server::Server

pub struct Server<O> { /* private fields */ }

A SOCKS5 server listener

This server listens on a socket and treats incoming connections as SOCKS5 connections.

A (TcpListener, Arc<dyn Auth<Output = O> + Send + Sync>) can be converted into a Server<O> with From trait. Also, a Server<O> can be converted back.

Generic type <O> is the output type of the authentication adapter. See trait Auth.

Example

use socks5_server::{auth::NoAuth, Server};
use std::sync::Arc;
use tokio::net::TcpListener;

async fn listen() {
    let listener = TcpListener::bind("127.0.0.1:5000").await.unwrap();
    let auth = Arc::new(NoAuth) as Arc<_>;

    let server = Server::from((listener, auth));

    while let Ok((conn, _)) = server.accept().await {
        tokio::spawn(async move {
            todo!();
        });
    }
}

Implementations

impl<O> Server<O>

pub async fn accept(&self) -> Result<(IncomingConnection<O>, SocketAddr), Error>

Accept an IncomingConnection<O>.

The connection is only a freshly created TCP connection and may not be a valid SOCKS5 connection. You should call IncomingConnection::authenticate() to perform a SOCKS5 authentication handshake.

pub fn poll_accept( &self, cx: &mut Context<'_> ) -> Poll<Result<(IncomingConnection<O>, SocketAddr), Error>>

Polls to accept an IncomingConnection<O>.

The connection is only a freshly created TCP connection and may not be a valid SOCKS5 connection. You should call IncomingConnection::authenticate() to perform a SOCKS5 authentication handshake.

If there is no connection to accept, Poll::Pending is returned and the current task will be notified by a waker. Note that on multiple calls to poll_accept, only the Waker from the Context passed to the most recent call is scheduled to receive a wakeup.

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

Returns the local address that this server is bound to.

This can be useful, for example, when binding to port 0 to figure out which port was actually bound.

pub fn set_ttl(&self, ttl: u32) -> Result<(), Error>

Sets the value for the IP_TTL option on this socket.

This value sets the time-to-live field that is used in every packet sent from this socket.

pub fn ttl(&self) -> Result<u32, Error>

Gets the value of the IP_TTL option for this socket.

For more information about this option, see set_ttl.

Trait Implementations

impl<O> From<(TcpListener, Arc<dyn Auth<Output = O> + Send + Sync>)> for Server<O>

fn from( (listener, auth): (TcpListener, Arc<dyn Auth<Output = O> + Send + Sync>) ) -> Self

Converts to this type from the input type.

impl<O> From<Server<O>> for (TcpListener, Arc<dyn Auth<Output = O> + Send + Sync>)

fn from(server: Server<O>) -> Self

Converts to this type from the input type.