Struct tap::session::Session

pub struct Session {
    pub plugins_db: PluginsDB,
    pub tree: Tree,
    pub task_scheduler: TaskScheduler,
}

Contain instances of structure needed by TAP.

Fields

plugins_db: PluginsDB

A PluginsDB instance

tree: Tree

A Tree instance

task_scheduler: TaskScheduler

A TaskScheduler instance

Implementations

impl Session

pub fn new() -> Session

Return a new Session

pub fn clear(&mut self)

Replace tree and task_scheduler by a new intance.

pub fn schedule(
    &self,
    plugin_name: &str,
    argument: PluginArgument,
    relaunch: bool
) -> Result<TaskId, Error>

Create a crate::plugin::PluginInstance from plugin_name and argument add it to the scheduler and return it’s task id.

pub fn run(
    &self,
    plugin_name: &str,
    argument: PluginArgument,
    relaunch: bool
) -> Result<PluginResult, Arc<Error>>

Create a crate::plugin::PluginInstance, add it to an available worker, wait for it to be executed and return the results. This function is blocking the TaskScheduler, so must be avoided in multithreaded code.

pub fn join(&self)

Join on all scheduled task. This function is blocking the TaskScheduler, so must be avoided in multithreaded code.

Trait Implementations

impl Default for Session

fn default() -> Self

Returns the “default value” for a type.