orbit-core 0.3.14

Fleet-aware shared-memory rings over POSIX shared memory.
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

//! # `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.

#[doc(hidden)]
pub mod compile;
pub mod epoch;
pub mod error;
pub mod fleet;
pub mod ring;
#[cfg(unix)]
pub mod shm;
pub mod sync;

pub mod id {
    //! Re-export of the standalone `netid64` primitive.

    pub use netid64::{NetId64, ParseNetId64Error};
}

#[cfg(unix)]
pub mod ring_shm {
    //! Compatibility module for the pre-`ring::shm` layout.
    pub use crate::ring::shm::*;
}

pub use epoch::OrbitEpoch;
pub use error::{Error, Result};
#[cfg(unix)]
pub use fleet::FleetObserver;
pub use fleet::{Fleet, NodeId};
pub use id::{NetId64, ParseNetId64Error};
#[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "macos"))]
pub use ring::RingEventFd;
pub use ring::cursor::{RingCursor, RingFrameSource, RingLoss, RingPoll, RingRead, poll_ring};
#[cfg(unix)]
pub use ring::shm::{ShmRingLaneView, ShmRingMetadata, ShmRingView};
pub use ring::{Frame, Ring, RingSpec, RingTopology};

/// Marker for a type that has a stable wire identity across the fleet.
///
/// Required bounds:
/// - `Clone` — values may be delivered to multiple subscribers / nodes.
/// - `Send + Sync + 'static` — values cross thread / process boundaries.
pub trait OrbitTyped: Clone + Send + Sync + 'static {
    /// Stable wire identifier. Hand-picked in V0; build.rs-generated later.
    const KIND: u8;

    /// Ring layout and retention policy for this wire kind.
    ///
    /// This is part of the cross-process wire contract. Reusing a KIND
    /// with a different spec is an error.
    const RING_SPEC: RingSpec;
}