Struct naia_shared::MessageManager

pub struct MessageManager<P: ProtocolType> { /* private fields */ }

Handles incoming/outgoing messages, tracks the delivery status of Messages so that guaranteed Messages can be re-transmitted to the remote host

Implementations

impl<P: ProtocolType> MessageManager<P>

pub fn new() -> Self

Creates a new MessageManager

pub fn has_outgoing_messages(&self) -> bool

Returns whether the Manager has queued Messages that can be transmitted to the remote host

pub fn pop_outgoing_message(&mut self, packet_index: u16) -> Option<P>

Gets the next queued Message to be transmitted

pub fn unpop_outgoing_message(&mut self, packet_index: u16, message: P)

If the last popped Message from the queue somehow wasn’t able to be written into a packet, put the Message back into the front of the queue

pub fn queue_outgoing_message<R: ReplicateSafe<P>>(
    &mut self,
    message: &R,
    guaranteed_delivery: bool
)

Queues an Message to be transmitted to the remote host

pub fn has_incoming_messages(&self) -> bool

Returns whether any Messages have been received that must be handed to the application

pub fn pop_incoming_message(&mut self) -> Option<P>

Get the most recently received Message

pub fn process_data(
    &mut self,
    reader: &mut PacketReader<'_>,
    manifest: &Manifest<P>,
    packet_index: u16
)

Given incoming packet data, read transmitted Messages and store them to be returned to the application

Trait Implementations

impl<P: Debug + ProtocolType> Debug for MessageManager<P>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<P: ProtocolType> PacketNotifiable for MessageManager<P>

fn notify_packet_delivered(&mut self, packet_index: u16)

Occurs when a packet has been notified as delivered. Stops tracking the status of Messages in that packet.

fn notify_packet_dropped(&mut self, packet_index: u16)

Occurs when a packet has been notified as having been dropped. Queues up any guaranteed Messages that were lost in the packet for retransmission.