[−][src]Struct grin_util::StopState

pub struct StopState { /* fields omitted */ }

Global stopped/paused state shared across various subcomponents of Grin.

Arc<Mutex> allows the chain to lock the stop_state during critical processing. Other subcomponents cannot abruptly shutdown the server during block/header processing. This should prevent the chain ever ending up in an inconsistent state on restart.

"Stopped" allows a clean shutdown of the Grin server. "Paused" is used in some tests to allow nodes to reach steady state etc.

Methods

impl StopState[src]

pub fn new() -> StopState[src]

Create a new stop_state in default "running" state.

pub fn is_stopped(&self) -> bool[src]

Check if we are stopped.

pub fn is_paused(&self) -> bool[src]

Check if we are paused.

pub fn stop(&mut self)[src]

Stop the server.

pub fn pause(&mut self)[src]

Pause the server (only used in tests).

pub fn resume(&mut self)[src]

Resume a paused server (only used in tests).

Auto Trait Implementations

impl Send for StopState

impl Sync for StopState

Blanket Implementations

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, [src]

impl<T, U> TryFrom for T where
    U: Into<T>, [src]

type Error = !

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized, [src]

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> BorrowMut for T where
    T: ?Sized, [src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Erased for T

impl<T> UnsafeAny for T where
    T: Any,