Struct Listener

pub struct Listener { /* private fields */ }

Configured TCP. AF_UNIX or other stream socket acceptor.

Based on extended hyper 0.14’s AddrIncoming code.

Implementations

impl Listener

pub async fn bind( addr: &ListenerAddress, sys_opts: &SystemOptions, usr_opts: &UserOptions, ) -> Result<Self>

Creates listener corresponding specified to tokio-listener address and options.

• For TCP addresses it tries to behave close to hyper 0.14’s listener
• For UNIX path addresses, it can unlink or change permissions of the socket based on user options
• For raw fd sockets, it checkes LISTEN_FD and LISTEN_PID environment variables by default, unless opted out in user options
• For inetd it accepts only one connection. However, reporting of the error of inability to accept the second connection is delayed until the first connection finishes, to avoid premature exit from process.

With hyper014 crate feature (default), the listener can be directly used as argument for Server::builder.

Binding may fail due to unsupported address type, e.g. if trying to use UNIX addresses on Windows or abstract-namespaces sockets on Mac.

pub async fn bind_multiple( addrs: &[ListenerAddress], sys_opts: &SystemOptions, usr_opts: &UserOptions, ) -> Result<Self>

Create a listener that accepts connections on multipe sockets simultaneously.

Fails if addrs is empty slice or if any of the parts failed to initialise.

See documentation of [bind] method for other help.

impl Listener

pub fn try_borrow_tcp_listener(&self) -> Option<&TcpListener>

pub fn try_borrow_unix_listener(&self) -> Option<&UnixListener>

pub fn try_into_tcp_listener(self) -> Result<TcpListener, Self>

pub fn try_into_unix_listener(self) -> Result<UnixListener, Self>

pub fn no_more_connections(&self) -> bool

This listener is in inetd (stdin/stdout) more and the sole connection is already accepted

pub fn poll_accept( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<(Connection, SomeSocketAddr)>>

See main Listener::bind documentation for specifics of how it accepts connections

pub async fn accept(&mut self) -> Result<(Connection, SomeSocketAddr)>

See main Listener::bind documentation for specifics of how it accepts connections

Trait Implementations

impl Debug for Listener

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

Formats the value using the given formatter.

impl Listener for Listener

type Io = Connection

The stream’s type of this listener.

type Addr = SomeSocketAddr

The socket address type of this listener.

fn poll_accept( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<(Self::Io, Self::Addr)>>

Polls to accept a new incoming connection to this listener.

fn local_addr(&self) -> Result<Self::Addr>

Returns the local address that this listener is bound to.

fn accept(&mut self) -> ListenerAcceptFut<'_, Self>

where Self: Sized,

Accepts a new incoming connection from this listener.

impl Stream for Listener

type Item = Result<Connection, Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.