Skip to main content

Crate orbit_core

Crate orbit_core 

Source
Expand description

§orbit-core — fleet-aware shared memory

§What this crate is

Fleet-shared same-host runtime storage between workers.

Every process that joins the fleet is an equal member. There is no master, no worker — only peers. Whatever role distinction matters to the embedder is the embedder’s concern; not Orbit’s. Independent observers can instead attach existing SHM rings read-only, without becoming members.

§Status — first light (V0)

V0 ships fixed-capacity append logs and current-state tables with POSIX shared-memory backing on Unix. Semantic layers choose the shape that matches their data: history belongs in rings; current leases do not.

Re-exports§

pub use epoch::OrbitEpoch;
pub use error::Error;
pub use error::Result;
pub use fleet::FleetObserver;
pub use fleet::Fleet;
pub use fleet::NodeId;
pub use ring::RingEventFd;
pub use ring::cursor::RingCursor;
pub use ring::cursor::RingFrameSource;
pub use ring::cursor::RingLoss;
pub use ring::cursor::RingPoll;
pub use ring::cursor::RingRead;
pub use ring::cursor::poll_ring;
pub use ring::shm::ShmRingLaneView;
pub use ring::shm::ShmRingMetadata;
pub use ring::shm::ShmRingView;
pub use ring::Frame;
pub use ring::Ring;
pub use ring::RingSpec;
pub use ring::RingTopology;

Modules§

epoch
Tick and epoch helpers for Orbit frame versions.
error
Error type for orbit-core. Deliberately small — this layer has few independent failure modes.
fleet
Fleet — the per-process handle for one node address in a fleet’s shared physical geometry.
id
Re-export of the standalone netid64 primitive.
readiness
A descriptor pair for turning a shared-memory change into fd readiness.
ring
Ring buffers — orbit-core’s runtime substrate.
ring_shm
Compatibility module for the pre-ring::shm layout.
shm
POSIX shared-memory helpers — V1 substrate for cross-process rings.
sync
Waiting on a shared 32-bit word, the primitive under every “wake me when this changes” in Orbit: ring readiness, cell changes.

Structs§

NetId64
Runtime-bound 64-bit identifier with [KIND:8][NODE:16][COUNTER:40] layout.
ParseNetId64Error
Parse error for NetId64::from_str.

Traits§

OrbitTyped
Marker for a type that has a stable wire identity across the fleet.