Struct ibc_relayer::util::task::TaskHandle

pub struct TaskHandle { /* private fields */ }

A task handle holds the endpoints for stopping or waiting for a background task to terminate.

A holder of TaskHandle can explicitly stop the background task by calling shutdown or shutdown_and_wait.

Otherwise, when the TaskHandle is dropped, it will stop the background task and wait for the background task to terminate before returning.

Implementations

impl TaskHandle

pub fn join(self)

Wait for the background task to terminate.

Note that because the background tasks are meant to run forever, this would likely never return unless errors occurred or if the step runner returns Next::Abort to abort prematurely.

pub fn shutdown(&self)

Send the shutdown signal to the background task without waiting for it to terminate.

Note that the waiting will still happen when the TaskHandle is dropped.

This can be used to shutdown multiple tasks in parallel, and then wait for them to all terminate concurrently.

pub fn shutdown_and_wait(self)

Send the shutdown signal and wait for the task to terminate.

This is done implicitly by the TaskHandle when it is dropped.

pub fn is_stopped(&self) -> bool

Check whether a background task has been stopped prematurely.

Trait Implementations

impl Drop for TaskHandle

fn drop(&mut self)

Executes the destructor for this type.