Struct RuntimeStatusHandle 

pub struct RuntimeStatusHandle { /* private fields */ }

Cloneable handle used by apps and background tasks to report health and readiness.

Implementations

impl RuntimeStatusHandle

pub fn report_health(&self, state: HealthState)

Report a new health state.

pub fn report_readiness(&self, state: ReadinessState)

Report a new readiness state.

Examples found in repository

examples/systemd_daemon.rs (line 66)

        async fn setup(
            &mut self,
            wora: &Wora<DaemonEvent, ()>,
            _exec: impl AsyncExecutor<DaemonEvent, ()>,
            _fs: impl WFS + 'static,
            _metrics: Sender<O11yEvent<()>>,
            _is_first_boot: bool,
        ) -> Result<Self::Setup, Box<dyn std::error::Error>> {
            let sender = wora.sender.clone();
            let status = wora.status_handle();
            let interval = Duration::from_millis(self.config.interval_ms.max(100));
            tokio::spawn(async move {
                status.report_readiness(ReadinessState::Ready);
                let mut ticker = tokio::time::interval(interval);
                loop {
                    ticker.tick().await;
                    if sender.send(Event::App(DaemonEvent::Tick)).await.is_err() {
                        break;
                    }
                }
            });
            Ok(())
        }

pub fn begin_draining(&self)

Transition the runtime into a draining state.

pub fn begin_stopping(&self)

Transition the runtime into a stopping state.

pub fn subscribe_health(&self) -> Receiver<HealthState>

Subscribe to health state changes.

pub fn subscribe_readiness(&self) -> Receiver<ReadinessState>

Subscribe to readiness state changes.

pub fn health_state(&self) -> HealthState

Return the latest reported health state.

pub fn readiness_state(&self) -> ReadinessState

Return the latest reported readiness state.

Trait Implementations

impl Clone for RuntimeStatusHandle

fn clone(&self) -> RuntimeStatusHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeStatusHandle

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

Formats the value using the given formatter.