Skip to main content

SubscriptionManager

Struct SubscriptionManager 

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

Manages active subscriptions and event routing.

The SubscriptionManager is the central hub for:

  • Tracking active subscriptions per connection
  • Receiving events from database listeners
  • Matching events to subscriptions
  • Broadcasting to transport adapters

Implementations§

Source§

impl SubscriptionManager

Source

pub fn new(schema: Arc<CompiledSchema>) -> Self

Create a new subscription manager.

§Arguments
  • schema - Compiled schema containing subscription definitions
  • channel_capacity - Broadcast channel capacity (default: 1024)
Source

pub fn with_capacity( schema: Arc<CompiledSchema>, channel_capacity: usize, ) -> Self

Create a new subscription manager with custom channel capacity.

Source

pub fn receiver(&self) -> Receiver<SubscriptionPayload>

Get a receiver for subscription payloads.

Transport adapters use this to receive events for delivery.

Source

pub fn subscribe( &self, subscription_name: &str, user_context: Value, variables: Value, connection_id: &str, ) -> Result<SubscriptionId, SubscriptionError>

Subscribe to a subscription type.

§Arguments
  • subscription_name - Name of the subscription type
  • user_context - User authentication/authorization context
  • variables - Runtime variables from client
  • connection_id - Client connection identifier
§Errors

Returns error if subscription not found or user not authorized.

Source

pub fn unsubscribe(&self, id: SubscriptionId) -> Result<(), SubscriptionError>

Unsubscribe from a subscription.

§Errors

Returns error if subscription not found.

Source

pub fn unsubscribe_connection(&self, connection_id: &str)

Unsubscribe all subscriptions for a connection.

Called when a client disconnects.

Source

pub fn get_subscription(&self, id: SubscriptionId) -> Option<ActiveSubscription>

Get an active subscription by ID.

Source

pub fn get_connection_subscriptions( &self, connection_id: &str, ) -> Vec<ActiveSubscription>

Get all active subscriptions for a connection.

Source

pub fn subscription_count(&self) -> usize

Get total number of active subscriptions.

Source

pub fn connection_count(&self) -> usize

Get number of active connections with subscriptions.

Source

pub fn publish_event(&self, event: SubscriptionEvent) -> usize

Publish an event to matching subscriptions.

This is called by the database listener when an event is received. The event is matched against all active subscriptions and delivered to matching ones.

§Arguments
  • event - The database event to publish
§Returns

Number of subscriptions that matched the event.

Trait Implementations§

Source§

impl Debug for SubscriptionManager

Source§

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

Formats the value using the given formatter. 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> 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, 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