Struct LockFreeRing 

pub struct LockFreeRing {
    queue: ArrayQueue<Box<[u8]>>,
    slot_limit: usize,
    frames: Vec<PhysFrame>,
}

A bounded lock-free message queue.

Internally uses [crossbeam_queue::ArrayQueue<Box<[u8]>>] for safe, tested message passing. Also allocates minimal physical frames for frame_phys_addrs() used by the shared-ring IPC syscall.

Fields

queue: ArrayQueue<Box<[u8]>>

slot_limit: usize

frames: Vec<PhysFrame>

Implementations

impl LockFreeRing

const DEFAULT_CAPACITY: u32 = 256

Default slot count.

pub fn new(slot_count: u32, slot_size: usize) -> Result<Arc<Self>, RingError>

Create a new ring with slot_count slots for messages up to slot_size bytes.

pub fn capacity(&self) -> u32

The number of slots in this ring.

pub fn slot_size(&self) -> u32

The maximum message size in bytes.

pub fn frame_phys_addrs(&self) -> Vec<u64>

Physical addresses of the backing frames (for IPC ring compat).

pub fn write(&self, data: &[u8]) -> Result<(), RingError>

Write data into the ring. Returns Full if no slot is available, or MessageTooLarge if the data exceeds the slot capacity.

pub fn read(&self, buf: &mut [u8]) -> Result<usize, RingError>

Read one message from the ring into buf.

pub fn try_write(&self, data: &[u8]) -> Result<(), RingError>

Non-blocking write.

pub fn write_vectored(&self, bufs: &[&[u8]]) -> Result<(), RingError>

Write multiple buffers in a single slot (scatter-gather).

pub fn try_read(&self, buf: &mut [u8]) -> Result<Option<usize>, RingError>

Non-blocking read. Returns Ok(None) when the ring is empty.

pub fn notify_consumer_raw(&self)

Notify the consumer that new data is available. No-op under ArrayQueue (notification is handled by the caller).

pub fn notify_producer_raw(&self)

Notify the producer that space has been freed. No-op under ArrayQueue.

pub fn has_data(&self) -> bool

Returns true if the ring contains at least one message.

pub fn has_space(&self) -> bool

Returns true if at least one slot is free.

pub fn dma_buffer(&self, _slot_index: u32) -> Option<DmaBuffer>

DMA buffer descriptor.

ArrayQueue does not expose physical addresses; this method returns None. The NIC data plane uses dedicated hardware ring buffers.

Trait Implementations

impl Debug for LockFreeRing

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

Formats the value using the given formatter.

impl Drop for LockFreeRing

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl IpcConsumer for LockFreeRing

fn recv(&self, buf: &mut [u8]) -> Result<usize, IpcError>

Receive a message, blocking if the buffer is empty.

fn try_recv(&self, buf: &mut [u8]) -> Result<Option<usize>, IpcError>

Receive without blocking.

impl IpcNotification for LockFreeRing

fn notify_consumer(&self)

Notify the consumer that data is available.

fn notify_producer(&self)

Notify the producer that space is available.

fn wait_notification(&self) -> Result<(), IpcError>

Block until a notification arrives.

impl IpcProducer for LockFreeRing

fn send(&self, msg: &[u8]) -> Result<(), IpcError>

Send a message, blocking if the buffer is full.

fn try_send(&self, msg: &[u8]) -> Result<(), IpcError>

Send without blocking.

fn send_vectored(&self, bufs: &[&[u8]]) -> Result<(), IpcError>

Send using vectored I/O (scatter-gather).

impl IpcTransport for LockFreeRing

fn level(&self) -> TransportLevel

The isolation level of this transport.

fn capabilities(&self) -> TransportCapabilities

Static capabilities of this transport.

fn name(&self) -> &'static str

Human-readable name for debugging / profiling.

impl Send for LockFreeRing

impl Sync for LockFreeRing