Trait frame_support::traits::schedule::v2::Anon

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

    fn schedule(
        when: DispatchTime<BlockNumber>,
        maybe_periodic: Option<Period<BlockNumber>>,
        priority: Priority,
        origin: Origin,
        call: MaybeHashed<Call, Self::Hash>
    ) -> Result<Self::Address, DispatchError>;
    fn cancel(address: Self::Address) -> Result<(), ()>;
    fn reschedule(
        address: Self::Address,
        when: DispatchTime<BlockNumber>
    ) -> Result<Self::Address, DispatchError>;
    fn next_dispatch_time(address: Self::Address) -> Result<BlockNumber, ()>;
}

A type that can be used as a scheduler.

Required Associated Types

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

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

type Hash

A means of expressing a call by the hash of its encoded data.

Required Methods

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

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

This is not named.

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

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

Will return an 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.

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 error if the address is invalid.

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

Return the next dispatch time for a given task.

Will return an error if the address is invalid.

Implementors