Struct TcpListener

pub struct TcpListener { /* private fields */ }

A TCP socket server, listening for connections.

You can accept a new connection by using the accept method.

Examples

use std::net::SocketAddr;

use compio_io::{AsyncReadExt, AsyncWriteExt};
use compio_net::{TcpListener, TcpStream};
use socket2::SockAddr;

let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();

let addr = listener.local_addr().unwrap();

let tx_fut = TcpStream::connect(&addr);

let rx_fut = listener.accept();

let (mut tx, (mut rx, _)) = futures_util::try_join!(tx_fut, rx_fut).unwrap();

tx.write_all("test").await.0.unwrap();

let (_, buf) = rx.read_exact(Vec::with_capacity(4)).await.unwrap();

assert_eq!(buf, b"test");

Implementations

impl TcpListener

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

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.

pub fn close(self) -> impl Future<Output = Result<()>>

Close the socket. If the returned future is dropped before polling, the socket won’t be closed.

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.

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

Examples

use std::net::{Ipv4Addr, SocketAddr, SocketAddrV4};

use compio_net::TcpListener;
use socket2::SockAddr;

let listener = TcpListener::bind("127.0.0.1:8080").await.unwrap();

let addr = listener.local_addr().expect("Couldn't get local address");
assert_eq!(
    addr,
    SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080))
);

Trait Implementations

impl AsRawFd for TcpListener

fn as_raw_fd(&self) -> RawFd

Extracts the raw fd.

impl AsRawSocket for TcpListener

Available on Windows only.

fn as_raw_socket(&self) -> RawSocket

Extracts the raw socket.

impl Clone for TcpListener

fn clone(&self) -> TcpListener

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TcpListener

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

Formats the value using the given formatter.

impl FromRawSocket for TcpListener

Available on Windows only.

unsafe fn from_raw_socket(sock: RawSocket) -> Self

Constructs a new I/O object from the specified raw socket.

impl ToSharedFd<Socket> for TcpListener

fn to_shared_fd(&self) -> SharedFd<Socket>

Return a cloned SharedFd.