Module ccparams

Source
Expand description

Define the congestion control parameters needed for the algorithms.

All of these values are taken from the consensus. And so the details of these values can be found in section 6.5.1. of proposal 324.

Structs§

AlgorithmType
Congestion control algorithm types defined by numerical values. See “cc_alg” in proposal 324 section 6.5.1 for the supported values.
CongestionControlParams
Global congestion control parameters taken from consensus. These are per-circuit.
CongestionControlParamsBuilder
Builder for CongestionControlParams.
CongestionWindowParams
The parameters of what constitute a congestion window. This is used by all congestion control algorithms as in it is not specific to an algorithm.
CongestionWindowParamsBuilder
Builder for CongestionWindowParams.
FixedWindowParams
Fixed window parameters that are for the SENDME v0 world of fixed congestion window.
FixedWindowParamsBuilder
Builder for FixedWindowParams.
RoundTripEstimatorParams
The round trip estimator parameters taken from consensus and used to estimate the round trip time on a circuit.
RoundTripEstimatorParamsBuilder
Builder for RoundTripEstimatorParams.
VegasParams
Vegas algorithm parameters taken from the consensus.
VegasParamsBuilder
Builder for VegasParams.
VegasQueueParams
Vegas queuing parameters taken from the consensus only which are different depending if the circuit is an onion service one, an exit or used for SBWS.

Enums§

Algorithm
The different congestion control algorithms. Each contain their parameters taken from the consensus.