Trait ratman_netmod::Endpoint

pub trait Endpoint {
    fn size_hint(&self) -> usize;
#[must_use]    fn send<'life0, 'async_trait>(
        &'life0 self, 
        frame: Frame, 
        target: Target
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
#[must_use]    fn next<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = Result<(Frame, Target)>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
}

The main trait describing a Ratman networking interface

All functions work without mutability because an endpoint is expected to implement some access multiplexing or rely on atomic operations to ensure thread safety. This is because it’s not reasonable for an endpoint driver to rely purely on Rust’s ownership and mutability model, because it will inevitably have to interact with system components, other buffers that push into a queue, or similar.

This interface doesn’t care about the implementation details of these endpoints, and so, to make matters simpler for the router, and to make it obvious that internal mutability needs to be used, this interface is immutable by default.

Required methods

fn size_hint(&self) -> usize

Return a desired frame size in bytes

A user of this library should use this metric to slice larger payloads into frame sequencies via the provided utilities.

This metric is only a hint, and a router can choose to ignore it, if it then deals with possible “too large” errors during sending. Choosing between a greedy or cautious approach to data slicing is left to the user of the interfaces.

#[must_use]fn send<'life0, 'async_trait>(
    &'life0 self,
    frame: Frame,
    target: Target
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Dispatch a Frame across this link

Sending characteristics are entirely up to the implementation. As mentioned in the size_hint() documentation, this function must not panic on a Frame for size reasons, instead it should return Error::FrameTooLarge.

The target ID is a way to instruct a netmod where to send a frame in a one-to-many mapping. When implementing a one-to-one endpoint, this ID can be ignored (set to 0).

#[must_use]fn next<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<(Frame, Target)>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Poll for the next available Frame from this interface

It’s recommended to return transmission errors, even if there are no ways to correct the situation from the router’s POV, simply to feed packet drop metrics.

Loading content...

Implementations on Foreign Types

impl<T: Endpoint + Send + Sync> Endpoint for Arc<T>

fn size_hint(&self) -> usize

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

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

Loading content...

Implementors

Loading content...