Expand description
Named, bounded same-host dispatch links between members of an Orbit fleet.
A link combines two existing transport shapes:
- one lossless inbox lane per fleet member for application-defined frames;
- one
orbit_streamtable for the duplex byte flow attached to a frame.
The inbox is admission and discovery, not a retained event log: a full lane refuses a frame instead of overwriting one, and a lane with no live owner refuses it instead of accepting work nobody can answer. The stream ticket travels inside the caller’s frame, so this crate chooses no HTTP, RPC, invocation or resource-lease encoding.
The fleet name is the rendezvous. No descriptor is inherited or passed, and application bytes remain in SHM. This is not an upstream protocol and it does not own a connection pool. A caller may retain and rearm a stream slot, which reuses bounded SHM capacity rather than a TCP connection or its TLS/protocol state.
Structs§
- Exchange
Control - Caller-owned control record. Dropping a pending lease invalidates the ticket and wakes its Runner. A Runner treats that stale ticket as cancelled. Keep the caller’s lane hold alive until the lease is released.
- Exchange
Control Ticket - Identifies a control record in the selected Link’s control table. The protocol carries it with the request and correlates the normal reply.
- Exchange
Controls - A payload-free SHM table with a fixed number of records per caller lane. Its kind and capacity belong to the protocol that opts into the table.
- Group
Access - Access to one deployment-owned IPC directory and its named SHM objects.
- Growth
Policy - An owner’s declared growth: never fewer than
minworkers, never more thanmax,stepadded per pressure episode. What a worker is, and how one starts, is the owner’s or its supervisor’s. - Inbox
- A mapped inbox table.
- Inbox
Geometry - A lane’s geometry, shared by both ends because Orbit refuses to open a segment shaped differently from the code’s.
- Joined
- A lane this process holds.
- Link
Bodies - This process’s handle on a named link fleet’s stream table.
- Link
Segment - A mapped inbox table and the region that keeps it mapped.
- Link
Segment Handle - Link
Spec - Physical resources one named link fleet opens.
- Reclaimed
- A lane taken back from a process that is gone.
- Work
Execution - Accepted receiver work. Hold through the complete body/session lifetime.
- Work
Reservation - Sender ownership before inbox publication. Drop rolls back only this unsubmitted reservation. It cannot free accepted receiver work.
- Work
Ticket - One exact reservation in a receiver’s current lifetime.
Enums§
- Admission
- What a writer must know to refuse correctly.
- Error
- What can fail before a protocol adapter owns a dispatched frame.
- Exchange
Control State
Constants§
- EVENT_
FRAME_ TAG - A fleet event carried between two fleets (the
eventsfeature). - LANE_
NAME_ MAX - Longest service name a lane can advertise. Long enough for the names a site route already uses; a longer one is a configuration error, not a truncation.
- LANE_
ROLE_ MAX - Longest role tag a lane can carry:
asgi,php,edge. A word, not a description. - RESERVED_
FRAME_ TAGS - First bytes orbit-link may use for its own frames. A downstream’s frames start with a byte outside this range.
Functions§
- check_
name - Validate the fleet name before opening either physical resource.
- is_
reserved - Whether this frame belongs to orbit-link rather than to the downstream.
- parking_
supported - Whether this host can park an inbox reader without polling.