Skip to main content

ThreeLayerRateLimiter

Struct ThreeLayerRateLimiter 

Source
pub struct ThreeLayerRateLimiter { /* private fields */ }
Expand description

Three-layer rate limiter for inbound authenticated per-request traffic.

Methods are &self — concurrent admission decisions don’t take a write lock. Each layer uses its own governor limiter and the Result<(), RejectLayer> short-circuits at the first rejection.

Keyspace bound (#645). The two keyed layers carry per-layer cap_per_{ip,peer} and pruning_per_{ip,peer} fields. The flags are deliberately split (not one shared) so a slow per-IP retain_recent sweep does not block a concurrent per-peer sweep — and vice versa.

Implementations§

Source§

impl ThreeLayerRateLimiter

Source

pub fn new( cfg: &RateLimitConfig, metrics: Arc<dyn RateLimitMetricsSink>, ) -> Self

Build a limiter from the resolved config snapshot and a metrics sink.

Source

pub fn check( &self, peer_node_id: &NodeId, peer_ip: Option<IpAddr>, ) -> Result<(), RejectLayer>

Try to admit one inbound request. peer_ip == None for relay-only connections — the per-IP layer is skipped (no key to charge), matching the ConnectionLimiter precedent at crate::dispatch::ConnectionLimiter::acquire.

On rejection, calls RateLimitMetricsSink::rejected with the layer that fired and returns it. No sink call on the success path.

Cheapest-first ordering (global → per-IP → per-peer): the first layer to reject short-circuits, so a per-peer-flooded request that would also have failed the global cap counts as global (the layer that actually drained the budget).

Source

pub fn admit_batch_extra( &self, peer_node_id: &NodeId, peer_ip: Option<IpAddr>, extra: usize, ) -> usize

Stage 2 of the two-stage batch admission (ADR 022 §Batch token accounting). After Self::check has charged the stage-1 frame token, this consumes up to extra (= n - 1 for a batch of n hashes) more units cheapest-first, each unit identical to what one separate StoreRequest admission would charge — so the per-second work ceiling is the same whether the publisher sends n separate Stores or one BatchStore of size n (ADR 022 AC 17).

Returns the number of extra units granted; the first 1 + returned hashes of the batch pass through per-hash processing, the remainder are acked false. Returns 0 when extra == 0 or the budget is already exhausted.

No rejection counter is bumped: the inbound frame was already admitted at stage 1, and the over-budget tail is deferred work the publisher retries, not a rejected request. Because the per-unit charge short-circuits cheapest-first, the terminating unit may consume a global (and per-IP) token without a per-peer token — byte-for-byte what the (k+1)-th separate Store would have done.

Source

pub fn gc_per_ip(&self) -> Option<(usize, usize)>

Periodic GC sweep for the per-IP keyed map (#645). Returns Some((before, after)) on a sweep that actually ran, or None when the per-IP layer is disabled or the single-flight CAS was lost to a concurrent prune (lazy or another GC tick). Mirrors crate::dispatch::ConnectionLimiter::gc_per_source.

Source

pub fn gc_per_peer(&self) -> Option<(usize, usize)>

Periodic GC sweep for the per-peer keyed map (#645). Sibling of Self::gc_per_ip.

Source

pub fn per_ip_tracked(&self) -> usize

Current tracked-key count for the per-IP keyed map (#645). 0 when the layer is disabled.

Source

pub fn per_peer_tracked(&self) -> usize

Current tracked-key count for the per-peer keyed map (#645).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more