congestion

Documentation

Index

• Constants
• type AckedPacketInfo
• type ByteCount
• type CongestionControl
• type CongestionControlEx
• type LostPacketInfo
• type PacketNumber
• type RTTStatsProvider

Constants

const (
	InitialPacketSizeIPv4      = protocol.InitialPacketSizeIPv4
	InitialPacketSizeIPv6      = protocol.InitialPacketSizeIPv6
	MinPacingDelay             = protocol.MinPacingDelay
	MaxPacketBufferSize        = protocol.MaxPacketBufferSize
	MinInitialPacketSize       = protocol.MinInitialPacketSize
	MaxCongestionWindowPackets = protocol.MaxCongestionWindowPackets
	PacketsPerConnectionID     = protocol.PacketsPerConnectionID
)

Expose some constants from protocol that congestion control algorithms may need.

Types

type AckedPacketInfo

type AckedPacketInfo struct {
	PacketNumber PacketNumber
	BytesAcked   ByteCount
	ReceivedTime time.Time
}

type ByteCount

type ByteCount protocol.ByteCount

type CongestionControl

type CongestionControl interface {
	SetRTTStatsProvider(provider RTTStatsProvider)
	TimeUntilSend(bytesInFlight ByteCount) time.Time
	HasPacingBudget(now time.Time) bool
	OnPacketSent(sentTime time.Time, bytesInFlight ByteCount, packetNumber PacketNumber, bytes ByteCount, isRetransmittable bool)
	CanSend(bytesInFlight ByteCount) bool
	MaybeExitSlowStart()
	OnPacketAcked(number PacketNumber, ackedBytes ByteCount, priorInFlight ByteCount, eventTime time.Time)
	OnCongestionEvent(number PacketNumber, lostBytes ByteCount, priorInFlight ByteCount)
	OnRetransmissionTimeout(packetsRetransmitted bool)
	SetMaxDatagramSize(size ByteCount)
	InSlowStart() bool
	InRecovery() bool
	GetCongestionWindow() ByteCount
}

type CongestionControlEx

type CongestionControlEx interface {
	CongestionControl
	OnCongestionEventEx(priorInFlight ByteCount, eventTime time.Time, ackedPackets []AckedPacketInfo, lostPackets []LostPacketInfo)
}

type LostPacketInfo

type LostPacketInfo struct {
	PacketNumber PacketNumber
	BytesLost    ByteCount
}

type PacketNumber

type PacketNumber protocol.PacketNumber

type RTTStatsProvider

type RTTStatsProvider interface {
	MinRTT() time.Duration
	LatestRTT() time.Duration
	SmoothedRTT() time.Duration
	MeanDeviation() time.Duration
	MaxAckDelay() time.Duration
	PTO(includeMaxAckDelay bool) time.Duration
	UpdateRTT(sendDelta, ackDelay time.Duration, now time.Time)
	SetMaxAckDelay(mad time.Duration)
	SetInitialRTT(t time.Duration)
	OnConnectionMigration()
	ExpireSmoothedMetrics()
}