Struct sc_service::TaskManager[][src]

pub struct TaskManager { /* fields omitted */ }

Helper struct to manage background/async tasks in Service.


impl TaskManager[src]

pub fn new(
    executor: TaskExecutor,
    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[src]

Get a handle for spawning tasks.

pub fn spawn_essential_handle(&self) -> SpawnEssentialTaskHandle[src]

Get a handle for spawning essential tasks.

pub fn clean_shutdown(self) -> Pin<Box<dyn Future<Output = ()> + Send>>[src]

Send the signal for termination, prevent new tasks to be created, await for all the existing tasks to be finished and drop the object. You can consider this as an async drop.

It’s always better to call and await this function before exiting the process as background tasks may be running in the background. If the process exit and the background tasks are not cancelled, this will lead to objects not getting dropped properly.

This is an issue in some cases as some of our dependencies do require that we drop all the objects properly otherwise it triggers a SIGABRT on exit.

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.


This function will not wait until the end of the remaining task. You must call and await clean_shutdown() after this.

pub fn terminate(&mut self)[src]

Signal to terminate all the running tasks.

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

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

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

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.)

Auto Trait Implementations

impl !RefUnwindSafe for TaskManager

impl Send for TaskManager

impl !Sync for TaskManager

impl Unpin for TaskManager

impl !UnwindSafe for TaskManager

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> CheckedConversion for T[src]

impl<T> Downcast for T where
    T: Any

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T, Outer> IsWrappedBy<Outer> for T where
    T: From<Outer>,
    Outer: AsRef<T> + AsMut<T> + From<T>, 

pub fn from_ref(outer: &Outer) -> &T[src]

Get a reference to the inner from the outer.

pub fn from_mut(outer: &mut Outer) -> &mut T[src]

Get a mutable reference to the inner from the outer.

impl<T> Pointable for T[src]

type Init = T

The type for initializers.

impl<T> Same<T> for T[src]

type Output = T

Should always be Self

impl<T> SaturatedConversion for T[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

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

The type returned in the event of a conversion error.

impl<S, T> UncheckedInto<T> for S where
    T: UncheckedFrom<S>, 

impl<T, S> UniqueSaturatedInto<T> for S where
    T: Bounded,
    S: TryInto<T>, 

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

impl<T> WithSubscriber for T[src]

impl<T> Erased for T[src]