Struct turbulence::reliable_channel::ReliableChannel

pub struct ReliableChannel { /* fields omitted */ }

Turns a stream of unreliable, unordered packets into a reliable in-order stream of data.

Methods

impl ReliableChannel

pub fn new<R, P>(
    runtime: R,
    packet_pool: P,
    settings: Settings,
    incoming: Receiver<P::Packet>,
    outgoing: Sender<P::Packet>
) -> Self where
    R: Runtime + 'static,
    P: PacketPool + Send + 'static,
    P::Packet: Send, 

pub async fn write<'_, '_>(&'_ mut self, data: &'_ [u8]) -> Result<usize, Error>

Write the given data to the reliable channel and return once any nonzero amount of data has been written.

In order to ensure that data is written to the channel in a timely manner, ReliableChannel::flush must be called. Without calling ReliableChannel::flush, any pending writes will not be sent until the next send task wakeup.

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

Ensure that any previously written data is sent in a timely manner.

Returns once the sending task has been notified to wake up and will send the written data promptly. Does not actually wait for outgoing packets to be sent before returning.

pub async fn read<'_, '_>(
    &'_ mut self,
    data: &'_ mut [u8]
) -> Result<usize, Error>

Read any available data. Returns once at least one byte of data has been read.