Struct pallet_scheduler::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn schedule(
    origin: OriginFor<T>,
    when: T::BlockNumber,
    maybe_periodic: Option<Period<T::BlockNumber>>,
    priority: Priority,
    call: Box<<T as Config>::Call>
) -> DispatchResult

Anonymously schedule a task.

• S = Number of already scheduled calls
• Base Weight: 22.29 + .126 * S µs
• DB Weight:
  • Read: Agenda
  • Write: Agenda
• Will use base weight of 25 which should be good for up to 30 scheduled calls

pub fn cancel(
    origin: OriginFor<T>,
    when: T::BlockNumber,
    index: u32
) -> DispatchResult

Cancel an anonymously scheduled task.

• S = Number of already scheduled calls
• Base Weight: 22.15 + 2.869 * S µs
• DB Weight:
  • Read: Agenda
  • Write: Agenda, Lookup
• Will use base weight of 100 which should be good for up to 30 scheduled calls

pub fn schedule_named(
    origin: OriginFor<T>,
    id: Vec<u8>,
    when: T::BlockNumber,
    maybe_periodic: Option<Period<T::BlockNumber>>,
    priority: Priority,
    call: Box<<T as Config>::Call>
) -> DispatchResult

Schedule a named task.

• S = Number of already scheduled calls
• Base Weight: 29.6 + .159 * S µs
• DB Weight:
  • Read: Agenda, Lookup
  • Write: Agenda, Lookup
• Will use base weight of 35 which should be good for more than 30 scheduled calls

pub fn cancel_named(origin: OriginFor<T>, id: Vec<u8>) -> DispatchResult

Cancel a named scheduled task.

• S = Number of already scheduled calls
• Base Weight: 24.91 + 2.907 * S µs
• DB Weight:
  • Read: Agenda, Lookup
  • Write: Agenda, Lookup
• Will use base weight of 100 which should be good for up to 30 scheduled calls

pub fn schedule_after(
    origin: OriginFor<T>,
    after: T::BlockNumber,
    maybe_periodic: Option<Period<T::BlockNumber>>,
    priority: Priority,
    call: Box<<T as Config>::Call>
) -> DispatchResult

Anonymously schedule a task after a delay.

Same as schedule.

pub fn schedule_named_after(
    origin: OriginFor<T>,
    id: Vec<u8>,
    after: T::BlockNumber,
    maybe_periodic: Option<Period<T::BlockNumber>>,
    priority: Priority,
    call: Box<<T as Config>::Call>
) -> DispatchResult

Schedule a named task after a delay.

Same as schedule_named.

impl<T: Config> Pallet<T>

pub fn migrate_v1_to_t2() -> bool

Migrate storage format from V1 to V2. Return true if migration is performed.

pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + Decode>()

Helper to migrate scheduler when the pallet origin type has changed.

Trait Implementations

impl<T: Config> Anon<<T as Config>::BlockNumber, <T as Config>::Call, <T as Config>::PalletsOrigin> for Pallet<T>

type Address = TaskAddress<T::BlockNumber>

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

fn schedule(
    when: DispatchTime<T::BlockNumber>,
    maybe_periodic: Option<Period<T::BlockNumber>>,
    priority: Priority,
    origin: T::PalletsOrigin,
    call: <T as Config>::Call
) -> Result<Self::Address, DispatchError>

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

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

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

fn reschedule(
    address: Self::Address,
    when: DispatchTime<T::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.

fn next_dispatch_time(
    (when, index): Self::Address
) -> Result<T::BlockNumber, ()>

Return the next dispatch time for a given task.

impl<T: Config> Benchmarking<BenchmarkResults> for Pallet<T> where
    T: Config, 

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark(
    extrinsic: &[u8],
    c: &[(BenchmarkParameter, u32)],
    whitelist: &[TrackedStorageKey],
    verify: bool,
    internal_repeats: u32
) -> Result<Vec<BenchmarkResults>, &'static str>

Run the benchmarks for this pallet.

impl<T: Config> Callable<T> for Pallet<T>

type Call = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter.

impl<T: Config> GetStorageVersion for Pallet<T>

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(now: T::BlockNumber) -> Weight

Execute the scheduled calls

• S = Number of already scheduled calls
• N = Named scheduled calls
• P = Periodic Calls
• Base Weight: 9.243 + 23.45 * S µs
• DB Weight:
  • Read: Agenda + Lookup * N + Agenda(Future) * P
  • Write: Agenda + Lookup * N + Agenda(future) * P

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

fn on_idle(_n: BlockNumber, _remaining_weight: u64) -> u64

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_runtime_upgrade() -> u64

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn integrity_test()

Run integrity test.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

Run integrity test.

impl<T: Config> ModuleErrorMetadata for Pallet<T>

fn metadata() -> &'static [ErrorMetadata]

impl<T: Config> Named<<T as Config>::BlockNumber, <T as Config>::Call, <T as Config>::PalletsOrigin> for Pallet<T>

type Address = TaskAddress<T::BlockNumber>

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

fn schedule_named(
    id: Vec<u8>,
    when: DispatchTime<T::BlockNumber>,
    maybe_periodic: Option<Period<T::BlockNumber>>,
    priority: Priority,
    origin: T::PalletsOrigin,
    call: <T as Config>::Call
) -> Result<Self::Address, ()>

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

fn cancel_named(id: Vec<u8>) -> Result<(), ()>

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

fn reschedule_named(
    id: Vec<u8>,
    when: DispatchTime<T::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.

fn next_dispatch_time(id: Vec<u8>) -> Result<T::BlockNumber, ()>

Return the next dispatch time for a given task.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

impl<T> PartialEq<Pallet<T>> for Pallet<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T> Eq for Pallet<T>