Struct delay_timer::entity::DelayTimer

pub struct DelayTimer { /* fields omitted */ }

DelayTimer is an abstraction layer that helps users solve execution cycle synchronous/asynchronous tasks.

Implementations

impl DelayTimer

pub fn new() -> DelayTimer

New a DelayTimer.

pub fn add_task(&self, task: Task) -> Result<(), TaskError>

Add a task in timer_core by event-channel.

pub fn insert_task(&self, task: Task) -> Result<TaskInstancesChain, TaskError>

Add a task in timer_core by event-channel. But it will return a handle that can constantly take out new instances of the task.

pub fn update_task(&self, task: Task) -> Result<(), TaskError>

Update a task in timer_core by event-channel.

pub fn remove_task(&self, task_id: u64) -> Result<(), TaskError>

Remove a task in timer_core by event-channel.

pub fn advance_task(&self, task_id: u64) -> Result<(), TaskError>

Advance a task in timer_core by event-channel.

pub fn cancel_task(&self, task_id: u64, record_id: i64) -> Result<(), TaskError>

Cancel a task in timer_core by event-channel. Cancel is for instances derived from the task running up.

pub fn stop_delay_timer(&self) -> Result<(), TaskError>

Stop DelayTimer, running tasks are not affected.

pub fn update_id_generator_conf(&self, machine_id: i32, node_id: i32)

Set internal id-generator for machine_id and node_id. Add a new api in the future to support passing a custom id generator. The id-generator is mainly used for binding unique record ids to internal events, for user collection, and for tracking task dynamics.

impl DelayTimer

pub fn take_status_reporter(&mut self) -> Option<StatusReporter>

This is supported on crate feature status-report only.

Take StatusReporter from DelayTimer, through which you can get public events.

pub fn get_public_event(&self) -> Result<PublicEvent, TaskError>

This is supported on crate feature status-report only.

Access to public events through DelayTimer.

Trait Implementations

impl Clone for DelayTimer

fn clone(&self) -> DelayTimer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DelayTimer

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

Formats the value using the given formatter.

impl Default for DelayTimer

fn default() -> Self

Returns the “default value” for a type.