Struct TcpListener

pub struct TcpListener { /* private fields */ }

A simulated TCP socket server, listening for connections.

All methods must be called from a host within a Turmoil simulation.

Implementations

impl TcpListener

pub async fn bind<A: ToSocketAddrs>(addr: A) -> Result<TcpListener>

Creates a new TcpListener, which will be bound to the specified 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.

Only 0.0.0.0, ::, or localhost are currently supported.

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

Accepts a new incoming connection from this listener.

This function will yield once a new TCP connection is established. When established, the corresponding TcpStream and the remote peer’s address will be returned.

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

Returns the local address that this listener is bound to.

Trait Implementations

impl Drop for TcpListener

fn drop(&mut self)

Executes the destructor for this type.