[−][src]Crate pallet_scheduler

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.

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.

Structs

Agenda	Items to be executed, indexed by the block number that they should be executed on.
Module	Scheduler module declaration.
Scheduled	Information regarding an item to be executed in the future.

Enums

Call	Dispatchable calls.
Error
RawEvent	Events for this module.

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.

Type Definitions

Event	`RawEvent` specialized for the configuration `Trait`
PeriodicIndex	Just a simple index for naming period tasks.
TaskAddress	The location of a scheduled task that can be used to remove it.