Trait frame_support::traits::schedule::v3::Anon

source · 
pub trait Anon<BlockNumber, Call, Origin> {
    type Address: Codec + MaxEncodedLen + Clone + Eq + EncodeLike + Debug + TypeInfo;
    type Hasher: Hash;

    // Required methods
    fn schedule(
        when: DispatchTime<BlockNumber>,
        maybe_periodic: Option<Period<BlockNumber>>,
        priority: Priority,
        origin: Origin,
        call: Bounded<Call, Self::Hasher>,
    ) -> Result<Self::Address, DispatchError>;
    fn cancel(address: Self::Address) -> Result<(), DispatchError>;
    fn reschedule(
        address: Self::Address,
        when: DispatchTime<BlockNumber>,
    ) -> Result<Self::Address, DispatchError>;
    fn next_dispatch_time(
        address: Self::Address,
    ) -> Result<BlockNumber, DispatchError>;
}
Expand description

A type that can be used as a scheduler.

Required Associated Types§

source

type Address: Codec + MaxEncodedLen + Clone + Eq + EncodeLike + Debug + TypeInfo

An address which can be used for removing a scheduled task.

source

type Hasher: Hash

The hasher used in the runtime.

Required Methods§

source

fn schedule( when: DispatchTime<BlockNumber>, maybe_periodic: Option<Period<BlockNumber>>, priority: Priority, origin: Origin, call: Bounded<Call, Self::Hasher>, ) -> Result<Self::Address, DispatchError>

Schedule a dispatch to happen at the beginning of some block in the future.

This is not named.

source

fn cancel(address: Self::Address) -> Result<(), DispatchError>

Cancel a scheduled task. If periodic, then it will cancel all further instances of that, also.

Will return an Unavailable error if the address is invalid.

NOTE: This guaranteed to work only before the point that it is due to be executed. If it ends up being delayed beyond the point of execution, then it cannot be cancelled.

NOTE2: This will not work to cancel periodic tasks after their initial execution. For that, you must name the task explicitly using the Named trait.

source

fn reschedule( address: Self::Address, when: DispatchTime<BlockNumber>, ) -> Result<Self::Address, DispatchError>

Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed only if it is executed before the currently scheduled block. For periodic tasks, this dispatch is guaranteed to succeed only before the initial execution; for others, use reschedule_named.

Will return an Unavailable error if the address is invalid.

source

fn next_dispatch_time( address: Self::Address, ) -> Result<BlockNumber, DispatchError>

Return the next dispatch time for a given task.

Will return an Unavailable error if the address is invalid.

Object Safety§

This trait is not object safe.

Implementors§