Skip to main content

NotificationSystem

Struct NotificationSystem 

Source
pub struct NotificationSystem {
    pub notifier: Arc<EventNotifier>,
    pub registry: Arc<TargetRegistry>,
    pub config: Arc<RwLock<Config>>,
    /* private fields */
}
Expand description

The notification system that integrates all components

Fields§

§notifier: Arc<EventNotifier>

Event dispatcher. Runtime target mutation remains lifecycle-owned.

§registry: Arc<TargetRegistry>

Target factory registry. Creating a target does not publish it.

§config: Arc<RwLock<Config>>

The current cached configuration. Runtime publication must still go through the lifecycle methods on this type.

Implementations§

Source§

impl NotificationSystem

Source

pub fn new(config: Config) -> Self

Creates a new NotificationSystem

Source

pub async fn init(&self) -> Result<(), NotificationError>

Initializes the notification system

Source

pub async fn get_active_targets(&self) -> Vec<TargetID>

Gets a list of Targets for all currently active (initialized).

§Return

A Vec containing all active Targets TargetID.

Source

pub async fn config_snapshot(&self) -> Config

Source

pub async fn get_all_targets(&self) -> Arc<RwLock<TargetList>> ⓘ

Gets a read-only runtime container handle. Public mutation methods on TargetList are intentionally unavailable outside this crate.

Source

pub async fn get_target_values(&self) -> Vec<SharedTarget<Event>> ⓘ

Gets all Target values, including both active and inactive Targets.

§Return

A Vec containing all Targets.

Source

pub async fn has_subscriber(&self, bucket: &str, event: &EventName) -> bool

Checks if there are active subscribers for the given bucket and event name.

Source

pub fn has_live_listeners(&self) -> bool

Returns true when at least one in-process consumer is subscribed to live events.

Source

pub fn subscribe_live_events(&self) -> Receiver<Arc<Event>>

Subscribes to the in-process live event stream.

Source

pub async fn recent_live_events_since( &self, after_sequence: u64, limit: usize, ) -> LiveEventBatch

Source

pub async fn remove_target( &self, target_id: &TargetID, target_type: &str, ) -> Result<(), NotificationError>

Accurately remove a Target and its related resources through TargetID.

This process includes:

  1. Stop the event stream associated with the Target (if present).
  2. Remove the Target instance from the activity list of Notifier.
  3. Remove the configuration item of the Target from the system configuration.
§Parameters
  • target_id - The unique identifier of the Target to be removed.
§return

If successful, return Ok(()).

Source

pub async fn set_target_config( &self, target_type: &str, target_name: &str, kvs: KVS, ) -> Result<(), NotificationError>

Set or update a Target configuration. If the configuration is changed, the entire notification system will be automatically reloaded to apply the changes.

§Arguments
  • target_type - Target type, such as “notify_webhook” or “notify_mqtt”.
  • target_name - A unique name for a Target, such as “1”.
  • kvs - The full configuration of the Target.
§Returns

Result<(), NotificationError> If the target configuration is successfully set, it returns Ok(()). If the target configuration is invalid, it returns Err(NotificationError::Configuration).

Source

pub async fn remove_bucket_notification_config(&self, bucket: &str)

Removes all notification configurations for a bucket. If the configuration is successfully removed, the entire notification system will be automatically reloaded.

§Arguments
  • bucket - The name of the bucket whose notification configuration is to be removed.
Source

pub async fn remove_target_config( &self, target_type: &str, target_name: &str, ) -> Result<(), NotificationError>

Removes a Target configuration. If the configuration is successfully removed, the entire notification system will be automatically reloaded.

§Arguments
  • target_type - Target type, such as “notify_webhook” or “notify_mqtt”.
  • target_name - A unique name for a Target, such as “1”.
§Returns

Result<(), NotificationError>

If the target configuration is successfully removed, it returns Ok(()). If the target configuration does not exist, it returns Ok(()) without making any changes.

Source

pub async fn reload_config( &self, new_config: Config, ) -> Result<(), NotificationError>

Reloads the configuration

Source

pub fn publish_config( &self, new_config: Config, ) -> NotificationLifecycleTransition

Synchronously publishes a config generation without changing target mode.

Source

pub async fn reload_persisted_config(&self) -> Result<(), NotificationError>

Reconciles the cached and active configuration with the persisted server config without changing the target-runtime mode.

Source

pub async fn reload_persisted_config_from_store( &self, store: Arc<NotifyStore>, ) -> Result<(), NotificationError>

Reconciles from an explicitly selected storage context.

Source

pub async fn set_targets_enabled( &self, enabled: bool, config: Option<Config>, ) -> Result<(), NotificationError>

Enables or suspends configured notification targets without replacing the process-wide live-event container.

Source

pub fn publish_targets_enabled( &self, enabled: bool, config: Option<Config>, ) -> NotificationLifecycleTransition

Synchronously accepts a target-runtime mode transition. The returned receipt can be awaited after the caller releases its persistence lock.

Source

pub fn runtime_lifecycle_state(&self) -> NotificationRuntimeState

Source

pub fn runtime_lifecycle_is_converged(&self) -> bool

Returns whether the latest accepted lifecycle generation is active.

Source

pub async fn load_bucket_notification_config( &self, bucket: &str, cfg: &BucketNotificationConfig, ) -> Result<(), NotificationError>

Loads the bucket notification configuration

Source

pub async fn send_event(&self, event: Arc<Event>)

Sends an event

Source

pub fn get_status(&self) -> HashMap<String, String>

Obtain system status information

Source

pub fn snapshot_metrics(&self) -> NotificationMetricSnapshot

Source

pub async fn snapshot_target_metrics( &self, ) -> Vec<NotificationTargetMetricSnapshot>

Source

pub async fn snapshot_target_health(&self) -> Vec<RuntimeTargetHealthSnapshot>

Source

pub async fn runtime_status_snapshot(&self) -> RuntimeStatusSnapshot

Source

pub async fn shutdown(&self)

Source

pub async fn shutdown_checked(&self) -> Result<(), NotificationError>

Irreversibly terminates the notification target runtime for this process.

Trait Implementations§

Source§

impl Drop for NotificationSystem

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. 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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

Source§

fn compat(self) -> Compat<T> ⓘ
where T: Sized,

Applies the Compat adapter by value. Read more
Source§

fn compat_ref(&self) -> Compat<&T> ⓘ

Applies the Compat adapter by shared reference. Read more
Source§

fn compat_mut(&mut self) -> Compat<&mut T> ⓘ

Applies the Compat adapter by mutable reference. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromExt for T

Source§

fn from_<T>(t: T) -> Self
where Self: From<T>,

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

Source§

fn into_<T>(self) -> T
where Self: Into<T>,

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T> TryFromExt for T

Source§

fn try_from_<T>(t: T) -> Result<Self, Self::Error>
where Self: TryFrom<T>,

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

Source§

fn try_into_<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

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