Struct ShmHandle 

pub struct ShmHandle {
    pub path: PathBuf,
    pub header: ShmHeader,
    pub state: ShmProvisionState,
    /* private fields */
}

Handle to the provisioned -shm file. Drop semantics intentionally minimal in this slice — callers must invoke Self::detach_reader explicitly to mirror the eventual mmap-backed lifecycle.

Fields

path: PathBuf

header: ShmHeader

state: ShmProvisionState

Implementations

impl ShmHandle

pub fn generation(&self) -> u64

Current generation counter. Bumps on every crash recovery so observers can detect that ownership changed between snapshots.

pub fn attach_reader(&mut self) -> Result<u64>

Increment the on-disk reader counter. Returns the new count.

pub fn detach_reader(&mut self) -> Result<u64>

Decrement the on-disk reader counter (saturating). Returns new count.

pub fn heartbeat(&mut self) -> Result<()>

Refresh last_heartbeat_ms to the current unix-ms.