Struct Signals

pub struct Signals(/* private fields */);

Abstraction over OS signals to handle the shutdown of the node smoothly.

On unix this represents SigInt and SigTerm.

Implementations

impl Signals

pub fn future(self) -> BoxFuture<'static, ()>

Return the signals future.

pub fn capture() -> Result<Self, ServiceError>

Capture the relevant signals to handle shutdown of the node smoothly.

Needs to be called in a Tokio context to have access to the tokio reactor.

pub fn dummy() -> Self

A dummy signal that never returns.

pub async fn run_until_signal<F, E>(self, func: F) -> Result<(), E>

where F: Future<Output = Result<(), E>> + FusedFuture, E: Error + Send + Sync + 'static,

Run a future task until receive a signal.

pub async fn try_until_signal<F, T>(self, func: F) -> Result<T, ()>

where F: Future<Output = T> + FusedFuture,

Execute the future task and returns it’s value if it completes before the signal.