Struct RateLimiter 

pub struct RateLimiter {
    pub buckets: HashMap<HostName, TokenBucket>,
    pub bypass: HashSet<NodeId>,
}

Peer rate limiter.

Uses a token bucket algorithm, where each address starts with a certain amount of tokens, and every request from that address consumes one token. Tokens refill at a predefined rate. This mechanism allows for consistent request rates with potential bursts up to the bucket’s capacity.

Fields

buckets: HashMap<HostName, TokenBucket>

bypass: HashSet<NodeId>

Implementations

impl RateLimiter

pub fn new(bypass: impl IntoIterator<Item = NodeId>) -> Self

Create a new rate limiter with a bypass list. Nodes in the bypass list are not limited.

pub fn limit<T: AsTokens>( &mut self, addr: HostName, nid: Option<&NodeId>, tokens: &T, now: LocalTime, ) -> bool

Call this when the address has performed some rate-limited action. Returns whether the action is rate-limited or not.

Supplying a different amount of tokens per address is useful if for eg. a peer is outbound vs. inbound.

Trait Implementations

impl Debug for RateLimiter

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

Formats the value using the given formatter.

impl Default for RateLimiter

fn default() -> RateLimiter

Returns the “default value” for a type.