Struct meio::task::HeartBeat

pub struct HeartBeat { /* fields omitted */ }

The lite task that sends ticks to a Recipient.

Implementations

impl HeartBeat

pub fn new<T>(duration: Duration, address: Address<T>) -> Self where
    T: Actor + ActionHandler<Tick>, 

Creates a new HeartBeat lite task.

Trait Implementations

impl Debug for HeartBeat

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl LiteTask for HeartBeat

type Output = ()

The result of a finished task.

fn repeatable_routine<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<Option<Self::Output>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Routine that will be repeated till fail or success.

fn retry_delay(&self, _last_attempt: Instant) -> Duration

How long to wait to retry. Called by retry_at method.

fn name(&self) -> String

Returns unique name of the LiteTask. Uses Uuid by default.

#[must_use]fn routine<'async_trait>(
    self,
    stop: StopReceiver
) -> Pin<Box<dyn Future<Output = Result<Self::Output, Error>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Routine of the task that can contain loops. It can taks into accout provided receiver to implement graceful interruption.

#[must_use]fn interruptable_routine<'async_trait>(
    self
) -> Pin<Box<dyn Future<Output = Result<Self::Output, Error>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Routine that can be unconditionally interrupted.

fn retry_at(&self, _last_attempt: Instant) -> Instant

When to do the next attempt for repeatable_routine.

impl<T> TaskEliminated<HeartBeat> for T where
    T: OnTick, 

fn handle<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    _id: IdOf<HeartBeat>,
    _result: Result<(), TaskError>,
    ctx: &'life1 mut Context<Self>
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Called when the Task finished.