shm-primitives 0.3.1

Lock-free primitives for shared memory IPC: BipBuffer, slot metadata, and OS-level doorbell/mmap
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

pub mod bipbuf;
pub mod bootstrap;
mod loom_tests;
pub mod peer;
pub mod region;
pub mod segment;
pub mod slot;
pub mod sync;
pub mod varslot_pool;

pub use bipbuf::{
    BIPBUF_HEADER_SIZE, BipBuf, BipBufConsumer, BipBufFull, BipBufHeader, BipBufProducer, BipBufRaw,
};
pub use peer::{PeerEntry, PeerId, PeerState};
pub use region::HeapRegion;
pub use region::Region;
pub use segment::{MAGIC, SEGMENT_HEADER_SIZE, SEGMENT_VERSION, SegmentHeader, SegmentHeaderInit};
pub use slot::{SlotState, VarSlotMeta};
pub use varslot_pool::{
    ClassOffsets, DoubleFreeError, PoolLayout, SizeClassConfig, SlotRef, VarSlotPool,
};

// OS-level primitives for SHM
#[cfg(unix)]
mod unix;
#[cfg(unix)]
pub use unix::*;

#[cfg(windows)]
mod windows;
#[cfg(windows)]
pub use windows::*;