Skip to main content

HealthMonitor

Struct HealthMonitor 

Source
pub struct HealthMonitor<T: HealthReportSender> { /* private fields */ }
Expand description

A runtime health monitoring service.

The HealthMonitor tracks client health statuses by processing events such as connections, disconnections, and connection losses. It periodically checks client states and sends health reports using the configured HealthReportSender.

Implementations§

Source§

impl<T: HealthReportSender> HealthMonitor<T>

Source

pub async fn listen(&mut self)

Starts the health monitoring event loop.

This async method continuously listens for incoming events, periodic checks, and reminders. It processes client health updates based on received events and predefined timing intervals.

The loop will run until the event stream is closed or an exit condition is met.

§Behavior
  • Sends the initial health report immediately upon start.
  • Periodically checks client health status every check_interval.
  • Sends reminder reports every reminder_interval if any clients are not healthy.
  • Processes events received from the event receiver to update client states.

Trait Implementations§

Source§

impl<T: Debug + HealthReportSender> Debug for HealthMonitor<T>

Source§

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

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

impl<T: HealthReportSender + Send + Sync + 'static> IntoSubsystem<NeverError> for HealthMonitor<T>

Available on crate feature tokio-graceful-shutdown only.
Source§

async fn run(self, subsys: &mut SubsystemHandle) -> Result<(), NeverError>

The logic of the subsystem. Read more
Source§

fn into_subsystem( self, ) -> impl FnOnce(&mut SubsystemHandle<ErrWrapper>) -> Pin<Box<dyn Future<Output = Result<(), Err>> + Send + '_>>

Converts the object into a type that can be passed into SubsystemHandle::start().

Auto Trait Implementations§

§

impl<T> Freeze for HealthMonitor<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for HealthMonitor<T>
where T: RefUnwindSafe,

§

impl<T> Send for HealthMonitor<T>
where T: Send,

§

impl<T> Sync for HealthMonitor<T>
where T: Sync,

§

impl<T> Unpin for HealthMonitor<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for HealthMonitor<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for HealthMonitor<T>
where T: UnwindSafe,

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

Source§

const ACK_1_1_0: bool = true

Whether this implementor has acknowledged the 1.1.0 update to unerase’s documented implementation requirements. Read more
Source§

unsafe fn unerase(this: NonNull<Erased>) -> NonNull<T>

Unerase this erased pointer. Read more
Source§

fn erase(this: NonNull<Self>) -> NonNull<Erased>

Turn this erasable pointer into an erased pointer. 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> 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> 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<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