Skip to main content

Module stream

Module stream 

Source

Modules§

exchange
Paired, symmetric byte flows over one control channel and shared or directional payload arenas. Each endpoint owns an outbound sender and an inbound receiver.

Structs§

CapacityChanged
A release in this creator’s lane may have freed a slot or made a retained endpoint rearmable. This is a hint, not a reservation: retry the operation.
Endpoint
Both ends of one side: what Streams::create and Streams::open return. Reads and writes go through it directly, or Endpoint::split gives the halves to two tasks.
Incarnation
Which life of a process holds a side. A node id is a role that a replacement process inherits; the incarnation tells the two apart, so a late death report for the old process never touches the new one’s streams. Orbit does not mint it: the embedder knows what identifies one live process (a start stamp, a supervisor generation) and supplies it.
ReadHalf
The reading end of one side. Dropping it tells the peer’s writer that nothing more will be read.
Readiness
The consumer’s end: put it in a poll set, drain it, re-read your state.
ResetSignal
A reset-only observation of a reading direction, without consuming bytes or treating a clean FIN as failure. One reset observer per direction has a separate bounded local waker; it cannot replace the body reader’s waker.
StreamId
The address of one stream: a NetId64 whose node is the creator’s lane and whose counter is the slot and its generation.
StreamSpec
Which segment a Streams table uses, and how big its lanes and rings are.
Streams
The fleet’s stream table. Cheap to clone; every clone in a process is the same table, the same driver and the same wakers.
Ticket
One end of a stream, in the form that crosses a setup channel: the address, the side, and the epoch of the table the address was minted in. Prints as <address>/b/<epoch>.
WriteHalf
The writing end of one side. Dropping it without WriteHalf::finish resets the direction, as a dropped socket would.

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.
Side
Which end of a stream a handle holds. The creator holds A.

Constants§

STREAM_BUFFER_BYTES
Bytes each direction of a stream can hold before its writer waits, in the default spec.
STREAM_KIND
Reserved Orbit SHM kind for the default stream segment. Another table names its own through a StreamSpec.
STREAM_LANE_CAPACITY
Streams one fleet node can hold open at once, in the default spec.

Functions§

segment_size
Bytes the segment needs for fleet_capacity lanes; what a lifecycle tool validates an existing object against without mapping it read-write.
segment_size_for
Bytes spec’s segment needs for fleet_capacity lanes.

Type Aliases§

Result