Module core

Expand description

Low-level Orbit primitives.

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.

Fleet: Per-process handle into the fleet. Cheap to clone — the inner state is Arc-shared.
FleetName: Same-host fleet namespace, distinct from a process or application name.
FleetObserver: Read-only namespace handle for inspecting an existing SHM fleet.
Frame: One record in a ring — the on-wire shape (mirrors nwd1::Frame).
InvalidFleetName
NetId64: Runtime-bound 64-bit identifier with [KIND:8][NODE:16][COUNTER:40] layout.
NodeId: A node’s physical writer slot inside the fleet.
OrbitEpoch: Milliseconds since the Unix epoch, carried in Frame::ver by time-sensitive Orbit primitives.
ParkedRingEventFd: Readiness for a ring whose publishers wake only parked readers.
ParseNetId64Error: Parse error for NetId64::from_str.
Ring: A fixed-capacity, fleet-wide append-only log keyed on KIND byte.
RingCursor: Caller-owned position in a ring walk.
RingEventFd: Process-local fd readiness bridge for one shared Orbit ring.
RingLoss: Counters skipped while walking a ring.
RingPoll: Result of walking a cursor toward a ring’s visible head.
RingSpec: Physical policy for one OrbitTyped ring.
ShmRingLaneView: One physical lane of a ShmRingView.
ShmRingMetadata: Persisted geometry of one existing Orbit SHM ring.
ShmRingView: Read-only attachment to one existing Orbit SHM ring.

OrbitTyped: Marker for a type that has a stable wire identity across the fleet.
RingFrameSource: Read-only source that can be walked by RingCursor.