Struct turbulence::unreliable_channel::UnreliableChannel

pub struct UnreliableChannel<P> where
    P: PacketPool,  { /* fields omitted */ }

Turns a stream of unreliable, unordered packets into a stream of unreliable, unordered messages.

Implementations

impl<P> UnreliableChannel<P> where
    P: PacketPool, 

pub fn new(
    packet_pool: P,
    incoming: Receiver<P::Packet>,
    outgoing: Sender<P::Packet>
) -> Self

pub async fn send<'_, '_>(&'_ mut self, msg: &'_ [u8]) -> Result<(), SendError>

Write the given message to the channel.

Messages are coalesced into larger packets before being sent, so in order to guarantee that the message is actually sent, you must call flush.

pub async fn flush<'_>(&'_ mut self) -> Result<(), SendError>

Finish sending any unsent coalesced packets.

This must be called to guarantee that any sent messages are actually sent to the outgoing packet stream.

pub async fn recv<'_, '_>(
    &'_ mut self,
    msg: &'_ mut [u8]
) -> Result<usize, RecvError>

Receive a message into the provide buffer.

If the received message fits into the provided buffer, this will return Ok(message_len), otherwise it will return Err(RecvError::TooBig).