Struct TcpListener 

pub struct TcpListener { /* private fields */ }

A TCP socket server, listening for incoming connections once served using one of the serve methods such as TcpListener::serve.

Implementations

impl TcpListener

pub fn build(exec: Executor) -> TcpListenerBuilder

Create a new TcpListenerBuilder without a state, which can be used to configure a TcpListener.

pub async fn bind_address<A>( addr: A, exec: Executor, ) -> Result<TcpListener, Box<dyn Error + Send + Sync>>

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

Creates a new TcpListener, which will be bound to the specified (socket) address.

The returned listener is ready for accepting connections.

Binding with a port number of 0 will request that the OS assigns a port to this listener. The port allocated can be queried via the local_addr method.

pub async fn bind_socket( socket: Socket, exec: Executor, ) -> Result<TcpListener, Box<dyn Error + Send + Sync>>

Creates a new TcpListener, which will be bound to the specified socket.

The returned listener is ready for accepting connections.

pub async fn bind_device<N>( name: N, exec: Executor, ) -> Result<TcpListener, Box<dyn Error + Send + Sync>>

where N: TryInto<DeviceName> + Send + 'static, <N as TryInto<DeviceName>>::Error: Into<Box<dyn Error + Send + Sync>>,

Creates a new TcpListener, which will be bound to the specified (interface) device name.

The returned listener is ready for accepting connections.

pub async fn bind<I>( interface: I, exec: Executor, ) -> Result<TcpListener, Box<dyn Error + Send + Sync>>

where I: TryInto<Interface>, <I as TryInto<Interface>>::Error: Into<Box<dyn Error + Send + Sync>>,

Creates a new TcpListener, which will be bound to the specified interface.

The returned listener is ready for accepting connections.

impl TcpListener

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

Returns the local address that this listener is bound to.

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

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.

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 into_std(self) -> Result<TcpListener, Error>

Converts this TcpListener into a std::net::TcpListener.

The returned listener will be in blocking mode. To convert it back to non-blocking for use with Rama, use TryFrom<std::net::TcpListener>.

This is useful for zero-downtime restarts where listener file descriptors need to be passed between processes via SCM_RIGHTS.

pub fn into_inner(self) -> TcpListener

Consumes this TcpListener and returns the inner [tokio::net::TcpListener].

pub fn from_tokio_tcp_listener( listener: TcpListener, exec: Executor, ) -> TcpListener

pub fn try_from_socket( socket: Socket, exec: Executor, ) -> Result<TcpListener, Error>

pub fn try_from_std_tcp_listener( listener: TcpListener, exec: Executor, ) -> Result<TcpListener, Error>

impl TcpListener

pub async fn accept(&self) -> Result<(TcpStream, SocketAddress), Error>

Accept a single connection from this listener, what you can do with whatever you want.

pub async fn serve<S>(self, service: S)

where S: Service<TcpStream> + Clone,

Serve connections from this listener with the given service.

This listener will spawn a task in which the inner service will handle the incomming connection. Cconnections will be served gracefully if the TcpListener is configured with a graceful Executor.

Trait Implementations

impl Acceptor for TcpListener

type Stream = TcpStream

The Stream returned by this Acceptor.

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

Returns the local address that this listener is bound to.

async fn accept( self, ) -> Result<(<TcpListener as Acceptor>::Stream, SocketAddress), Error>

Returns the first succesfully accepted connection.

impl AsFd for TcpListener

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for TcpListener

fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor.

impl Debug for TcpListener

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

Formats the value using the given formatter.