Struct sc_service::SpawnTaskHandle

pub struct SpawnTaskHandle { /* fields omitted */ }

An handle for spawning tasks in the service.

Implementations

impl SpawnTaskHandle

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

Spawns the given task with the given name.

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,
    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 CloneableSpawn for SpawnTaskHandle

fn clone(&self) -> Box<dyn CloneableSpawn>

Clone as heap-allocated handle.

impl Executor<Box<dyn Future<Item = (), Error = ()> + 'static + Send>> for SpawnTaskHandle

fn execute(
    &self,
    future: Box<dyn Future<Item = (), Error = ()> + Send + 'static>
) -> Result<(), ExecuteError<Box<dyn Future<Item = (), Error = ()> + Send + 'static>>>

Spawns a future to run on this Executor, typically in the "background".

impl Spawn for SpawnTaskHandle

fn spawn_obj(&self, future: FutureObj<'static, ()>) -> Result<(), SpawnError>

Spawns a future that will be run to completion.

fn status(&self) -> Result<(), SpawnError>

Determines whether the executor is able to spawn new tasks.

impl SpawnBlocking for SpawnTaskHandle

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

Spawn the given blocking future.