Skip to main content

WatchdogConfig

Struct WatchdogConfig 

Source
pub struct WatchdogConfig {
    pub threshold: Duration,
    pub heartbeat_interval: Duration,
    pub poll_interval: Duration,
    pub on_stall: Option<StallCallback>,
    pub emit_event: bool,
}

Fields§

§threshold: Duration

A heartbeat older than this is a stall.

§heartbeat_interval: Duration

How often the main thread is pinged. The floor is 10 ms.

§poll_interval: Duration

The shortest the watchdog thread waits between two looks at the heartbeat, which bounds how late a stall is reported past the threshold. Default 250 ms; the floor is 10 ms. The thread no longer polls at this rate: idle it sleeps until the last beat plus the threshold can have passed, so a larger value only widens the allowed lateness and a smaller one only shrinks it.

§on_stall: Option<StallCallback>

Called once per stall episode with the stall duration (see StallReport::stalled_ms), on the watchdog thread. A host can use it to write a hang dump. It runs before the rightkit-shell://stall event.

§emit_event: bool

Also emit the rightkit-shell://stall event to the webview. Default true.

Hazard: the event is emitted from the watchdog thread through the AppHandle, and that thread exists to observe an app that may be deadlocked. Emitting takes app-side locks, so a deadlock in the app can stop the watchdog thread too, at the moment its report matters most. Set false for callback-only mode: the poll thread then touches only std atomics and on_stall (it is not even given an AppHandle). A failed emit never ends the loop in either mode; it is counted in WatchdogStatus::emit_failures.

Trait Implementations§

Source§

impl Clone for WatchdogConfig

Source§

fn clone(&self) -> Self

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 Default for WatchdogConfig

Source§

fn default() -> Self

Returns the “default value” for a type. 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<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, 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> 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 = !

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

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

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.