Struct tap::task_scheduler::TaskScheduler

pub struct TaskScheduler { /* private fields */ }

The scheduler is in charge of running Task (plugin instance and argument).

Implementations

impl TaskScheduler

Provide different method to run, schedule and create new task.

pub fn new(tree: Tree) -> Self

Instantiate a new scheduler.

pub fn schedule(
    &self,
    plugin: Box<dyn PluginInstance + Sync + Send>,
    argument: PluginArgument,
    relaunch: bool
) -> Result<TaskId, Error>

Create a new task and schedule it to be launched, return a task id or an error if task already exist.

pub fn run(
    &self,
    plugin: Box<dyn PluginInstance + Sync + Send>,
    argument: PluginArgument,
    relaunch: bool
) -> Result<PluginResult, Arc<Error>>

Create a new task and block until the task is finished, return a plugin result or an error, if task exist or if execution of the task failed.

pub fn tasks_are_finished(&self) -> bool

Check if all task in the tasks map are finished.

pub fn join(&self)

Wait until all scheduled task are finished.

pub fn task(&self, id: TaskId) -> Option<TaskState>

Return a TaskState corresponding to a task id.

pub fn tasks(&self, ids: Vec<TaskId>) -> Vec<TaskState>

Return a vec of TaskState for corresponding task id.

pub fn to_vec(&self) -> Vec<TaskState>

Return a copy of all the task state for all task in the tasks map.

pub fn task_count(&self) -> u32

Return the current count of tasks added to the scheduler.

pub fn tasks_finished(&self) -> Vec<(Task, TaskResult)>

Return all finished task and their result.