Struct TcpManager

pub struct TcpManager { /* private fields */ }

A manager for “shared” resources, used by mtcp_rs::TcpListener and mtcp_rs::TcpStream

The same mtcp_rs::TcpManager instance can be shared by multiple mtcp_rs::TcpListener and mtcp_rs::TcpStream instances. However, an mtcp_rs::TcpManager instance can not be shared across the thread boundary: Each thread needs to create its own mtcp_rs::TcpManager instance. A thread-local singleton instance can be obtained via the instance() function.

The canceller() function can be used to obtain a new mtcp_rs::TcpCanceller instance for this mtcp_rs::TcpManager.

Implementations

impl TcpManager

pub fn instance() -> Result<Rc<Self>>

Get the thread-local singleton TcpManager instance for the calling thread. The instance is created lazily for each thread.

pub fn new() -> Result<Self>

Create a new TcpManager instance with default queue capacity.

pub fn with_capacity(capacity: usize) -> Result<Self>

Create a new TcpManager instance with the specified queue capacity.

pub fn canceller(&self) -> Result<TcpCanceller>

Create a new mtcp_rs::TcpCanceller instance for this TcpManager.

pub fn cancelled(&self) -> bool

Check whether this TcpManager instance has been cancelled yet.

Returns true, if cancellation has been requested for this TcpManager; or false otherwise.

pub fn restart(&self) -> Result<bool>

Restart the TcpManager, i.e. clear its “cancellation” status.

Returns true, if the TcpManager was restarted successfully; or false, if the TcpManager was not in a “cancelled” state.

Trait Implementations

impl Debug for TcpManager

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

Formats the value using the given formatter.