Struct PacketPool

Source

pub struct PacketPool { /* private fields */ }

Expand description

Pre-allocated packet buffer pool.

Uses an MpmcRing of free indices for lock-free allocation and deallocation. The Vyukov bounded MPMC algorithm used by MpmcRing provides ABA safety via per-slot sequence numbers, so no custom tagged pointers or Treiber stacks are needed.

All buffers are pre-allocated at construction time to avoid runtime memory allocation in the hot path.

Implementations§

Source §

impl PacketPool

Source

pub fn new(capacity: usize) -> Result<Self>

Creates a new packet pool with the specified capacity.

§Errors

Returns an error if allocation fails.

Source

pub fn with_default_capacity() -> Result<Self>

Creates a new pool with the default capacity.

§Errors

Returns an error if allocation fails.

Source

pub const fn capacity(&self) -> usize

Returns the pool capacity.

Source

pub fn free_count(&self) -> usize

Returns the number of free buffers.

Source

pub fn allocated_count(&self) -> usize

Returns the number of allocated buffers.

Source

pub fn alloc(&self) -> Option<PacketRef<'_>>

Allocates a buffer from the pool.

Returns None if the pool is empty. The returned PacketRef auto-frees the buffer on drop; use PacketRef::into_index to transfer ownership by index without auto-freeing.

Source

pub fn alloc_index(&self) -> Option<u32>

Allocates a buffer and returns its index.

Returns None if the pool is empty.

Source

pub fn alloc_with_data(&self, data: &[u8]) -> Result<PacketRef<'_>>

Allocates a buffer and initializes it with data.

§Errors

Returns an error if the pool is empty or data is too large.

Source

pub unsafe fn free_by_index(&self, idx: u32)

Returns a buffer to the pool by index.

§Safety

The buffer at this index must not be in use elsewhere.

Source

pub unsafe fn get(&self, idx: u32) -> &PacketBuffer

Gets a buffer by index.

§Safety

The caller must ensure the buffer is allocated.

Source

pub unsafe fn get_mut(&self, idx: u32) -> &mut PacketBuffer

Gets a mutable buffer by index.

§Safety

The caller must ensure the buffer is allocated, has exclusive access, and no PacketRef exists for the same index. Violating this creates aliasing &mut references, which is instant UB.

Source