Expand description
Shared-memory transport for vox.
Implements Link over lock-free ring buffers in shared memory.
Inline bipbuf payloads are copied into boxed backing; slot-ref payloads are exposed
as shared zero-copy backing and freed when the backing is dropped.
Re-exports§
pub use segment::AttachError;pub use segment::Segment;pub use segment::SegmentConfig;pub use segment::SegmentLayout;pub use host::create_test_link_pair;pub use host::AddPeerOptions;pub use host::GuestSpawnTicket;pub use host::HostHub;pub use host::HostPeer;pub use host::MultiPeerHostDriver;pub use host::PreparedPeer;pub use host::ShmHost;pub use host::guest_link_from_raw;pub use host::guest_link_from_ticket;
Modules§
- bootstrap
- High-level SHM bootstrap helpers over control connections.
- driver
- framing
- SHM framing — the 8-byte header that wraps each BipBuffer entry.
- host
- Thin SHM host/guest orchestration helpers.
- mmap_
registry - Mmap payload registry for large payloads that exceed the VarSlotPool.
- peer_
table - PeerTable — the array of peer entries in the shared memory segment.
- segment
- High-level
Segment— the top-level handle for a vox SHM segment. - varslot
- VarSlotPool exports.
Structs§
- ShmLink
- A
Linkover shared memory ring buffers. - ShmLink
Rx - Receiving half of a
ShmLink. - ShmLink
Tx - Sending half of a
ShmLink. - ShmTransport
Stats Snapshot - ShmTx
Permit - ShmWrite
Slot - Size
Class Config - Configuration for one size class, supplied at pool creation and at attach.
- SlotRef
- Reference to an allocated slot — returned by
VarSlotPool::allocate. - VarSlot
Pool - Lock-free slot allocator operating on a shared memory
Region.