Enum Timer

pub enum Timer<P>
where
    P: Send + Sync + 'static,
{
    Interval {
        selector: String,
        context: Context<P>,
        activation_state: OperationState,
        callback: ArcTimerCallback<P>,
        interval: Duration,
        handle: Mutex<Option<JoinHandle<()>>>,
    },
    DelayedInterval {
        selector: String,
        context: Context<P>,
        activation_state: OperationState,
        callback: ArcTimerCallback<P>,
        interval: Duration,
        delay: Duration,
        handle: Mutex<Option<JoinHandle<()>>>,
    },
}

Timer

Variants

Interval

A Timer with an Interval

Fields

selector: String

The Timers ID

context: Context<P>

Context for the Timer

activation_state: OperationState

OperationState on which this timer is started

callback: ArcTimerCallback<P>

Timers Callback function called, when Timer is fired

interval: Duration

The interval in which the Timer is fired

handle: Mutex<Option<JoinHandle<()>>>

The handle to stop the Timer

DelayedInterval

A delayed Timer with an Interval

Fields

selector: String

The Timers ID

context: Context<P>

Context for the Timer

activation_state: OperationState

OperationState on which this timer is started

callback: ArcTimerCallback<P>

Timers Callback function called, when Timer is fired

interval: Duration

The interval in which the Timer is fired

delay: Duration

The delay after which the first firing of the Timer happenes

handle: Mutex<Option<JoinHandle<()>>>

The handle to stop the Timer

Implementations

impl<P> Timer<P>

where P: Send + Sync + 'static,

pub fn new( name: String, context: Context<P>, activation_state: OperationState, callback: ArcTimerCallback<P>, interval: Duration, delay: Option<Duration>, ) -> Self

Constructor for a Timer

Trait Implementations

impl<P> Capability for Timer<P>

where P: Send + Sync + 'static,

fn manage_operation_state(&self, state: &OperationState) -> Result<()>

Checks whether state of capability component is appropriate for the given OperationState. If not, implementation has to adjusts components state to needs.

impl<P> Debug for Timer<P>

where P: Send + Sync + 'static,

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

Formats the value using the given formatter.