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() -> TcpListenerBuilder

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

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

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

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, ) -> Result<TcpListener, Box<dyn Error + Sync + Send>>

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, ) -> Result<TcpListener, Box<dyn Error + Sync + Send>>

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

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, ) -> Result<TcpListener, Box<dyn Error + Sync + Send>>

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

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.

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>,

Serve connections from this listener with the given service.

This method will block the current listener for each incoming connection, the underlying service can choose to spawn a task to handle the accepted stream.

pub async fn serve_graceful<S>(self, guard: ShutdownGuard, service: S)

where S: Service<TcpStream>,

Serve gracefully connections from this listener with the given service.

This method does the same as Self::serve but it will respect the given rama_core::graceful::ShutdownGuard, and also pass it to the service.

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 Debug for TcpListener

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

Formats the value using the given formatter.

impl From<TcpListener> for TcpListener

fn from(value: TcpListener) -> TcpListener

Converts to this type from the input type.

impl TryFrom<Socket> for TcpListener

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: Socket, ) -> Result<TcpListener, <TcpListener as TryFrom<Socket>>::Error>

Performs the conversion.

impl TryFrom<TcpListener> for TcpListener

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: TcpListener, ) -> Result<TcpListener, <TcpListener as TryFrom<TcpListener>>::Error>

Performs the conversion.