Skip to main content

RateLimitConfig

Struct RateLimitConfig 

Source
pub struct RateLimitConfig {
    pub max_connections_per_ip: Option<usize>,
    pub max_connections_per_metering_key: Option<usize>,
    pub max_connections_per_origin: Option<usize>,
    pub client_timeout: Duration,
    pub message_queue_size: usize,
    pub max_reconnect_attempts: Option<u32>,
    pub message_rate_window: Duration,
    pub egress_rate_window: Duration,
    pub default_limits: Option<Limits>,
}
Expand description

Configuration for rate limiting in ClientManager

These settings control various rate limits at the connection level. Per-subject limits are controlled via AuthContext.Limits.

Fields§

§max_connections_per_ip: Option<usize>

Global maximum connections per IP address

§max_connections_per_metering_key: Option<usize>

Global maximum connections per metering key

§max_connections_per_origin: Option<usize>

Global maximum connections per origin

§client_timeout: Duration

Default connection timeout for stale client cleanup

§message_queue_size: usize

Message queue size per client

§max_reconnect_attempts: Option<u32>

Maximum reconnect attempts per client (optional global default)

§message_rate_window: Duration

Rate limit window duration for message counting

§egress_rate_window: Duration

Rate limit window duration for egress tracking

§default_limits: Option<Limits>

Default limits applied when auth token doesn’t specify limits These act as server-wide fallback limits for all connections

Implementations§

Source§

impl RateLimitConfig

Source

pub fn from_env() -> Self

Load configuration from environment variables

Environment variables:

  • HYPERSTACK_WS_MAX_CONNECTIONS_PER_IP - Max connections per IP (default: unlimited)
  • HYPERSTACK_WS_MAX_CONNECTIONS_PER_METERING_KEY - Max connections per metering key (default: unlimited)
  • HYPERSTACK_WS_MAX_CONNECTIONS_PER_ORIGIN - Max connections per origin (default: unlimited)
  • HYPERSTACK_WS_CLIENT_TIMEOUT_SECS - Client timeout in seconds (default: 300)
  • HYPERSTACK_WS_MESSAGE_QUEUE_SIZE - Message queue size per client (default: 512)
  • HYPERSTACK_WS_RATE_LIMIT_WINDOW_SECS - Rate limit window in seconds (default: 60)
  • HYPERSTACK_WS_DEFAULT_MAX_CONNECTIONS - Default max connections per subject (fallback when token has no limit)
  • HYPERSTACK_WS_DEFAULT_MAX_SUBSCRIPTIONS - Default max subscriptions per connection (fallback when token has no limit)
  • HYPERSTACK_WS_DEFAULT_MAX_SNAPSHOT_ROWS - Default max snapshot rows per request (fallback when token has no limit)
  • HYPERSTACK_WS_DEFAULT_MAX_MESSAGES_PER_MINUTE - Default max messages per minute (fallback when token has no limit)
  • HYPERSTACK_WS_DEFAULT_MAX_BYTES_PER_MINUTE - Default max bytes per minute (fallback when token has no limit)
Source

pub fn with_max_connections_per_ip(self, max: usize) -> Self

Set the maximum connections per IP

Source

pub fn with_timeout(self, timeout: Duration) -> Self

Set the client timeout

Source

pub fn with_message_queue_size(self, size: usize) -> Self

Set the message queue size

Source

pub fn with_rate_limit_window(self, window: Duration) -> Self

Set the rate limit window (applies to both message and egress windows)

Source

pub fn with_default_limits(self, limits: Limits) -> Self

Set default limits applied when auth token doesn’t specify limits

These limits act as server-wide fallbacks for connections where the authentication token doesn’t include explicit limits.

Trait Implementations§

Source§

impl Clone for RateLimitConfig

Source§

fn clone(&self) -> RateLimitConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RateLimitConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RateLimitConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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