mirror/galene
1
Fork 0
mirror of https://github.com/jech/galene.git synced 2024-11-09 18:25:58 +01:00
Code Activity

Document estimator.go.

Browse source
This commit is contained in:
Juliusz Chroboczek 2021-01-19 20:40:19 +01:00
parent 48de81d8a4
commit 14e99aa125
1 changed files with 11 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
estimator/estimator.go
View file

@ -1,3 +1,5 @@
// Package estimator implements a packet and byte rate estimator.
package estimator
import (
@ -18,6 +20,7 @@ type Estimator struct {
packetRate uint32
}
// New creates a new estimator that estimates rate over the last interval.
func New(interval time.Duration) *Estimator {
return &Estimator{
interval: rtptime.FromDuration(interval, rtptime.JiffiesPerSec),
@ -44,8 +47,9 @@ func (e *Estimator) swap(now uint64) {
atomic.StoreUint64(&e.time, now)
}
func (e *Estimator) Accumulate(count uint32) {
atomic.AddUint32(&e.bytes, count)
// Accumulate records one packet of size bytes
func (e *Estimator) Accumulate(bytes uint32) {
atomic.AddUint32(&e.bytes, bytes)
atomic.AddUint32(&e.packets, 1)
}
@ -58,10 +62,15 @@ func (e *Estimator) estimate(now uint64) (uint32, uint32) {
return atomic.LoadUint32(&e.rate), atomic.LoadUint32(&e.packetRate)
}
// Estimate returns an estimate of the rate over the last interval.
// It starts a new interval if the last interval is larger than the value
// passed to New. It returns the byte rate and the packet rate, in units
// per second.
func (e *Estimator) Estimate() (uint32, uint32) {
return e.estimate(rtptime.Now(rtptime.JiffiesPerSec))
}
// Totals returns the total number of bytes and packets accumulated.
func (e *Estimator) Totals() (uint32, uint32) {
b := atomic.LoadUint32(&e.totalBytes) + atomic.LoadUint32(&e.bytes)
p := atomic.LoadUint32(&e.totalPackets) + atomic.LoadUint32(&e.packets)