Enum Listener

pub enum Listener {
    Tcp(TcpListenerInfo),
    Uds(UdsListenerInfo),
    TlsTcp(TlsTcpListenerInfo),
}

Wrapper around common protocol-specific listener specifiers.

Variants

Tcp(TcpListenerInfo)

Uds(UdsListenerInfo)

TlsTcp(TlsTcpListenerInfo)

Implementations

impl Listener

pub fn tcp(s: &str) -> Result<Listener, Error>

Create a TCP listener from a string.

Errors

An error means the listener address specification string could not be parsed.

pub fn uds(s: &str) -> Result<Listener, Error>

Create an unix domain socket listener from a string.

Errors

An error means the listener address specification string could not be parsed.

impl Listener

pub async fn run( &self, ks: KillSwitch, acceptor: impl Acceptor + Send, ) -> Result<(), Error>

Run a listener loop.

If the socket bind is successful the Acceptor::bound() of acceptor will be called, where the bound socket address will be passed as an argument. (This can be used to retreive the port number if the application requested the port number to be automatically assigned.

Each time a client has connected the acceptor will call Acceptor::connected() to allow the application to process the connection. The ownership of the newly established connection will be passed to the connected() method.

Unix domain sockets

If the listener is a unix domain socket, the socket file will be removed if the listener is aborted.

Errors

Error::IO can indicate the inability to bind socket.

For “forced” UDS sockets, an ErrorKind::Other is returned if the file already exists and is not a socket.

Trait Implementations

impl From<TcpListenerInfo> for Listener

fn from(info: TcpListenerInfo) -> Listener

Converts to this type from the input type.

impl From<TlsTcpListenerInfo> for Listener

fn from(info: TlsTcpListenerInfo) -> Listener

Converts to this type from the input type.

impl From<UdsListenerInfo> for Listener

fn from(info: UdsListenerInfo) -> Listener

Converts to this type from the input type.

impl FromStr for Listener

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Listener, <Listener as FromStr>::Err>

Parses a string s to return a value of this type.