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
impl NotificationSystem
Sourcepub async fn init(&self) -> Result<(), NotificationError>
pub async fn init(&self) -> Result<(), NotificationError>
Initializes the notification system
Sourcepub async fn get_active_targets(&self) -> Vec<TargetID>
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.
pub async fn config_snapshot(&self) -> Config
Sourcepub async fn get_all_targets(&self) -> Arc<RwLock<TargetList>> ⓘ
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.
Sourcepub async fn get_target_values(&self) -> Vec<SharedTarget<Event>> ⓘ
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.
Sourcepub async fn has_subscriber(&self, bucket: &str, event: &EventName) -> bool
pub async fn has_subscriber(&self, bucket: &str, event: &EventName) -> bool
Checks if there are active subscribers for the given bucket and event name.
Sourcepub fn has_live_listeners(&self) -> bool
pub fn has_live_listeners(&self) -> bool
Returns true when at least one in-process consumer is subscribed to live events.
Sourcepub fn subscribe_live_events(&self) -> Receiver<Arc<Event>>
pub fn subscribe_live_events(&self) -> Receiver<Arc<Event>>
Subscribes to the in-process live event stream.
pub async fn recent_live_events_since( &self, after_sequence: u64, limit: usize, ) -> LiveEventBatch
Sourcepub async fn remove_target(
&self,
target_id: &TargetID,
target_type: &str,
) -> Result<(), NotificationError>
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:
- Stop the event stream associated with the Target (if present).
- Remove the Target instance from the activity list of Notifier.
- 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(()).
Sourcepub async fn set_target_config(
&self,
target_type: &str,
target_name: &str,
kvs: KVS,
) -> Result<(), NotificationError>
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).
Sourcepub async fn remove_bucket_notification_config(&self, bucket: &str)
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.
Sourcepub async fn remove_target_config(
&self,
target_type: &str,
target_name: &str,
) -> Result<(), NotificationError>
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.
Sourcepub async fn reload_config(
&self,
new_config: Config,
) -> Result<(), NotificationError>
pub async fn reload_config( &self, new_config: Config, ) -> Result<(), NotificationError>
Reloads the configuration
Sourcepub fn publish_config(
&self,
new_config: Config,
) -> NotificationLifecycleTransition
pub fn publish_config( &self, new_config: Config, ) -> NotificationLifecycleTransition
Synchronously publishes a config generation without changing target mode.
Sourcepub async fn reload_persisted_config(&self) -> Result<(), NotificationError>
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.
Sourcepub async fn reload_persisted_config_from_store(
&self,
store: Arc<NotifyStore>,
) -> Result<(), NotificationError>
pub async fn reload_persisted_config_from_store( &self, store: Arc<NotifyStore>, ) -> Result<(), NotificationError>
Reconciles from an explicitly selected storage context.
Sourcepub async fn set_targets_enabled(
&self,
enabled: bool,
config: Option<Config>,
) -> Result<(), NotificationError>
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.
Sourcepub fn publish_targets_enabled(
&self,
enabled: bool,
config: Option<Config>,
) -> NotificationLifecycleTransition
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.
pub fn runtime_lifecycle_state(&self) -> NotificationRuntimeState
Sourcepub fn runtime_lifecycle_is_converged(&self) -> bool
pub fn runtime_lifecycle_is_converged(&self) -> bool
Returns whether the latest accepted lifecycle generation is active.
Sourcepub async fn validate_bucket_notification_config(
&self,
bucket: &str,
cfg: &BucketNotificationConfig,
) -> Result<(), NotificationError>
pub async fn validate_bucket_notification_config( &self, bucket: &str, cfg: &BucketNotificationConfig, ) -> Result<(), NotificationError>
Validates a bucket notification configuration against the runtime targets without publishing it, so callers can reject a request before persisting.
Sourcepub async fn load_bucket_notification_config(
&self,
bucket: &str,
cfg: &BucketNotificationConfig,
) -> Result<(), NotificationError>
pub async fn load_bucket_notification_config( &self, bucket: &str, cfg: &BucketNotificationConfig, ) -> Result<(), NotificationError>
Loads the bucket notification configuration
Sourcepub async fn send_event(&self, event: Arc<Event>)
pub async fn send_event(&self, event: Arc<Event>)
Sends an event
Sourcepub fn get_status(&self) -> HashMap<String, String>
pub fn get_status(&self) -> HashMap<String, String>
Obtain system status information
pub fn snapshot_metrics(&self) -> NotificationMetricSnapshot
pub async fn snapshot_target_metrics( &self, ) -> Vec<NotificationTargetMetricSnapshot>
pub async fn snapshot_target_health(&self) -> Vec<RuntimeTargetHealthSnapshot>
pub async fn runtime_status_snapshot(&self) -> RuntimeStatusSnapshot
pub async fn shutdown(&self)
Sourcepub async fn shutdown_checked(&self) -> Result<(), NotificationError>
pub async fn shutdown_checked(&self) -> Result<(), NotificationError>
Irreversibly terminates the notification target runtime for this process.
Trait Implementations§
Source§impl Drop for NotificationSystem
impl Drop for NotificationSystem
Auto Trait Implementations§
impl !RefUnwindSafe for NotificationSystem
impl !UnwindSafe for NotificationSystem
impl Freeze for NotificationSystem
impl Send for NotificationSystem
impl Sync for NotificationSystem
impl Unpin for NotificationSystem
impl UnsafeUnpin for NotificationSystem
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
Source§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::Request