Struct hotshot_task::task::ConsensusTaskRegistry

pub struct ConsensusTaskRegistry<EVENT> {
    task_handles: Vec<JoinHandle<Box<dyn TaskState<Event = EVENT>>>>,
}

A collection of tasks which can handle shutdown

Fields

task_handles: Vec<JoinHandle<Box<dyn TaskState<Event = EVENT>>>>

Tasks this registry controls

Implementations

impl<EVENT: Send + Sync + Clone + TaskEvent> ConsensusTaskRegistry<EVENT>

pub fn new() -> Self

Create a new task registry

pub fn register( &mut self, handle: JoinHandle<Box<dyn TaskState<Event = EVENT>>>, )

Add a task to the registry

pub async fn shutdown(&mut self)

Try to cancel/abort the task this registry has

Panics

Should not panic, unless awaiting on the JoinHandle in tokio fails.

pub fn run_task<S>(&mut self, task: Task<S>)

where S: TaskState<Event = EVENT> + Send + 'static,

Take a task, run it, and register it

pub async fn join_all(self) -> Vec<Box<dyn TaskState<Event = EVENT>>>

Wait for the results of all the tasks registered

Panics

Panics if one of the tasks panicked

Trait Implementations

impl<EVENT: Default> Default for ConsensusTaskRegistry<EVENT>

fn default() -> ConsensusTaskRegistry<EVENT>

Returns the “default value” for a type.