Crate noble_scheduler[][src]

Scheduler

A module for scheduling dispatches.

Overview

This module exposes capabilities for scheduling dispatches to occur at a specified block number or at a specified period. These scheduled dispatches may be named or anonymous and may be canceled.

NOTE: The scheduled calls will be dispatched with the default filter for the origin: namely fabric_system::Config::BaseCallFilter for all origin except root which will get no filter. And not the filter contained in origin use to call fn schedule.

If a call is scheduled using proxy or whatever mecanism which adds filter, then those filter will not be used when dispatching the schedule call.

Interface

Dispatchable Functions

  • schedule - schedule a dispatch, which may be periodic, to occur at a specified block and with a specified priority.
  • cancel - cancel a scheduled dispatch, specified by block number and index.
  • schedule_named - augments the schedule interface with an additional Vec<u8> parameter that can be used for identification.
  • cancel_named - the named complement to the cancel function.

Re-exports

pub use weights::WeightInfo;
pub use $crate::traits::GetNobleVersion as _;

Modules

weights

Weights for noble_scheduler THIS FILE WAS AUTO-GENERATED USING THE TETCORE BENCHMARK CLI VERSION 2.0.0 DATE: 2020-10-27, STEPS: [50, ], REPEAT: 20, LOW RANGE: [], HIGH RANGE: [] EXECUTION: Some(Wasm), WASM-EXECUTION: Compiled, CHAIN: Some(“dev”), DB CACHE: 128

Structs

Agenda

Items to be executed, indexed by the block number that they should be executed on.

GenesisConfig

Genesis config for the module, allow to build genesis storage.

Module

Scheduler module declaration.

ScheduledV2

Information regarding an item to be executed in the future.

Enums

Call

Dispatchable calls.

Error
RawEvent

Events for this module.

Traits

Config

Our noble’s configuration trait. All our types and constants go in here. If the noble is dependent on specific other nobles, then their configuration traits should be added to our implied traits list.

Type Definitions

Event

RawEvent specialized for the configuration Config

PeriodicIndex

Just a simple index for naming period tasks.

Scheduled

The current version of Scheduled struct.

TaskAddress

The location of a scheduled task that can be used to remove it.