Struct ModuleSubscriptions

pub struct ModuleSubscriptions { /* private fields */ }

Implementations

impl ModuleSubscriptions

pub fn new( relational_db: Arc<RelationalDB>, subscriptions: Arc<RwLock<SubscriptionManager>>, broadcast_queue: BroadcastQueue, owner_identity: Identity, ) -> Self

pub fn for_test_new_runtime( db: Arc<RelationalDB>, ) -> (ModuleSubscriptions, Runtime)

Construct a new ModuleSubscriptions for use in testing, creating a new tokio::runtime::Runtime to run its send worker.

pub fn for_test_enclosing_runtime(db: Arc<RelationalDB>) -> ModuleSubscriptions

Construct a new ModuleSubscriptions for use in testing, running its send worker on the dynamically enclosing tokio::runtime::Runtime

pub fn update_gauges(&self)

pub fn remove_gauges(&self)

pub fn add_single_subscription( &self, sender: Arc<ClientConnectionSender>, request: SubscribeSingle, timer: Instant, _assert: Option<Arc<dyn Fn(&Tx)>>, ) -> Result<Option<ExecutionMetrics>, DBError>

Add a subscription to a single query.

pub fn remove_single_subscription( &self, sender: Arc<ClientConnectionSender>, request: Unsubscribe, timer: Instant, ) -> Result<Option<ExecutionMetrics>, DBError>

Remove a subscription for a single query.

pub fn remove_multi_subscription( &self, sender: Arc<ClientConnectionSender>, request: UnsubscribeMulti, timer: Instant, ) -> Result<Option<ExecutionMetrics>, DBError>

Remove a client’s subscription for a set of queries.

pub fn send_client_message( &self, recipient: Arc<ClientConnectionSender>, message: impl Into<SerializableMessage>, _tx_id: &TxId, ) -> Result<(), BroadcastError>

Send a message to a client connection. This will eventually be sent by the send-worker. This takes a TxId, because this should be called while still holding a lock on the database.

pub fn add_multi_subscription( &self, sender: Arc<ClientConnectionSender>, request: SubscribeMulti, timer: Instant, _assert: Option<Arc<dyn Fn(&Tx)>>, ) -> Result<Option<ExecutionMetrics>, DBError>

pub fn add_legacy_subscriber( &self, sender: Arc<ClientConnectionSender>, subscription: Subscribe, timer: Instant, _assert: Option<Arc<dyn Fn(&Tx)>>, ) -> Result<ExecutionMetrics, DBError>

Add a subscriber to the module. NOTE: this function is blocking. This is used for the legacy subscription API which uses a set of queries.

pub fn remove_subscriber(&self, client_id: ClientActorId)

pub fn commit_and_broadcast_event( &self, caller: Option<Arc<ClientConnectionSender>>, event: ModuleEvent, tx: MutTx, ) -> Result<Result<(Arc<ModuleEvent>, ExecutionMetrics), WriteConflict>, DBError>

Commit a transaction and broadcast its ModuleEvent to all interested subscribers.

The returned ExecutionMetrics are reported in this method via report_tx_metrics. They are returned for testing purposes but should not be reported separately.

Trait Implementations

impl Clone for ModuleSubscriptions

fn clone(&self) -> ModuleSubscriptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleSubscriptions

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

Formats the value using the given formatter.