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

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

    // Required methods
    fn schedule(
        when: DispatchTime<BlockNumber>,
        maybe_periodic: Option<Period<BlockNumber>>,
        priority: Priority,
        origin: RuntimeOrigin,
        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, ()>;
}
👎Deprecated: Use v3 instead. Will be removed after September 2024.
Expand description

A type that can be used as a scheduler.

Required Associated Types§

source

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

👎Deprecated: Use v3 instead. Will be removed after September 2024.

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

source

type Hash

👎Deprecated: Use v3 instead. Will be removed after September 2024.

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

Required Methods§

source

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

👎Deprecated: Use v3 instead. Will be removed after September 2024.

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<(), ()>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

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.

source

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

👎Deprecated: Use v3 instead. Will be removed after September 2024.

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.

source

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

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Return the next dispatch time for a given task.

Will return an error if the address is invalid.

Object Safety§

This trait is not object safe.

Implementors§