Crate pallet_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 frame_system::Trait::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 thescheduleinterface with an additionalVec<u8>parameter that can be used for identification.cancel_named- the named complement to the cancel function.
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
| Trait | Our pallet’s configuration trait. All our types and constants go in here. If the pallet is dependent on specific other pallets, then their configuration traits should be added to our implied traits list. |
| WeightInfo |
Type Definitions
| Event | |
| 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. |