Struct turbulence::unreliable_bincode_channel::UnreliableBincodeChannel

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

Wraps an UnreliableChannel together with an internal buffer to allow easily sending message types serialized with bincode.

Just like the underlying channel, messages are not guaranteed to arrive, nor are they guaranteed to arrive in order.

Implementations

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

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

pub async fn send<T: Serialize, '_, '_>(
    &'_ mut self,
    msg: &'_ T
) -> Result<(), SendError>

Write the given serializable message type 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<'a, T: Deserialize<'a>>(&'a mut self) -> Result<T, RecvError>

Receive a deserializable message type as soon as the next message is available.