Struct s2n_quic_transport::stream::AbstractStreamManager

pub struct AbstractStreamManager<S> { /* private fields */ }

Manages all active Streams inside a connection. AbstractStreamManager is paramterized over the Stream type.

Implementations

impl<S: StreamTrait> AbstractStreamManager<S>

pub fn new(
    connection_limits: &Limits,
    local_endpoint_type: Type,
    initial_local_limits: InitialFlowControlLimits,
    initial_peer_limits: InitialFlowControlLimits
) -> Self

Creates a new StreamManager using the provided configuration parameters

pub fn incoming_bytes_progressed(&self) -> VarInt

The number of bytes of forward progress the peer has made on incoming streams

pub fn outgoing_bytes_progressed(&self) -> VarInt

The number of bytes of forward progress the local endpoint has made on outgoing streams

pub fn poll_accept(
    &mut self,
    stream_type: Option<StreamType>,
    context: &Context<'_>
) -> Poll<Result<Option<StreamId>, Error>>

Accepts the next incoming stream of a given type

pub fn poll_open(
    &mut self,
    stream_type: StreamType,
    open_token: &mut OpenToken,
    context: &Context<'_>
) -> Poll<Result<StreamId, Error>>

Opens the next outgoing stream of a certain type

pub fn on_packet_ack<A: Set>(&mut self, ack_set: &A)

This method gets called when a packet delivery got acknowledged

pub fn on_packet_loss<A: Set>(&mut self, ack_set: &A)

This method gets called when a packet loss is reported

pub fn on_rtt_update(&mut self, rtt_estimator: &RttEstimator)

This method gets called when the RTT estimate is updated for the active path

pub fn on_timeout(&mut self, now: Timestamp)

Called when the connection timer expires

pub fn close(&mut self, error: Error)

Closes the AbstractStreamManager and resets all streams with the given error. The current implementation will still allow to forward frames to the contained Streams as well as to query them for data. However new Streams can not be created.

pub fn close_reason(&self) -> Option<Error>

If the StreamManager is closed, this returns the error which which was used to close it.

pub fn flush(&mut self, error: Error) -> Poll<()>

Closes the AbstractStreamManager, flushes all send streams and resets all receive streams.

This is used for when the application drops the connection but still has pending data to transmit.

pub fn on_transmit<W: WriteContext>(
    &mut self,
    context: &mut W
) -> Result<(), OnTransmitError>

Queries the component for any outgoing frames that need to get sent

pub fn on_data(&mut self, frame: &StreamRef<'_>) -> Result<(), Error>

This is called when a STREAM_DATA frame had been received for a stream

pub fn on_data_blocked(&mut self, _frame: DataBlocked) -> Result<(), Error>

This is called when a DATA_BLOCKED frame had been received

pub fn on_stream_data_blocked(
    &mut self,
    frame: &StreamDataBlocked
) -> Result<(), Error>

This is called when a STREAM_DATA_BLOCKED frame had been received for a stream

pub fn on_reset_stream(&mut self, frame: &ResetStream) -> Result<(), Error>

This is called when a RESET_STREAM frame had been received for a stream

pub fn on_max_stream_data(&mut self, frame: &MaxStreamData) -> Result<(), Error>

This is called when a MAX_STREAM_DATA frame had been received for a stream

pub fn on_stop_sending(&mut self, frame: &StopSending) -> Result<(), Error>

This is called when a STOP_SENDING frame had been received for a stream

pub fn on_max_data(&mut self, frame: MaxData) -> Result<(), Error>

This is called when a MAX_DATA frame had been received

pub fn on_streams_blocked(
    &mut self,
    _frame: &StreamsBlocked
) -> Result<(), Error>

This is called when a STREAMS_BLOCKED frame had been received

pub fn on_max_streams(&mut self, frame: &MaxStreams) -> Result<(), Error>

This is called when a MAX_STREAMS frame had been received

pub fn poll_request(
    &mut self,
    stream_id: StreamId,
    api_call_context: &mut ConnectionApiCallContext<'_>,
    request: &mut Request<'_>,
    context: Option<&Context<'_>>
) -> Result<Response, StreamError>

Trait Implementations

impl<S: Debug> Debug for AbstractStreamManager<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S: StreamTrait> Provider for AbstractStreamManager<S>

fn timers<Q: Query>(&self, query: &mut Q) -> Result

Notifies the query of any timers owned by the provider

fn next_expiration(&self) -> Option<Timestamp>

Returns the next Timestamp at which the earliest timer is armed in the provider

fn is_armed(&self) -> bool

Returns true if there are any timers armed

fn armed_timer_count(&self) -> usize

Counts the number of armed timers in the provider

fn for_each_timer<F>(&self, f: F) where
    F: FnMut(&Timer) -> Result<(), QueryBreak>, 

Iterates over each timer in the provider and calls the provided function

impl<S> Send for AbstractStreamManager<S>