Struct StreamFlowCtrl 

pub(crate) struct StreamFlowCtrl {
    e: StreamFlowCtrlEnum,
}

Manages flow control for a stream.

Fields

e: StreamFlowCtrlEnum

Private internal enum.

Implementations

impl StreamFlowCtrl

pub(crate) fn new_window(window: SendWindow<StreamParams>) -> Self

Returns a new sendme-window-based StreamFlowCtrl.

pub(crate) fn new_xon_xoff( params: Arc<FlowCtrlParameters>, use_sidechannel_mitigations: bool, rate_limit_updater: Sender<StreamRateLimit>, drain_rate_requester: NotifySender<DrainRateRequest>, ) -> Self

Returns a new xon/xoff-based StreamFlowCtrl.

Trait Implementations

impl Debug for StreamFlowCtrl

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

Formats the value using the given formatter.

impl FlowCtrlHooks for StreamFlowCtrl

fn can_send<M: RelayMsg>(&self, msg: &M) -> bool

Whether this stream is ready to send msg.

fn about_to_send(&mut self, msg: &AnyRelayMsg) -> Result<()>

Inform the flow control code that we’re about to send msg. Returns an error if the message should not be sent, and the circuit should be closed.

fn put_for_incoming_sendme(&mut self, msg: UnparsedRelayMsg) -> Result<()>

Handle an incoming sendme.

fn handle_incoming_xon(&mut self, msg: UnparsedRelayMsg) -> Result<()>

Handle an incoming XON message.

fn handle_incoming_xoff(&mut self, msg: UnparsedRelayMsg) -> Result<()>

Handle an incoming XOFF message.

fn maybe_send_xon( &mut self, rate: XonKbpsEwma, buffer_len: usize, ) -> Result<Option<Xon>>

Check if we should send an XON message.

fn maybe_send_xoff(&mut self, buffer_len: usize) -> Result<Option<Xoff>>

Check if we should send an XOFF message.