Struct delay_timer::entity::DelayTimer

source · [−]

pub struct DelayTimer { /* private fields */ }

Expand description

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for DelayTimer

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

Formats the value using the given formatter. Read more

impl Default for DelayTimer

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl !RefUnwindSafe for DelayTimer

impl Send for DelayTimer

impl Sync for DelayTimer

impl Unpin for DelayTimer

impl !UnwindSafe for DelayTimer

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more