bwe

Documentation

Index

• Constants
• type BWE
• type BWEListener
• type CongestionState
  • func (c CongestionState) String() string
• type NullBWE
  • func (n *NullBWE) CanProbe() bool
  • func (n *NullBWE) CongestionState() CongestionState
  • func (n *NullBWE) HandleREMB(_receivedEstimate int64, _expectedBandwidthUsage int64, _sentPackets uint32, ...)
  • func (n *NullBWE) HandleTWCCFeedback(_report *rtcp.TransportLayerCC)
  • func (n *NullBWE) ProbeClusterDone(_pci ccutils.ProbeClusterInfo)
  • func (n *NullBWE) ProbeClusterFinalize() (ccutils.ProbeSignal, int64, bool)
  • func (n *NullBWE) ProbeClusterIsGoalReached() bool
  • func (n *NullBWE) ProbeClusterStarting(_pci ccutils.ProbeClusterInfo)
  • func (n *NullBWE) ProbeDuration() time.Duration
  • func (n *NullBWE) RecordPacketSendAndGetSequenceNumber(_atMicro int64, _size int, _isRTX bool, _probeClusterId ccutils.ProbeClusterId, ...) uint16
  • func (n *NullBWE) Reset()
  • func (n *NullBWE) SetBWEListener(_bweListener BWEListener)
  • func (n *NullBWE) UpdateRTT(rtt float64)

Constants

const (
	DefaultRTT         = float64(0.070) // 70 ms
	RTTSmoothingFactor = float64(0.5)
)

Types

type BWE

type BWE interface {
	SetBWEListener(bweListner BWEListener)

	Reset()

	HandleREMB(
		receivedEstimate int64,
		expectedBandwidthUsage int64,
		sentPackets uint32,
		repeatedNacks uint32,
	)

	// TWCC sequence number
	RecordPacketSendAndGetSequenceNumber(
		atMicro int64,
		size int,
		isRTX bool,
		probeClusterId ccutils.ProbeClusterId,
		isProbe bool,
	) uint16

	HandleTWCCFeedback(report *rtcp.TransportLayerCC)

	UpdateRTT(rtt float64)

	CongestionState() CongestionState

	CanProbe() bool
	ProbeDuration() time.Duration
	ProbeClusterStarting(pci ccutils.ProbeClusterInfo)
	ProbeClusterDone(pci ccutils.ProbeClusterInfo)
	ProbeClusterIsGoalReached() bool
	ProbeClusterFinalize() (ccutils.ProbeSignal, int64, bool)
}

type BWEListener

type BWEListener interface {
	OnCongestionStateChange(fromState CongestionState, toState CongestionState, estimatedAvailableChannelCapacity int64)
}

type CongestionState

type CongestionState int

const (
	CongestionStateNone CongestionState = iota
	CongestionStateEarlyWarning
	CongestionStateCongested
)

func (CongestionState) String

func (c CongestionState) String() string

type NullBWE

type NullBWE struct {
}

func (*NullBWE) CanProbe

func (n *NullBWE) CanProbe() bool

func (*NullBWE) CongestionState

func (n *NullBWE) CongestionState() CongestionState

func (*NullBWE) HandleREMB

func (n *NullBWE) HandleREMB(
	_receivedEstimate int64,
	_expectedBandwidthUsage int64,
	_sentPackets uint32,
	_repeatedNacks uint32,
)

func (*NullBWE) HandleTWCCFeedback

func (n *NullBWE) HandleTWCCFeedback(_report *rtcp.TransportLayerCC)

func (*NullBWE) ProbeClusterDone

func (n *NullBWE) ProbeClusterDone(_pci ccutils.ProbeClusterInfo)

func (*NullBWE) ProbeClusterFinalize

func (n *NullBWE) ProbeClusterFinalize() (ccutils.ProbeSignal, int64, bool)

func (*NullBWE) ProbeClusterIsGoalReached

func (n *NullBWE) ProbeClusterIsGoalReached() bool

func (*NullBWE) ProbeClusterStarting

func (n *NullBWE) ProbeClusterStarting(_pci ccutils.ProbeClusterInfo)

func (*NullBWE) ProbeDuration

func (n *NullBWE) ProbeDuration() time.Duration

func (*NullBWE) RecordPacketSendAndGetSequenceNumber

func (n *NullBWE) RecordPacketSendAndGetSequenceNumber(
	_atMicro int64,
	_size int,
	_isRTX bool,
	_probeClusterId ccutils.ProbeClusterId,
	_isProbe bool,
) uint16

func (*NullBWE) Reset

func (n *NullBWE) Reset()

func (*NullBWE) SetBWEListener

func (n *NullBWE) SetBWEListener(_bweListener BWEListener)

func (*NullBWE) UpdateRTT

func (n *NullBWE) UpdateRTT(rtt float64)