1
Fork 0
mirror of https://github.com/jech/galene.git synced 2024-11-08 17:55:59 +01:00

Document jitter concurrency guarantees.

This commit is contained in:
Juliusz Chroboczek 2022-04-21 01:39:05 +02:00
parent 461c78b0e3
commit 8180d9bf50

View file

@ -1,3 +1,4 @@
// package jitter implements a jitter estimator
package jitter
import (
@ -14,6 +15,7 @@ type Estimator struct {
jitter uint32 // atomic
}
// New returns a new jitter estimator that uses units of 1/hz seconds.
func New(hz uint32) *Estimator {
return &Estimator{hz: hz}
}
@ -36,10 +38,13 @@ func (e *Estimator) accumulate(timestamp, now uint32) {
e.time = now
}
// Accumulate accumulates a new sample for the jitter estimator.
func (e *Estimator) Accumulate(timestamp uint32) {
e.accumulate(timestamp, uint32(rtptime.Now(e.hz)))
}
// Jitter returns the estimated jitter, in units of 1/hz seconds.
// This function is safe to call concurrently.
func (e *Estimator) Jitter() uint32 {
return atomic.LoadUint32(&e.jitter)
}