congestion

package
v0.0.0-...-09eeadd Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 29, 2022 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// BitsPerSecond is 1 bit per second
	BitsPerSecond Bandwidth = 1
	// BytesPerSecond is 1 byte per second
	BytesPerSecond = 8 * BitsPerSecond

	KiloBitsPerSecond  = factor * BitsPerSecond
	KiloBytesPerSecond = factor * BytesPerSecond
	MegaBitsPerSecond  = factor * KiloBitsPerSecond
	MegaBytesPerSecond = factor * KiloBytesPerSecond

	GigaBytesPerSecond = factor * MegaBytesPerSecond
)

Variables

This section is empty.

Functions

func ConfigControlSocketLocation 

func ConfigControlSocketLocation() string

func ConfigLogBackendLocation 

func ConfigLogBackendLocation() string

func ConfigLogName 

func ConfigLogName() string

func ConfigSamplingRate 

func ConfigSamplingRate() time.Duration

func NewCubicSender 

func NewCubicSender(
	clock Clock,
	rttStats *utils.RTTStats,
	initialMaxDatagramSize protocol.ByteCount,
	reno bool,
	tracer logging.ConnectionTracer,
) *cubicSender

NewCubicSender makes a new cubic sender

func NewOpenLoopSender 

func NewOpenLoopSender(
	clock Clock,
	rttStats *utils.RTTStats,
	openLoopInitialMaxDatagramSize protocol.ByteCount,
) *openLoopSender

NewOpenLoopSender makes a new cubic sender

func PrintAfter10Sec 

func PrintAfter10Sec(cl ConnectionLogger)

func StartPeriodicLogHook 

func StartPeriodicLogHook(periodicLogHook func(), period time.Duration)

Types

type Bandwidth 

type Bandwidth uint64

Bandwidth of a connection

func BandwidthFromDelta 

func BandwidthFromDelta(bytes protocol.ByteCount, delta time.Duration) Bandwidth

BandwidthFromDelta calculates the bandwidth from a number of bytes and a time delta

func (Bandwidth) Int64 

func (b Bandwidth) Int64() int64

func (Bandwidth) String 

func (b Bandwidth) String() string

type Clock 

type Clock interface {
	Now() time.Time
}

A Clock returns the current time

type CongestionType 

type CongestionType string
const (
	CongestionTypeCubic    CongestionType = "Cubic"
	CongestionTypeReno     CongestionType = "Reno"
	CongestionTypeOpenLoop CongestionType = "Open-Loop"
)

type ConnectionLogger 

type ConnectionLogger interface {
	LogString(time time.Time, key string, value string)
	LogInt64(time time.Time, key string, value int64)
	LogEvent(time time.Time, eventName string)
	String() string
}

func NewConnectionLogger 

func NewConnectionLogger() ConnectionLogger

type ConnectionLoggerMemory 

type ConnectionLoggerMemory struct {
	LogStorage map[string]*LogEntrySeries
}

func (*ConnectionLoggerMemory) EnsureKeyInit 

func (cl *ConnectionLoggerMemory) EnsureKeyInit(key string)

func (*ConnectionLoggerMemory) InitKey 

func (cl *ConnectionLoggerMemory) InitKey(key string)

func (*ConnectionLoggerMemory) LogEvent 

func (cl *ConnectionLoggerMemory) LogEvent(time time.Time, eventName string)

func (*ConnectionLoggerMemory) LogInt64 

func (cl *ConnectionLoggerMemory) LogInt64(time time.Time, key string, value int64)

func (*ConnectionLoggerMemory) LogString 

func (cl *ConnectionLoggerMemory) LogString(time time.Time, key string, value string)

func (ConnectionLoggerMemory) String 

func (cl ConnectionLoggerMemory) String() string

type ConnectionLoggerRemote 

type ConnectionLoggerRemote struct {
	// contains filtered or unexported fields
}

func (*ConnectionLoggerRemote) LogEvent 

func (cl *ConnectionLoggerRemote) LogEvent(time time.Time, eventName string)

func (*ConnectionLoggerRemote) LogInt64 

func (cl *ConnectionLoggerRemote) LogInt64(time time.Time, key string, value int64)

