Struct RingBuffer 

pub struct RingBuffer { /* private fields */ }

A lock-free ring buffer for message passing.

The ring buffer uses atomic head/tail pointers for lock-free operation. Messages are stored inline after the entry header, or as descriptors pointing to shared region data.

Implementations

impl RingBuffer

pub fn new( region: RegionHandle, size: u32, max_msg_size: u32, buffer: *mut u8, buffer_len: usize, ) -> Result<Self>

Create a new ring buffer.

Arguments

• region - Handle to the backing region
• size - Number of entries (must be power of 2)
• max_msg_size - Maximum message size in bytes
• buffer - Pointer to the ring buffer memory
• buffer_len - Length of the buffer

Errors

Returns InvalidParameter if size is not a power of 2.

pub fn region(&self) -> RegionHandle

Returns the region handle.

pub fn size(&self) -> u32

Returns the ring size.

pub fn max_msg_size(&self) -> u32

Returns the maximum message size.

pub fn len(&self) -> u32

Returns the number of entries currently in the ring.

pub fn is_empty(&self) -> bool

Returns true if the ring is empty.

pub fn is_full(&self) -> bool

Returns true if the ring is full.

pub fn available(&self) -> u32

Returns the number of free slots.

pub fn enqueue(&mut self, data: &[u8], priority: MsgPriority) -> Result<()>

Enqueue a message into the ring buffer.

Arguments

• data - Message payload
• priority - Message priority

Errors

Returns QueueFull if the ring is full. Returns MessageTooLarge if the message exceeds max_msg_size.

pub fn enqueue_descriptor( &mut self, descriptor: &MessageDescriptor, priority: MsgPriority, ) -> Result<()>

Enqueue a descriptor into the ring buffer.

This is used for zero-copy message passing when the data is in a shared region.

Arguments

• descriptor - The message descriptor (region, offset, length)
• priority - Message priority

Errors

Returns QueueFull if the ring is full.

pub fn dequeue(&mut self, buf: &mut [u8]) -> Result<RingEntry>

Dequeue a message from the ring buffer.

Arguments

• buf - Buffer to receive the message data

Returns

On success, returns the ring entry header. For inline data, the actual data is copied to buf. For descriptors, the descriptor is in buf.

Errors

Returns QueueEmpty if the ring is empty.

pub fn peek(&self) -> Option<RingEntry>

Peek at the next entry without removing it.

Trait Implementations

impl Send for RingBuffer

impl Sync for RingBuffer