mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 12:17:58 +00:00
Chevdor
a30092ab42
* Add markdown linting - add linter default rules - adapt rules to current code - fix the code for linting to pass - add CI check fix #1243 * Fix markdown for Substrate * Fix tooling install * Fix workflow * Add documentation * Remove trailing spaces * Update .github/.markdownlint.yaml Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix mangled markdown/lists * Fix captalization issues on known words
35 lines
1.4 KiB
Markdown
35 lines
1.4 KiB
Markdown
# Scheduler
|
|
A module for scheduling dispatches.
|
|
|
|
- [`scheduler::Config`](https://docs.rs/pallet-scheduler/latest/pallet_scheduler/trait.Config.html)
|
|
- [`Call`](https://docs.rs/pallet-scheduler/latest/pallet_scheduler/enum.Call.html)
|
|
- [`Module`](https://docs.rs/pallet-scheduler/latest/pallet_scheduler/struct.Module.html)
|
|
|
|
## 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::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.
|
|
|
|
License: Apache 2.0
|