func (*ConnectionLoggerRemote) LogString 

func (cl *ConnectionLoggerRemote) LogString(time time.Time, key string, value string)

func (ConnectionLoggerRemote) String 

func (cl ConnectionLoggerRemote) String() string

type ControlAction 

type ControlAction struct {
	Type  string `json:"type"`
	Value string `json:"value"`
}

type Cubic 

type Cubic struct {
	// contains filtered or unexported fields
}

Cubic implements the cubic algorithm from TCP

func NewCubic 

func NewCubic(clock Clock) *Cubic

NewCubic returns a new Cubic instance

func (*Cubic) CongestionWindowAfterAck 

func (c *Cubic) CongestionWindowAfterAck(
	ackedBytes protocol.ByteCount,
	currentCongestionWindow protocol.ByteCount,
	delayMin time.Duration,
	eventTime time.Time,
) protocol.ByteCount

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.ByteCount) protocol.ByteCount

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 

func (c *Cubic) SetNumConnections(n int)

SetNumConnections sets the number of emulated connections

type DefaultClock 

type DefaultClock struct{}

DefaultClock implements the Clock interface using the Go stdlib clock.

func (DefaultClock) Now 

func (DefaultClock) Now() time.Time

Now gets the current time

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) Restart 

func (s *HybridSlowStart) Restart()

Restart the slow start phase

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 LogBackend 

type LogBackend string
const (
	LogBackendMemory LogBackend = "Memory"
	LogBackendRemote LogBackend = "Socket"
)

func ConfigLogBackend 

func ConfigLogBackend() LogBackend

type LogEntry 

type LogEntry struct {
	EventTime time.Time
	Type      LogEntryValueType
	Value     string
}

func (LogEntry) String 

func (le LogEntry) String() string

type LogEntrySeries 

type LogEntrySeries struct {
	LogEntries []LogEntry
}

func (*LogEntrySeries) Append 

func (logSeries *LogEntrySeries) Append(entry LogEntry)

func (*LogEntrySeries) String 

func (logSeries *LogEntrySeries) String() string

type LogEntryValueType 

type LogEntryValueType string
const (
	LogEntryTypeString LogEntryValueType = "string"
	LogEntryTypeInt64  LogEntryValueType = "int64"
	LogEntryTypeEvent  LogEntryValueType = "event"
)

type OpenLoopController 

type OpenLoopController struct {
	SetCwndFunction   func(int64)
	SetMaxSendingRate func(Bandwidth)
	// contains filtered or unexported fields
}

func NewOpenLoopController 

func NewOpenLoopController(setCwndFunc func(int64), setMaxSendingRate func(Bandwidth)) *OpenLoopController

func (*OpenLoopController) Close 

func (o *OpenLoopController) Close() error

type RemoteLogEntry 

type RemoteLogEntry struct {
	ConnectionName string
	Key            string
	EventTime      int64
	Type           LogEntryValueType
	Value          string
}

type SendAlgorithm 

type SendAlgorithm interface {
	TimeUntilSend(bytesInFlight protocol.ByteCount) time.Time
	HasPacingBudget() bool
	OnPacketSent(sentTime time.Time, bytesInFlight protocol.ByteCount, packetNumber protocol.PacketNumber, bytes protocol.ByteCount, isRetransmittable bool)
	CanSend(bytesInFlight protocol.ByteCount) bool
	MaybeExitSlowStart()
	OnPacketAcked(number protocol.PacketNumber, ackedBytes protocol.ByteCount, priorInFlight protocol.ByteCount, eventTime time.Time)
	OnPacketLost(number protocol.PacketNumber, lostBytes protocol.ByteCount, priorInFlight protocol.ByteCount)
	OnRetransmissionTimeout(packetsRetransmitted bool)
	SetMaxDatagramSize(protocol.ByteCount)
}

A SendAlgorithm performs congestion control

type SendAlgorithmWithDebugInfos 

type SendAlgorithmWithDebugInfos interface {
	SendAlgorithm
	InSlowStart() bool
	InRecovery() bool
	GetCongestionWindow() protocol.ByteCount
}

A SendAlgorithmWithDebugInfos is a SendAlgorithm that exposes some debug infos

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.