Struct jatsl::JobScheduler

pub struct JobScheduler { /* fields omitted */ }

Job and task lifecycle handler

Implementations

impl JobScheduler

pub fn spawn_task<T, F: 'static + Send, O: 'static + Send, Context>(
    task: &T,
    ctx: Context
) -> JoinHandle<Result<O, Aborted>> where
    F: Future<Output = O>,
    T: Fn(TaskManager<Context>) -> F, 

Run a new task with the given context on the default scheduler

This method makes the given future abortable and provides access to dependencies and terminates it if required dependencies become unavailable.

pub async fn spawn_job<J: 'static + Job + Send>(&self, job: J) -> Receiver<()>

Assigns a new job to the scheduler.

This method respawns the job if it crashes, provides access to dependencies, keeps track of its lifecycle and restarts it if dependencies become unavailable.

pub async fn terminate_job(&self, name: &String, grace_period: Duration)

Gracefully terminates a single job by name if supported, otherwise kill it with force.

pub async fn terminate_jobs(&self, grace_period: Duration)

Gracefully terminates all managed jobs that support it and kill all the others.

pub async fn wait_for_ready(&self)

Wait until all currently registered jobs report their status as ready.

Most useful when running complex tests which require jobs to be running in the background. Checks the status every 100ms, so you probably should not use this in “production” code.

Trait Implementations

impl Default for JobScheduler

fn default() -> JobScheduler

Returns the “default value” for a type.