quic_stream (quic v1.3.0)
View SourceQUIC stream state management.
This module manages individual stream state, including: - Stream lifecycle (idle -> open -> half-closed -> closed) - Send and receive buffers - Per-stream flow control - Data ordering and reassembly
Stream Types
Stream IDs encode the initiator and directionality: - Bit 0: 0 = client-initiated, 1 = server-initiated - Bit 1: 0 = bidirectional, 1 = unidirectional
Client-initiated bidirectional: 0, 4, 8, ... Server-initiated bidirectional: 1, 5, 9, ... Client-initiated unidirectional: 2, 6, 10, ... Server-initiated unidirectional: 3, 7, 11, ...
Summary
Functions
Acknowledge that sent data was received.
Check if the stream is blocked on flow control.
Get number of bytes available for reading.
Get number of bytes waiting to be sent.
Check if we can send data on this stream.
Close the stream gracefully.
Get the direction of the stream.
Get the stream priority. Returns {Urgency, Incremental} where Urgency is 0-7 (lower = more urgent) and Incremental indicates whether data can be processed incrementally.
Get data to send, up to MaxBytes. Returns {Data, Offset, Fin, UpdatedStream}
Get the stream ID.
Get the initiator of the stream.
Check if this is a bidirectional stream.
Check if the stream is fully closed.
Check if this stream was initiated by us.
Check if the receive side is closed.
Check if the send side is closed.
Create a new stream with default flow control limits.
Create a new stream with custom options.
Read all available contiguous data.
Read up to MaxBytes of contiguous data.
Receive data at a specific offset.
Mark that FIN was received at the given offset.
Reset the stream (send RESET_STREAM).
Queue data for sending on the stream.
Mark the stream as finished for sending (FIN).
Set the stream priority. Urgency: 0-7 (lower = more urgent, default 3) Incremental: boolean (data can be processed incrementally, default false) Returns {ok, UpdatedStream} or {error, invalid_urgency}.
Get the current stream state.
Handle STOP_SENDING frame from peer.
Update the maximum data we can receive.
Update the send window (peer's MAX_STREAM_DATA).
Types
Functions
-spec ack_send(stream(), non_neg_integer()) -> stream().
Acknowledge that sent data was received.
Check if the stream is blocked on flow control.
-spec bytes_available(stream()) -> non_neg_integer().
Get number of bytes available for reading.
-spec bytes_to_send(stream()) -> non_neg_integer().
Get number of bytes waiting to be sent.
Check if we can send data on this stream.
Close the stream gracefully.
-spec direction(stream()) -> bidirectional | unidirectional.
Get the direction of the stream.
Get the stream priority. Returns {Urgency, Incremental} where Urgency is 0-7 (lower = more urgent) and Incremental indicates whether data can be processed incrementally.
-spec get_send_data(stream(), non_neg_integer()) -> {binary(), non_neg_integer(), boolean(), stream()}.
Get data to send, up to MaxBytes. Returns {Data, Offset, Fin, UpdatedStream}
-spec id(stream()) -> non_neg_integer().
Get the stream ID.
-spec initiator(stream()) -> client | server.
Get the initiator of the stream.
Check if this is a bidirectional stream.
Check if the stream is fully closed.
Check if this stream was initiated by us.
Check if the receive side is closed.
Check if the send side is closed.
-spec new(non_neg_integer(), client | server) -> stream().
Create a new stream with default flow control limits.
-spec new(non_neg_integer(), client | server, map()) -> stream().
Create a new stream with custom options.
Read all available contiguous data.
-spec read(stream(), non_neg_integer() | infinity) -> {binary(), stream()}.
Read up to MaxBytes of contiguous data.
-spec receive_data(stream(), non_neg_integer(), binary(), boolean()) -> {ok, stream()} | {error, term()}.
Receive data at a specific offset.
-spec receive_fin(stream(), non_neg_integer()) -> {ok, stream()} | {error, term()}.
Mark that FIN was received at the given offset.
-spec reset(stream(), non_neg_integer()) -> stream().
Reset the stream (send RESET_STREAM).
Queue data for sending on the stream.
Mark the stream as finished for sending (FIN).
Set the stream priority. Urgency: 0-7 (lower = more urgent, default 3) Incremental: boolean (data can be processed incrementally, default false) Returns {ok, UpdatedStream} or {error, invalid_urgency}.
-spec state(stream()) -> idle | open | half_closed_local | half_closed_remote | closed.
Get the current stream state.
-spec stop_sending(stream(), non_neg_integer()) -> stream().
Handle STOP_SENDING frame from peer.
-spec update_max_data(stream(), non_neg_integer()) -> stream().
Update the maximum data we can receive.
-spec update_send_window(stream(), non_neg_integer()) -> stream().
Update the send window (peer's MAX_STREAM_DATA).