Crate byteor_transport_shm

Crate byteor_transport_shm 

Source
Expand description

Shared-memory transport utilities (open/create/validate).

This crate will own OS-facing mapping logic and treat SHM as untrusted input.

§Crash / cleanup semantics

Regions are file-backed mappings. If a process crashes, the backing file may remain on disk. Subsequent openers will:

  • validate layout compatibility once initialization is complete
  • wait for a bounded time if the mapping is observed in an “initializing” state
  • fail closed with Error::Layout(indexbus_core::Error::NotInitialized) if initialization does not complete (e.g. the initializing process crashed)

Best-effort cleanup is performed by callers (tests/benches remove their temp files). Operator tooling may also remove stale mapping files as needed.

Structs§

EventsChainRegion
File-backed events-chain region (one slot pool + Q SPSC queues + Q MPSC queues of slot indices).
MappingInfo
Describes the OS-facing properties of a mapped backing region.
OpenOptions
Options for opening a mapped ByteOr-owned region.
SequencedSlotsRegion
File-backed sequenced-slots region.

Enums§

Error
Errors returned by this transport.