Struct BandwidthBudgetManager 

pub struct BandwidthBudgetManager { /* private fields */ }

Per-peer token-bucket bandwidth manager.

Call refill or refill_all periodically (or lazily before each consume call) to add tokens, then use try_consume_upload / try_consume_download to request bandwidth.

Implementations

impl BandwidthBudgetManager

pub fn new(config: BudgetConfig) -> Self

Creates a new manager with the supplied configuration.

pub fn register_peer(&mut self, peer_id: &str, now: u64)

Registers a peer using the default quota.

If the peer is already registered this is a no-op.

pub fn register_peer_with_quota( &mut self, peer_id: &str, quota: BandwidthQuota, now: u64, )

Registers a peer with a custom quota, overriding the default.

If the peer already exists its quota is replaced and tokens are re-initialised.

pub fn refill(&mut self, peer_id: &str, now: u64)

Refills the token bucket for a single peer based on elapsed time.

Does nothing if the peer is not registered or now is not later than the peer’s last_refill timestamp.

pub fn refill_all(&mut self, now: u64)

Refills token buckets for all registered peers.

pub fn try_consume_upload( &mut self, peer_id: &str, bytes: u64, now: u64, ) -> bool

Attempts to consume bytes of upload bandwidth for peer_id.

Returns true and deducts tokens when:

1. The peer is registered,
2. The peer has enough upload tokens,
3. The global upload cap has not been reached.

Returns false (and does not deduct tokens) in all other cases.

pub fn try_consume_download( &mut self, peer_id: &str, bytes: u64, now: u64, ) -> bool

Attempts to consume bytes of download bandwidth for peer_id.

Returns true and deducts tokens when:

1. The peer is registered,
2. The peer has enough download tokens,
3. The global download cap has not been reached.

Returns false (and does not deduct tokens) in all other cases.

pub fn remaining_upload(&self, peer_id: &str) -> u64

Returns the number of remaining upload tokens for peer_id, floored to 0.

Returns 0 for unknown peers.

pub fn remaining_download(&self, peer_id: &str) -> u64

Returns the number of remaining download tokens for peer_id, floored to 0.

Returns 0 for unknown peers.

pub fn remove_peer(&mut self, peer_id: &str) -> bool

Removes a peer from the manager.

Returns true if the peer existed, false otherwise.

pub fn peer_count(&self) -> usize

Returns the number of currently registered peers.

pub fn stats(&self) -> &BudgetStats

Returns a reference to the aggregate statistics.