mirror
/
galene
mirror of https://github.com/jech/galene.git
1
Fork 0
Code

Document jitter concurrency guarantees.

This commit is contained in:
Juliusz Chroboczek 2022-04-21 01:39:05 +02:00
parent 461c78b0e3
commit 8180d9bf50
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
jitter/jitter.go
View File

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