Skip to main content

EventManager

Struct EventManager 

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

Publisher side of the cluster events channel.

EventManager is cheap to clone (the inner broadcast::Sender is reference-counted). Hand a clone or an std::sync::Arc handle to every component that needs to publish.

§Examples

use dynomite::events::EventManager;
let mgr = EventManager::new(8);
let _sub = mgr.subscribe();
assert_eq!(mgr.subscriber_count(), 1);

Implementations§

Source§

impl EventManager

Source

pub fn new(buffer: usize) -> Self

Build a fresh manager backed by a broadcast channel of the supplied capacity.

A capacity of zero is rejected by tokio; this constructor silently clamps it to one so embedding code does not have to special-case the empty value.

§Examples
use dynomite::events::EventManager;
let mgr = EventManager::new(64);
assert_eq!(mgr.subscriber_count(), 0);
Source

pub fn publish(&self, event: ClusterEvent)

Publish an event to every live subscriber.

Returns silently when there are no subscribers attached; tokio::sync::broadcast::Sender::send reports that case as Err(SendError(_)), which we explicitly drop because “no observers” is normal during quiet periods and is never the publisher’s problem.

§Examples
use std::time::SystemTime;
use dynomite::events::{ClusterEvent, EventManager};
let mgr = EventManager::new(4);
// No subscribers attached; publish is still infallible.
mgr.publish(ClusterEvent::RingChanged {
    tag: "init".into(),
    ts: SystemTime::now(),
});
Source

pub fn subscribe(&self) -> Subscriber

Subscribe a fresh receiver.

Each call returns an independent Subscriber whose queue starts empty; events published before the call are not delivered to the new subscriber.

§Examples
use dynomite::events::EventManager;
let mgr = EventManager::new(4);
let _a = mgr.subscribe();
let _b = mgr.subscribe();
assert_eq!(mgr.subscriber_count(), 2);
Source

pub fn subscriber_count(&self) -> usize

Number of attached subscribers.

Trait Implementations§

Source§

impl Clone for EventManager

Source§

fn clone(&self) -> EventManager

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 EventManager

Source§

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

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

impl Default for EventManager

Source§

fn default() -> Self

Build a manager with a 64-event buffer.

64 matches the default capacity of crate::embed::events::EventBus so embedders that swap one for the other do not see a surprise change in lag behaviour.

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> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,