Struct TcpListener 

pub struct TcpListener { /* private fields */ }

Available on crate feature net only.

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

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.

It enables the SO_REUSEADDR option by default.

To configure the socket before binding, you can use the TcpSocket type.

pub fn from_std(stream: TcpListener) -> Result<TcpListener, Error>

Creates new TcpListener from a std::net::TcpListener.

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

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

See TcpStream::close for more details.

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

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 incoming(&self) -> TcpIncoming<'_>

Returns a stream of incoming connections to this listener.

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.

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))
);

pub fn take_error(&self) -> Result<Option<Error>, Error>

Returns the value of the SO_ERROR option.

pub fn ttl_v4(&self) -> Result<u32, Error>

Gets the value of the IP_TTL option for this socket.

For more information about this option, see set_ttl_v4.

pub fn set_ttl_v4(&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.

Trait Implementations

impl AsFd for TcpListener

Available on Unix only.

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

fn clone(&self) -> TcpListener

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl FromRawFd for TcpListener

Available on Unix only.

unsafe fn from_raw_fd(fd: i32) -> TcpListener

Constructs a new instance of Self from the given raw file descriptor.

impl ToSharedFd<Socket> for TcpListener

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

Return a cloned SharedFd.