Struct ConnectUdpLimits 

pub struct ConnectUdpLimits<X = UserOrClientIpKey, K = PrincipalKey> { /* private fields */ }

Available on crate feature masque only.

How many CONNECT-UDP tunnels a proxy runs: in total and per principal.

A principal is the key the keyer X derives from a CONNECT-UDP request (InputToRateKey, closures included): by default UserOrClientIpKey; rama-net’s ClientIpRateKey keys by client IP alone (ConnectUdpLimits::with_keyer), and any keyer can derive its own key type, such as a tenant ID, from the request’s headers and extensions. The keyer is asked only when a per-principal limit or budget is set, as nothing else needs a principal; then a request it yields no key for, or fails on, is refused.

A tunnel takes its place before the proxy resolves or connects anything and holds it until it ends, however it ends. Clones share the places, so every clone of a ConnectUdpService counts against the same limits.

Principals are tracked only when a per-principal limit or budget is set, in a map of at most ConnectUdpLimits::with_max_principals entries. An entry is dropped only once no tunnel holds it, it has been idle for ConnectUdpLimits::with_principal_idle_timeout or for as long as its PrincipalBudget rates take to refill if that is longer, and its quota window has ended; while the map is full of entries that cannot be dropped, tunnels of a new principal are refused rather than letting a principal start over.

Implementations

impl ConnectUdpLimits

pub fn new() -> ConnectUdpLimits

No limits: every tunnel is admitted, and principals are not tracked. Principals are keyed by UserOrClientIpKey once a per-principal limit is set.

impl<X, K> ConnectUdpLimits<X, K>

pub fn with_keyer<X2>( self, keyer: X2, ) -> ConnectUdpLimits<X2, <X2 as InputToRateKey<Request>>::Key>

where X2: InputToRateKey<Request>,

Key principals with keyer instead, from each CONNECT-UDP request.

pub fn maybe_with_max_tunnels( self, max: Option<usize>, ) -> ConnectUdpLimits<X, K>

The most tunnels the proxy runs at once.

pub fn maybe_set_max_tunnels( &mut self, max: Option<usize>, ) -> &mut ConnectUdpLimits<X, K>

The most tunnels the proxy runs at once.

pub fn with_max_tunnels(self, max: usize) -> ConnectUdpLimits<X, K>

The most tunnels the proxy runs at once.

pub fn set_max_tunnels(&mut self, max: usize) -> &mut ConnectUdpLimits<X, K>

The most tunnels the proxy runs at once.

pub fn without_max_tunnels(self) -> ConnectUdpLimits<X, K>

The most tunnels the proxy runs at once.

pub fn unset_max_tunnels(&mut self) -> &mut ConnectUdpLimits<X, K>

The most tunnels the proxy runs at once.

pub fn maybe_with_max_tunnels_per_principal( self, max: Option<usize>, ) -> ConnectUdpLimits<X, K>

The most tunnels one principal runs at once.

pub fn maybe_set_max_tunnels_per_principal( &mut self, max: Option<usize>, ) -> &mut ConnectUdpLimits<X, K>

The most tunnels one principal runs at once.

pub fn with_max_tunnels_per_principal( self, max: usize, ) -> ConnectUdpLimits<X, K>

The most tunnels one principal runs at once.

pub fn set_max_tunnels_per_principal( &mut self, max: usize, ) -> &mut ConnectUdpLimits<X, K>

The most tunnels one principal runs at once.

pub fn without_max_tunnels_per_principal(self) -> ConnectUdpLimits<X, K>

The most tunnels one principal runs at once.

pub fn unset_max_tunnels_per_principal(&mut self) -> &mut ConnectUdpLimits<X, K>

The most tunnels one principal runs at once.

pub fn with_max_principals(self, max: usize) -> ConnectUdpLimits<X, K>

The most principals tracked at once (default 65 536).

pub fn set_max_principals(&mut self, max: usize) -> &mut ConnectUdpLimits<X, K>

The most principals tracked at once (default 65 536).

pub fn with_principal_idle_timeout( self, timeout: Duration, ) -> ConnectUdpLimits<X, K>

How long a principal without tunnels stays tracked (default one minute).

pub fn set_principal_idle_timeout( &mut self, timeout: Duration, ) -> &mut ConnectUdpLimits<X, K>

How long a principal without tunnels stays tracked (default one minute).

pub fn maybe_with_principal_budget( self, budget: Option<PrincipalBudget>, ) -> ConnectUdpLimits<X, K>

What all the tunnels of one principal may move together.

pub fn maybe_set_principal_budget( &mut self, budget: Option<PrincipalBudget>, ) -> &mut ConnectUdpLimits<X, K>

What all the tunnels of one principal may move together.

pub fn with_principal_budget( self, budget: PrincipalBudget, ) -> ConnectUdpLimits<X, K>

What all the tunnels of one principal may move together.

pub fn set_principal_budget( &mut self, budget: PrincipalBudget, ) -> &mut ConnectUdpLimits<X, K>

What all the tunnels of one principal may move together.

pub fn without_principal_budget(self) -> ConnectUdpLimits<X, K>

What all the tunnels of one principal may move together.

pub fn unset_principal_budget(&mut self) -> &mut ConnectUdpLimits<X, K>

What all the tunnels of one principal may move together.

pub fn live_tunnels(&self) -> usize

The tunnels running now.

pub fn tracked_principals(&self) -> usize

The principals tracked now.

pub fn try_acquire( &self, principal: K, ) -> Result<TunnelLease, TunnelLimitReached>

where K: RateKey,

Take a tunnel’s place for principal, held until the returned lease drops.

Trait Implementations

impl<X, K> Clone for ConnectUdpLimits<X, K>

fn clone(&self) -> ConnectUdpLimits<X, K>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<X, K> Debug for ConnectUdpLimits<X, K>

where X: Debug,

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

Formats the value using the given formatter.

impl Default for ConnectUdpLimits

fn default() -> ConnectUdpLimits

Returns the “default value” for a type.