Struct MemMod

pub struct MemMod { /* private fields */ }

Represents a single netmod endpoint that can connect to exactly one other, either as a 1-to-1 link between libqaul instances or as a link into a transmission medium of some kind.

Implementations

impl MemMod

pub fn new() -> Arc<Self>

Create a new, unpaired MemMod.

pub fn make_pair() -> (Arc<Self>, Arc<Self>)

Create two already-paired MemMods, ready for use.

pub fn linked(&self) -> bool

Return true if the MemMod is linked to another one or false otherwise.

pub fn link(&self, pair: &MemMod)

Establish a 1-to-1 link between two MemMods.

Panics

Panics if this MemMod, or the other one, is already linked.

pub fn split(&self)

Remove the connection between MemMods.

Trait Implementations

impl Endpoint for MemMod

fn size_hint(&self) -> usize

Provides maximum frame-size information to RATMAN

fn send<'life0, 'async_trait>( &'life0 self, frame: Frame, __arg2: Target, ) -> Pin<Box<dyn Future<Output = NetResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send a message to a specific endpoint (client)

Errors

Returns OperationNotSupported if attempting to send through a connection that is not yet connected.

fn next<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = NetResult<(Frame, Target)>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Poll for the next available Frame from this interface