Documentation ¶
Index ¶
- type Bandwidth
- type Clock
- type Cubic
- func (c *Cubic) CongestionWindowAfterAck(currentCongestionWindow protocol.PacketNumber, delayMin time.Duration) protocol.PacketNumber
- func (c *Cubic) CongestionWindowAfterPacketLoss(currentCongestionWindow protocol.PacketNumber) protocol.PacketNumber
- func (c *Cubic) OnApplicationLimited()
- func (c *Cubic) Reset()
- func (c *Cubic) SetNumConnections(n int)
- type DefaultClock
- type HybridSlowStart
- func (s *HybridSlowStart) IsEndOfRound(ack protocol.PacketNumber) bool
- func (s *HybridSlowStart) OnPacketAcked(ackedPacketNumber protocol.PacketNumber)
- func (s *HybridSlowStart) OnPacketSent(packetNumber protocol.PacketNumber)
- func (s *HybridSlowStart) Restart()
- func (s *HybridSlowStart) ShouldExitSlowStart(latestRTT time.Duration, minRTT time.Duration, ...) bool
- func (s *HybridSlowStart) StartReceiveRound(lastSent protocol.PacketNumber)
- func (s *HybridSlowStart) Started() bool
- type PrrSender
- func (p *PrrSender) OnPacketAcked(ackedBytes protocol.ByteCount)
- func (p *PrrSender) OnPacketLost(bytesInFlight protocol.ByteCount)
- func (p *PrrSender) OnPacketSent(sentBytes protocol.ByteCount)
- func (p *PrrSender) TimeUntilSend(congestionWindow, bytesInFlight, slowstartThreshold protocol.ByteCount) time.Duration
- type RTTStats
- func (r *RTTStats) ExpireSmoothedMetrics()
- func (r *RTTStats) GetHalfWindowRTT() time.Duration
- func (r *RTTStats) GetQuarterWindowRTT() time.Duration
- func (r *RTTStats) InitialRTTus() int64
- func (r *RTTStats) LatestRTT() time.Duration
- func (r *RTTStats) MeanDeviation() time.Duration
- func (r *RTTStats) MinRTT() time.Duration
- func (r *RTTStats) OnConnectionMigration()
- func (r *RTTStats) RecentMinRTT() time.Duration
- func (r *RTTStats) SampleNewRecentMinRTT(numSamples uint32)
- func (r *RTTStats) SetRecentMinRTTwindow(recentMinRTTwindow time.Duration)
- func (r *RTTStats) SmoothedRTT() time.Duration
- func (r *RTTStats) UpdateRTT(sendDelta, ackDelay time.Duration, now time.Time)
- type SendAlgorithm
- type SendAlgorithmWithDebugInfo
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Bandwidth ¶
type Bandwidth uint64
Bandwidth of a connection
const ( // BitsPerSecond is 1 bit per second BitsPerSecond Bandwidth = 1 // BytesPerSecond is 1 byte per second BytesPerSecond = 8 * BitsPerSecond )
type Cubic ¶
type Cubic struct {
// contains filtered or unexported fields
}
Cubic implements the cubic algorithm from TCP
func (*Cubic) CongestionWindowAfterAck ¶
func (c *Cubic) CongestionWindowAfterAck(currentCongestionWindow protocol.PacketNumber, delayMin time.Duration) protocol.PacketNumber
CongestionWindowAfterAck computes a new congestion window to use after a received ACK. Returns the new congestion window in packets. The new congestion window follows a cubic function that depends on the time passed since last packet loss.
func (*Cubic) CongestionWindowAfterPacketLoss ¶
func (c *Cubic) CongestionWindowAfterPacketLoss(currentCongestionWindow protocol.PacketNumber) protocol.PacketNumber
CongestionWindowAfterPacketLoss computes a new congestion window to use after a loss event. Returns the new congestion window in packets. The new congestion window is a multiplicative decrease of our current window.
func (*Cubic) OnApplicationLimited ¶
func (c *Cubic) OnApplicationLimited()
OnApplicationLimited is called on ack arrival when sender is unable to use the available congestion window. Resets Cubic state during quiescence.
func (*Cubic) Reset ¶
func (c *Cubic) Reset()
Reset is called after a timeout to reset the cubic state
func (*Cubic) SetNumConnections ¶
SetNumConnections sets the number of emulated connections
type DefaultClock ¶
type DefaultClock struct{}
DefaultClock implements the Clock interface using the Go stdlib clock.
type HybridSlowStart ¶
type HybridSlowStart struct {
// contains filtered or unexported fields
}
HybridSlowStart implements the TCP hybrid slow start algorithm
func (*HybridSlowStart) IsEndOfRound ¶
func (s *HybridSlowStart) IsEndOfRound(ack protocol.PacketNumber) bool
IsEndOfRound returns true if this ack is the last packet number of our current slow start round.
func (*HybridSlowStart) OnPacketAcked ¶
func (s *HybridSlowStart) OnPacketAcked(ackedPacketNumber protocol.PacketNumber)
OnPacketAcked gets invoked after ShouldExitSlowStart, so it's best to end the round when the final packet of the burst is received and start it on the next incoming ack.
func (*HybridSlowStart) OnPacketSent ¶
func (s *HybridSlowStart) OnPacketSent(packetNumber protocol.PacketNumber)
OnPacketSent is called when a packet was sent
func (*HybridSlowStart) ShouldExitSlowStart ¶
func (s *HybridSlowStart) ShouldExitSlowStart(latestRTT time.Duration, minRTT time.Duration, congestionWindow protocol.ByteCount) bool
ShouldExitSlowStart should be called on every new ack frame, since a new RTT measurement can be made then. rtt: the RTT for this ack packet. minRTT: is the lowest delay (RTT) we have seen during the session. congestionWindow: the congestion window in packets.
func (*HybridSlowStart) StartReceiveRound ¶
func (s *HybridSlowStart) StartReceiveRound(lastSent protocol.PacketNumber)
StartReceiveRound is called for the start of each receive round (burst) in the slow start phase.
func (*HybridSlowStart) Started ¶
func (s *HybridSlowStart) Started() bool
Started returns true if started
type PrrSender ¶
type PrrSender struct {
// contains filtered or unexported fields
}
PrrSender implements the Proportional Rate Reduction (PRR) per RFC 6937
func (*PrrSender) OnPacketAcked ¶
OnPacketAcked should be called after a packet was acked
func (*PrrSender) OnPacketLost ¶
OnPacketLost should be called on the first loss that triggers a recovery period and all other methods in this class should only be called when in recovery.
func (*PrrSender) OnPacketSent ¶
OnPacketSent should be called after a packet was sent
type RTTStats ¶
type RTTStats struct {
// contains filtered or unexported fields
}
RTTStats provides round-trip statistics
func NewRTTStats ¶
func NewRTTStats() *RTTStats
NewRTTStats makes a properly initialized RTTStats object
func (*RTTStats) ExpireSmoothedMetrics ¶
func (r *RTTStats) ExpireSmoothedMetrics()
ExpireSmoothedMetrics causes the smoothed_rtt to be increased to the latest_rtt if the latest_rtt is larger. The mean deviation is increased to the most recent deviation if it's larger.
func (*RTTStats) GetHalfWindowRTT ¶
GetHalfWindowRTT gets the half window RTT
func (*RTTStats) GetQuarterWindowRTT ¶
GetQuarterWindowRTT gets the quarter window RTT
func (*RTTStats) InitialRTTus ¶
InitialRTTus is the initial RTT in us
func (*RTTStats) LatestRTT ¶
LatestRTT returns the most recent rtt measurement. May return Zero if no valid updates have occurred.
func (*RTTStats) MeanDeviation ¶
MeanDeviation gets the mean deviation
func (*RTTStats) MinRTT ¶
MinRTT Returns the minRTT for the entire connection. May return Zero if no valid updates have occurred.
func (*RTTStats) OnConnectionMigration ¶
func (r *RTTStats) OnConnectionMigration()
OnConnectionMigration is called when connection migrates and rtt measurement needs to be reset.
func (*RTTStats) RecentMinRTT ¶
RecentMinRTT the minRTT since SampleNewRecentMinRtt has been called, or the minRTT for the entire connection if SampleNewMinRtt was never called.
func (*RTTStats) SampleNewRecentMinRTT ¶
SampleNewRecentMinRTT forces RttStats to sample a new recent min rtt within the next |numSamples| UpdateRTT calls.
func (*RTTStats) SetRecentMinRTTwindow ¶
SetRecentMinRTTwindow sets how old a recent min rtt sample can be.
func (*RTTStats) SmoothedRTT ¶
SmoothedRTT returns the EWMA smoothed RTT for the connection. May return Zero if no valid updates have occurred.
type SendAlgorithm ¶
type SendAlgorithm interface { TimeUntilSend(bytesInFlight protocol.ByteCount) time.Duration OnPacketSent(sentTime time.Time, bytesInFlight protocol.ByteCount, packetNumber protocol.PacketNumber, bytes protocol.ByteCount, isRetransmittable bool) bool GetCongestionWindow() protocol.ByteCount MaybeExitSlowStart() OnPacketAcked(number protocol.PacketNumber, ackedBytes protocol.ByteCount, bytesInFlight protocol.ByteCount) OnPacketLost(number protocol.PacketNumber, lostBytes protocol.ByteCount, bytesInFlight protocol.ByteCount) SetNumEmulatedConnections(n int) OnRetransmissionTimeout(packetsRetransmitted bool) OnConnectionMigration() RetransmissionDelay() time.Duration // Experiments SetSlowStartLargeReduction(enabled bool) }
A SendAlgorithm performs congestion control and calculates the congestion window
type SendAlgorithmWithDebugInfo ¶
type SendAlgorithmWithDebugInfo interface { SendAlgorithm BandwidthEstimate() Bandwidth HybridSlowStart() *HybridSlowStart SlowstartThreshold() protocol.PacketNumber RenoBeta() float32 InRecovery() bool }
SendAlgorithmWithDebugInfo adds some debug functions to SendAlgorithm
func NewCubicSender ¶
func NewCubicSender(clock Clock, rttStats *RTTStats, reno bool, initialCongestionWindow, initialMaxCongestionWindow protocol.PacketNumber) SendAlgorithmWithDebugInfo
NewCubicSender makes a new cubic sender