Skip to main content

RealtimeConfig

Struct RealtimeConfig 

Source
#[non_exhaustive]
pub struct RealtimeConfig { pub max_concurrent_reexecutions: usize, pub resync_interval: DurationStr, pub postgres_change_buffer_size: usize, pub debounce_quiet_window: DurationStr, pub debounce_max_wait: DurationStr, pub sse_max_sessions: usize, pub subscription_max_per_session: usize, pub shard_count: usize, pub max_sessions_per_user: usize, pub max_sessions_per_ip: usize, pub max_subscriptions_per_user: usize, pub max_cached_result_bytes: usize, }
Expand description

Configuration for the real-time subscription engine and SSE transport.

All fields have production-safe defaults; only set these to tune behaviour.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§max_concurrent_reexecutions: usize

Maximum concurrent query re-executions during an invalidation flush.

§resync_interval: DurationStr

Periodic resync interval. Re-evaluates every active query group to recover from dropped NOTIFY payloads. “0s” disables the sweep (e.g. “60s”, “5m”).

§postgres_change_buffer_size: usize

Broadcast channel buffer for raw change notifications from PG.

§debounce_quiet_window: DurationStr

Debounce quiet window duration. Changes arriving within this window are coalesced into a single flush (e.g. “50ms”, “100ms”).

§debounce_max_wait: DurationStr

Absolute maximum debounce wait before forcing a flush (e.g. “200ms”, “1s”).

§sse_max_sessions: usize

Maximum concurrent SSE sessions across all clients.

§subscription_max_per_session: usize

Maximum subscriptions per SSE session.

§shard_count: usize

Number of DashMap shards for the subscription manager. Higher values reduce lock contention at the cost of memory.

§max_sessions_per_user: usize

Maximum concurrent SSE sessions per authenticated user.

Interacts with subscription_max_per_session and max_subscriptions_per_user: the effective per-user subscription cap is min(max_subscriptions_per_user, max_sessions_per_user * subscription_max_per_session). With defaults (10 sessions, 100 per session, 500 global), the cap is 500.

§max_sessions_per_ip: usize

Maximum concurrent SSE sessions per source IP.

§max_subscriptions_per_user: usize

Cap on a user’s total subscriptions across every active session.

Global per-user cap across all sessions. With max_sessions_per_user=10 and subscription_max_per_session=100, the effective per-user cap is min(500, 10*100) = 500. Lowering this below max_sessions_per_user * subscription_max_per_session enforces a tighter global ceiling regardless of how subscriptions are distributed.

§max_cached_result_bytes: usize

Per-query cached-result memory ceiling (bytes). Cached results exceeding this size are dropped after re-execution.

Trait Implementations§

Source§

impl Clone for RealtimeConfig

Source§

fn clone(&self) -> RealtimeConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RealtimeConfig

Source§

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

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

impl Default for RealtimeConfig

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for RealtimeConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for RealtimeConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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> 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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,