Struct TcpListener 

pub struct TcpListener { /* private fields */ }

Async TCP listening socket.

A listener accepts inbound TcpStream connections from a bound local address. Use TcpListener::accept for one connection at a time or TcpListener::incoming for a Stream adapter.

Implementations

impl TcpListener

pub fn from_std(listener: TcpListener) -> Result<Self>

Available on Unix only.

Adopts a blocking std::net::TcpListener, returning an async TcpListener.

The socket is switched to non-blocking mode. Ownership of the descriptor transfers to the returned listener.

impl TcpListener

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

where A: ToSocketAddrs + Send + 'static,

Binds a TCP listener to the first resolved address that succeeds.

Binding to port 0 asks the OS to assign an available port, which can be retrieved with local_addr.

Like std::net::TcpListener::bind, this does not set SO_REUSEADDR. To reuse a recently-closed address (or bind while a previous socket is in TIME_WAIT), configure a TcpSocket and enable it before binding:

runite::spawn(async {
    let socket = runite::net::TcpSocket::new_v4().unwrap();
    socket.set_reuseaddr(true).unwrap();
    socket.bind("127.0.0.1:0".parse().unwrap()).unwrap();
    let listener = socket.listen(1024).unwrap();
    assert!(listener.local_addr().unwrap().port() != 0);
});
runite::run();

Examples

runite::spawn(async {
    let listener = runite::net::TcpListener::bind("127.0.0.1:0")
        .await
        .unwrap();
    assert!(listener.local_addr().unwrap().port() != 0);
});
runite::run();

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

Accepts an incoming connection.

The returned address is the peer address reported by the operating system for the accepted stream.

pub fn incoming(&self) -> Incoming

Returns a Stream that yields inbound connections as they arrive.

The stream is infinite: it never yields None. Each item is the result of an accept, so transient errors surface as Some(Err(_)) without ending iteration.

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

Returns the local socket address of this listener.

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

Reads the listener socket’s IP time-to-live value.

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

Sets the listener socket’s IP time-to-live value.

Trait Implementations

impl AsFd for TcpListener

Available on Unix only.

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

Borrows the file descriptor.

impl AsRawFd for TcpListener

Available on Unix only.

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for TcpListener

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

Formats the value using the given formatter.

impl From<OwnedFd> for TcpListener

Available on Unix only.

fn from(fd: OwnedFd) -> Self

Adopts an already-listening TCP socket. Use TcpListener::from_std to adopt a std::net::TcpListener and set the expected mode.