Struct VoiceBudget 

pub struct VoiceBudget { /* private fields */ }

One connection’s voice traffic account.

Three things that share a clock and a lock: the token bucket that decides admission, the one-second window that measures throughput, and the last sign of life that is not a keepalive. Keeping them together is what makes the hot path take one lock rather than three.

The clock is passed in rather than read here: the packet path already knows what time it is, and a test that has to sleep to observe a rate limit is a test that will be flaky by Friday.

Implementations

impl VoiceBudget

pub fn new(now: Instant) -> Self

pub fn allow(&mut self, now: Instant, bytes: usize) -> bool

Take one packet’s worth of budget, refilling for elapsed time first, and bill what it carried.

A refused packet is billed nothing, like the reference server’s own record: addFrame is both the limiter and the meter, and a frame it rejects never enters the window.

bytes is the decoded packet, to which the network overhead is added. false means the caller must drop the packet.

pub fn touch(&mut self, now: Instant)

Note that the connection did something that is not a keepalive.

pub fn bandwidth(&mut self, now: Instant) -> u32

Voice throughput over the last second, in bytes per second.

The unit is the client’s: it divides by 125 to print kbit/s.

REF: references/mumble/src/murmur/ServerUser.cpp : bandwidth() sums the frames of the last second and divides by the elapsed time. REF: references/mumble/src/mumble/UserInformation.cpp : the dialog prints msg.bandwidth() / 125.0 as kbit/s.

pub fn idle(&self, now: Instant) -> Duration

How long this connection has been doing nothing.

REF: references/mumble/src/murmur/ServerUser.cpp : idleSeconds() takes the shorter of “since the last voice frame” and “since the last control message that unidles”.

Trait Implementations

impl Debug for VoiceBudget

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.