bbr

Documentation

Overview

package bbr implements the BBR congestion control algorithm, as described in:

https://queue.acm.org/detail.cfm?id=3022184

Index

• type Limiter
  • func NewLimiter(clk clock.Clock) *Limiter
  • func (l *Limiter) Release()
  • func (l *Limiter) StartMessage(ctx context.Context, size uint64) (gotResponse func(), err error)
• type Snapshot
  • func SnapshotLimiter(l *Limiter) Snapshot
  • func (s Snapshot) Json() any
• type SnapshottingLimiter
  • func (l SnapshottingLimiter) Release()
  • func (l SnapshottingLimiter) StartMessage(ctx context.Context, size uint64) (gotResponse func(), err error)

Types

type Limiter

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

A Limiter implements flowcontrol.FlowLimiter using the BBR algorithm.

func NewLimiter

func NewLimiter(clk clock.Clock) *Limiter

NewLimiter returns a new BBR-based flow limiter. The clock is used to measure message resposne times. If nil is passed (typical, except for testing & debugging), the system clock will be used.

func (*Limiter) Release

func (l *Limiter) Release()

func (*Limiter) StartMessage

func (l *Limiter) StartMessage(ctx context.Context, size uint64) (gotResponse func(), err error)

type Snapshot

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

A Snapshot captures the internal state of a limiter at the time it was called, along with the current time. This is useful for debugging.

func SnapshotLimiter

func SnapshotLimiter(l *Limiter) Snapshot

Take a snapshot of the limiter.

func (Snapshot) Json

func (s Snapshot) Json() any

Returns a value that can be formatted as json using the encoding/json package, which captures the data in the snapshot. The exact format of this is unspecified, as it exposes implementation details of the Limiter type.

type SnapshottingLimiter

type SnapshottingLimiter struct {
	Limiter        *Limiter       // The limiter to wrap
	RecordSnapshot func(Snapshot) // The callback to pass snapshots to
}

A SnapshottingLimiter is a wrapper around Limiter which takes snapshots on each operation and passes them to a callback.

func (SnapshottingLimiter) Release

func (l SnapshottingLimiter) Release()

func (SnapshottingLimiter) StartMessage

func (l SnapshottingLimiter) StartMessage(ctx context.Context, size uint64) (gotResponse func(), err error)