Crate polkadot_node_subsystem
source ·Expand description
Subsystem accumulation.
Node-side types and generated overseer.
Re-exports§
pub use polkadot_overseer as overseer;
Modules§
- A dummy subsystem, mostly useful for placeholders and tests.
- Error types for the subsystem requests.
- Orchestra
- Re-export of all messages type, including the wrapper type.
- Prometheus metrics related to the overseer and its channels.
Structs§
- Activated leaf.
- Changes in the set of active leaves: the parachain heads which we care to work on.
- An event telling the
Overseer
on the particular block that has been imported or finalized. - A description of an error causing the chain API request to be unservable.
- Collection of channels to the individual subsystems.
- A dummy subsystem that implements
Subsystem
for all types of messages. Used for tests or as a placeholder. - A handle used to communicate with the
Overseer
. - High priority.
- A wrapping type for messages.
- Create a stream of ticks with a defined cycle duration.
- Type marker for the uninitialized field of the orchestra builder.
PhantomData
is used for type hinting when creating uninitialized builder, e.g. to avoid specifying the generics when instantiating theFooBuilder
when callingFoo::builder()
- Normal priority.
- A subsystem that the orchestrator orchestrates.
- The orchestra.
- Builder pattern to create compile time safe construction path.
- External connector.
- A shareable metrics type for usage with the overseer.
- Connector to send messages towards all subsystems, while tracking the which signals where already received.
- A context type that is given to the
Subsystem
upon spawning. It can be used bySubsystem
to communicate with otherSubsystem
s or to spawn it’sSubsystemJob
s. - Watermark to track the received signals.
- Glue to connect
trait orchestra::Spawner
andSpawnNamed
fromsubstrate
. - Set of readouts of the
Meter
s of a subsystem. - Collection of meters related to a subsystem.
Enums§
- Generated message type wrapper over all possible messages used by any subsystem.
- An event from outside the overseer scope, such as the substrate framework or user interaction.
- Some request from outer world.
- An error that may happen during Availability Recovery process.
- Type for the initialized field of the orchestra builder
- An error that may happen during Availability Recovery process.
- An error type that describes faults that may happen
- Signals sent by an overseer to a subsystem.
- Priority of messages sending to the individual subsystems. Only for the bounded channel sender.
- An error that may happen during Availability Recovery process.
- A description of an error causing the runtime API request to be unservable.
- An error type that describes faults that may happen
- A type of messages that are sent from a
Subsystem
to the declared orchestra. - A bounded channel error when trying to send a message (transparently wraps the inner error type)
Traits§
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- A abstracting trait for usage with subsystems.
- Binds a generated type covering all declared outgoing messages, which implements
#generated_outgoing: From<M>
for all annotated types of a particular subsystem. - Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Offers header utilities.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Whether a header supports parachain consensus or not.
- A helper trait to map a subsystem to smth. else.
- Subsystem- or job-specific Prometheus metrics.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Describes the priority of the message.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Exposes all runtime calls that are used by the runtime API subsystem.
- A spawner
- Accumulative trait for a particular subsystem wrapper.
- A abstracting trait for usage with subsystems.
- Sender end of a channel to interface with a subsystem.
- Task kind to launch.
- Extends
Future
to allow time-limited futures.
Functions§
- Glues together the
Overseer
andBlockchainEvents
by forwarding import and finality notifications into theOverseerHandle
. - Spawn task of kind
self
using spawnerS
. - Spawn the metrics metronome task.
Type Aliases§
- Specialized message type originating from the overseer.
- Type used to represent a builder where all fields are initialized and the orchestra could be constructed.
- Handle for an orchestra.
- Spawned subsystem.
- Incoming messages from both the bounded and unbounded channel.
- Specialized subsystem instance type of subsystems consuming a particular message type.
- A
Result
type that wrapsSubsystemError
. - Keeps the state of a specific block pinned in memory while the handle is alive.