Struct veloren_network_protocol::mpsc::MpscSendProtocol

pub struct MpscSendProtocol<D>
where
    D: UnreliableDrain<DataFormat = MpscMsg>,
{
    drain: D,
    last: Instant,
    metrics: ProtocolMetricCache,
}

MPSC implementation of SendProtocol

Fields

drain: D

last: Instant

metrics: ProtocolMetricCache

Implementations

impl<D> MpscSendProtocol<D>

where D: UnreliableDrain<DataFormat = MpscMsg>,

pub fn new(drain: D, metrics: ProtocolMetricCache) -> Self

pub fn supported_promises() -> Promises

returns all promises that this Protocol can take care of If you open a Stream anyway, unsupported promises are ignored.

Trait Implementations

impl<D> Debug for MpscSendProtocol<D>

where D: UnreliableDrain<DataFormat = MpscMsg> + Debug,

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

Formats the value using the given formatter.

impl<D> ReliableDrain for MpscSendProtocol<D>

where D: UnreliableDrain<DataFormat = MpscMsg>,

type CustomErr = <D as UnreliableDrain>::CustomErr

fn send<'life0, 'async_trait>( &'life0 mut self, frame: InitFrame, ) -> Pin<Box<dyn Future<Output = Result<(), ProtocolError<Self::CustomErr>>> + Send + 'async_trait>>

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

impl<D> SendProtocol for MpscSendProtocol<D>

where D: UnreliableDrain<DataFormat = MpscMsg>,

type CustomErr = <D as UnreliableDrain>::CustomErr

fn notify_from_recv(&mut self, _event: ProtocolEvent)

YOU MUST inform the SendProtocol by any Stream Open BEFORE using it in send and Stream Close AFTER using it in send via this fn.

fn send<'life0, 'async_trait>( &'life0 mut self, event: ProtocolEvent, ) -> Pin<Box<dyn Future<Output = Result<(), ProtocolError<Self::CustomErr>>> + Send + 'async_trait>>

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

Send a Event via this Protocol. The SendProtocol MAY require flush to be called before actual data is send to the respective Sink.

fn flush<'life0, 'async_trait>( &'life0 mut self, __arg1: Bandwidth, __arg2: Duration, ) -> Pin<Box<dyn Future<Output = Result<Bandwidth, ProtocolError<Self::CustomErr>>> + Send + 'async_trait>>

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

Flush all buffered messages according to their Prio and Bandwidth. provide the current bandwidth budget (per second) as well as the dt since last call. According to the budget the respective messages will be flushed.