Struct ThreadPoolExecutor 

pub struct ThreadPoolExecutor<ID: PartialEq> { /* private fields */ }

ThreadPool Executor

The ThreadPool Executor stores Nodes in a sorted vector and sends them to be executed by the threadPool.

Note: The ThreadPool Executor ca be interrupted by sending a true value over the mpsc channel whose receiving end is owned by the ThreadPool executor.

Addendum: The main thread of the ThreadPool is conducting the scheduling so the ThreadPool will only have n-1 worker threads where n is the total number of threads allocated to the threadpool executor.

Implementations

impl<ID: PartialEq> ThreadPoolExecutor<ID>

pub fn new(threads: usize, interrupt: Receiver<bool>) -> Self

Creates a new ThreadPool executor without any Nodes

pub fn new_with( threads: usize, interrupt: Receiver<bool>, nodes: Vec<Box<dyn Node<ID>>>, ) -> Self

Creates a new ThreadPool Executor with a number of Nodes

Trait Implementations

impl<ID: PartialEq + 'static> Executor<ID> for ThreadPoolExecutor<ID>

type Context = Box<dyn Any>

Context doesn’t really apply to Threadpool executors

fn start(&mut self)

For each node in the ThreadPool executor the node will be updated and start_instant will be set to the current instant

Note: this should probably not be called individually because it will always be called at the beginning of update_for_ms or update_loop

fn check_interrupt(&mut self) -> bool

Check the interrupt receiver for an interrupt

fn add_node(&mut self, node: Box<dyn Node<ID>>)

Add a node to the ThreadPool Executor.

Note: Nodes can only be added to the executor when it is not running.

Additionally, only 1 node can exist per id so additional nodes added with the same id will replace the previous node of a given id

fn remove_node(&mut self, id: &ID) -> Option<Box<dyn Node<ID>>>

Remove a node from the Threadpool Executor.

Note: Nodes can only be removed from hte executor when it is not running

fn update_for_ms(&mut self, ms: u128)

Run the update loop for a set amount of time (in milliseconds)

fn update_loop(&mut self)

Run the update loop until the executor’s interrupt is called

fn add_node_with_context( &mut self, node: Box<dyn Node<ID>>, _ctx: Self::Context, )

Add a node to the executor with some given context.