Struct NetBufferConsumer

pub struct NetBufferConsumer { /* private fields */ }

Consumer side of the network buffer (used in audio thread).

All methods are realtime-safe and do not allocate.

Implementations

impl NetBufferConsumer

pub fn try_pop(&mut self) -> Option<NetMessage>

Pop a single network message from the buffer (realtime-safe).

Returns Some(NetMessage) if available, None if empty.

pub fn drain_into_stack( &mut self, ) -> StackVec<NetMessage, MAX_NET_EVENTS_PER_BUFFER>

Drain all available messages into a stack-allocated buffer.

Returns a StackVec of messages. This is realtime-safe as it uses stack allocation with a fixed maximum capacity of MAX_NET_EVENTS_PER_BUFFER.

If more messages are available than the stack buffer can hold, the remaining messages stay in the ring buffer for the next call.

pub fn drain_into(&mut self, buffer: &mut Vec<NetMessage>) -> usize

Drain all available messages into a provided Vec.

Returns the number of messages drained.

Warning

This method allocates heap memory and is NOT suitable for realtime audio processing. Use drain_into_stack() instead for audio thread code.

pub fn is_empty(&self) -> bool

Check if the buffer is empty.

pub fn len(&self) -> usize

Returns the approximate number of messages in the buffer.