Struct turbulence::unreliable_channel::UnreliableChannel

pub struct UnreliableChannel<R, P> where
    R: Runtime,
    P: PacketPool,  { /* private fields */ }

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

Implementations

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

pub fn new(
    runtime: R,
    packet_pool: P,
    settings: Settings,
    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.

Messages have a maximum size based on the size of the packets returned from the packet pool. Two bytes are used to encode the length of the message, so the maximum message length is packet.len() - 2, for whatever packet sizes are returned by the pool.

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<(), 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.

This method is cancel safe.

pub async fn recv(&mut self) -> Result<&[u8], 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).

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