Expand description
std::sync::atomic between the processes of a fleet.
Orbitals is one fleet-shared table of 64-bit values in Orbit shared
memory. Orbitals::allocate declares a value and returns an
Orbital, a handle with the operations of an atomic. Its
OrbitalId is the only thing that travels: any process of the fleet
that Orbitals::opens the id holds the same value, and can
Orbital::wait for it to change.
A value lives as long as its table’s shared memory. Nothing releases a
single value; the table’s owner clears all of them with
Orbitals::reset_all when it boots with nothing else attached.
Structs§
- Orbital
- One shared value, typed. Cheap to clone; every clone, and every handle any process opens from the same id, is the same 64 bits.
- Orbital
Id - The address of one shared value:
kind:8 | slot:24 | epoch:32. - Orbitals
- The fleet’s table of shared values. Cheap to clone.
Enums§
- Error
- Additions are expected: a cause discovered later lands here rather than in a new major version, so a caller matches what it handles and leaves the rest to a catch-all.
- Kind
- What the 64 bits of a value spell.
Constants§
- ATOMIC_
CAPACITY - How many values one table can declare between two resets.
- ATOMIC_
KIND - Reserved Orbit SHM kind for the table.
Traits§
- Primitive
- A type one shared value can hold:
i64,u64,f64orbool.