Struct turbulence::reliable_bincode_channel::ReliableBincodeChannel

pub struct ReliableBincodeChannel { /* private fields */ }

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

Messages are guaranteed to arrive, and are guaranteed to be in order. Messages have a maximum length, but this maximum size can be larger than the size of an individual packet.

Implementations

impl ReliableBincodeChannel

pub fn new(channel: ReliableChannel, max_message_len: u16) -> Self

Create a new ReliableBincodeChannel with a maximum message size of max_message_len.

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

Write the given message to the reliable channel.

In order to ensure that messages are sent in a timely manner, flush must be called after calling this method. Without calling flush, any pending writes will not be sent until the next automatic sender task wakeup.

This method is cancel safe, it will never partially send a message, though canceling it may or may not buffer a message to be sent.

pub async fn flush(&mut self) -> Result<(), Error>

Ensure that any previously sent messages are sent as soon as possible.

This method is cancel safe.

pub async fn recv<'a, T: Deserialize<'a>>(&'a mut self) -> Result<T, Error>

Read the next available incoming message.

This method is cancel safe, it will never partially read a message or drop received messages.