Struct hotshot_task::task::Task

pub struct Task<S: TaskState> {
    state: S,
    sender: Sender<Arc<S::Event>>,
    receiver: Receiver<Arc<S::Event>>,
}

A basic task which loops waiting for events to come from event_receiver and then handles them using its state It sends events to other Tasks through sender This should be used as the primary building block for long running or medium running tasks (i.e. anything that can’t be described as a dependency task)

Fields

state: S

The state of the task. It is fed events from receiver and mutated via handle_event.

sender: Sender<Arc<S::Event>>

Sends events all tasks including itself

receiver: Receiver<Arc<S::Event>>

Receives events that are broadcast from any task, including itself

Implementations

impl<S: TaskState + Send + 'static> Task<S>

pub fn new( state: S, sender: Sender<Arc<S::Event>>, receiver: Receiver<Arc<S::Event>>, ) -> Self

Create a new task

fn boxed_state(self) -> Box<dyn TaskState<Event = S::Event>>

The state of the task, as a boxed dynamic trait object.

pub fn run(self) -> JoinHandle<Box<dyn TaskState<Event = S::Event>>>

Spawn the task loop, consuming self. Will continue until the task reaches some shutdown condition