Struct sc_service::TaskManager

pub struct TaskManager { /* private fields */ }

Helper struct to manage background/async tasks in Service.

Implementations

impl TaskManager

pub fn new( tokio_handle: Handle, prometheus_registry: Option<&Registry> ) -> Result<Self, PrometheusError>

If a Prometheus registry is passed, it will be used to report statistics about the service tasks.

pub fn spawn_handle(&self) -> SpawnTaskHandle

Get a handle for spawning tasks.

pub fn spawn_essential_handle(&self) -> SpawnEssentialTaskHandle

Get a handle for spawning essential tasks.

pub fn future<'a>( &'a mut self ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'a>>

Return a future that will end with success if the signal to terminate was sent (self.terminate()) or with an error if an essential task fails.

Warning

This function will not wait until the end of the remaining task.

pub fn keep_alive<T: 'static + Send>(&mut self, to_keep_alive: T)

Set what the task manager should keep alive, can be called multiple times.

pub fn add_child(&mut self, child: TaskManager)

Register another TaskManager to terminate and gracefully shutdown when the parent terminates and gracefully shutdown. Also ends the parent future() if a child’s essential task fails. (But don’t end the parent if a child’s normal task fails.)

pub fn into_task_registry(self) -> TaskRegistry

Consume self and return the TaskRegistry.

This TaskRegistry can be used to check for still running tasks after this task manager was dropped.