Struct CancellableTcpListener

pub struct CancellableTcpListener {
    inner: TcpListener,
    is_canceled: AtomicBool,
}

Like std::net::tcp::TcpListener, but cancellable.

Fields

inner: TcpListener

is_canceled: AtomicBool

An atomic boolean flag that indicates if the listener is cancelled.

NOTE: This can be safely read/written by multiple thread at the same time (note that its methods take &self instead of &mut self). To set the flag, use store method with Ordering::Release. To read the flag, use load method with Ordering::Acquire. We will discuss their precise semantics later.

Implementations

impl CancellableTcpListener

pub fn bind<A: ToSocketAddrs>(addr: A) -> Result<CancellableTcpListener>

Wraps TcpListener::bind.

pub fn cancel(&self) -> Result<()>

Signals the listener to stop accepting new connections.

pub fn incoming(&self) -> Incoming<'_>

Returns an iterator over the connections being received on this listener. The returned iterator will return None if the listener is cancelled.

Trait Implementations

impl Debug for CancellableTcpListener

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

Formats the value using the given formatter.