Struct sc_service::SpawnTaskHandle

pub struct SpawnTaskHandle { /* private fields */ }

An handle for spawning tasks in the service.

Implementations

impl SpawnTaskHandle

pub fn spawn(
    &self,
    name: &'static str,
    group: impl Into<GroupName>,
    task: impl Future<Output = ()> + Send + 'static
)

Spawns the given task with the given name and a group name. If group is not specified DEFAULT_GROUP_NAME will be used.

Note that the name is a &'static str. The reason for this choice is that statistics about this task are getting reported to the Prometheus endpoint (if enabled), and that therefore the set of possible task names must be bounded.

In other words, it would be a bad idea for someone to do for example spawn(format!("{:?}", some_public_key)).

pub fn spawn_blocking(
    &self,
    name: &'static str,
    group: impl Into<GroupName>,
    task: impl Future<Output = ()> + Send + 'static
)

Spawns the blocking task with the given name. See also spawn.

Trait Implementations

impl Clone for SpawnTaskHandle

fn clone(&self) -> SpawnTaskHandle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl SpawnNamed for SpawnTaskHandle

fn spawn_blocking(
    &self,
    name: &'static str,
    group: Option<&'static str>,
    future: BoxFuture<'static, ()>
)

Spawn the given blocking future.

fn spawn(
    &self,
    name: &'static str,
    group: Option<&'static str>,
    future: BoxFuture<'static, ()>
)

Spawn the given non-blocking future.