Struct polkadot_node_subsystem::Overseer

pub struct Overseer<S, SupportsParachains> {
    pub activation_external_listeners: HashMap<H256, Vec<Sender<Result<(), SubsystemError>>, Global>, RandomState>,
    pub span_per_active_leaf: HashMap<H256, Arc<Span>, RandomState>,
    pub leaves: Vec<(H256, u32), Global>,
    pub active_leaves: HashMap<H256, u32, RandomState>,
    pub supports_parachains: SupportsParachains,
    pub known_leaves: LruCache<H256, (), RandomState>,
    pub metrics: Metrics,
    /* private fields */
}

The orchestra.

Fields

activation_external_listeners: HashMap<H256, Vec<Sender<Result<(), SubsystemError>>, Global>, RandomState>

A user specified addendum field.

span_per_active_leaf: HashMap<H256, Arc<Span>, RandomState>

A user specified addendum field.

leaves: Vec<(H256, u32), Global>

A user specified addendum field.

active_leaves: HashMap<H256, u32, RandomState>

A user specified addendum field.

supports_parachains: SupportsParachains

A user specified addendum field.

known_leaves: LruCache<H256, (), RandomState>

A user specified addendum field.

metrics: Metrics

A user specified addendum field.

Implementations

impl<S, SupportsParachains> Overseer<S, SupportsParachains>where S: Spawner,

pub async fn wait_terminate( &mut self, signal: OverseerSignal, timeout: Duration ) -> impl Future<Output = Result<(), SubsystemError>>

Send the given signal, a termination signal, to all subsystems and wait for all subsystems to go down.

The definition of a termination signal is up to the user and implementation specific.

pub async fn broadcast_signal( &mut self, signal: OverseerSignal ) -> impl Future<Output = Result<(), SubsystemError>>

Broadcast a signal to all subsystems.

pub async fn route_message( &mut self, message: AllMessages, origin: &'static str ) -> impl Future<Output = Result<(), SubsystemError>>

Route a particular message to a subsystem that consumes the message.

pub fn map_subsystems<'a, Mapper, Output>( &'a self, mapper: Mapper ) -> Vec<Output, Global>where Mapper: MapSubsystem<&'a OrchestratedSubsystem<CandidateValidationMessage>, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<PvfCheckerMessage>> + MapSubsystem<&'a OrchestratedSubsystem<CandidateBackingMessage>> + MapSubsystem<&'a OrchestratedSubsystem<StatementDistributionMessage>> + MapSubsystem<&'a OrchestratedSubsystem<AvailabilityDistributionMessage>> + MapSubsystem<&'a OrchestratedSubsystem<AvailabilityRecoveryMessage>> + MapSubsystem<&'a OrchestratedSubsystem<BitfieldSigningMessage>> + MapSubsystem<&'a OrchestratedSubsystem<BitfieldDistributionMessage>> + MapSubsystem<&'a OrchestratedSubsystem<ProvisionerMessage>> + MapSubsystem<&'a OrchestratedSubsystem<RuntimeApiMessage>> + MapSubsystem<&'a OrchestratedSubsystem<AvailabilityStoreMessage>> + MapSubsystem<&'a OrchestratedSubsystem<NetworkBridgeRxMessage>> + MapSubsystem<&'a OrchestratedSubsystem<NetworkBridgeTxMessage>> + MapSubsystem<&'a OrchestratedSubsystem<ChainApiMessage>> + MapSubsystem<&'a OrchestratedSubsystem<CollationGenerationMessage>> + MapSubsystem<&'a OrchestratedSubsystem<CollatorProtocolMessage>> + MapSubsystem<&'a OrchestratedSubsystem<ApprovalDistributionMessage>> + MapSubsystem<&'a OrchestratedSubsystem<ApprovalVotingMessage>> + MapSubsystem<&'a OrchestratedSubsystem<GossipSupportMessage>> + MapSubsystem<&'a OrchestratedSubsystem<DisputeCoordinatorMessage>> + MapSubsystem<&'a OrchestratedSubsystem<DisputeDistributionMessage>> + MapSubsystem<&'a OrchestratedSubsystem<ChainSelectionMessage>>,

Extract information from each subsystem.

pub fn spawner<'a>(&'a mut self) -> &'a mut S

Get access to internal task spawner.

impl<S, SupportsParachains> Overseer<S, SupportsParachains>where S: Spawner,

pub fn builder<CandidateValidation, PvfChecker, CandidateBacking, StatementDistribution, AvailabilityDistribution, AvailabilityRecovery, BitfieldSigning, BitfieldDistribution, Provisioner, RuntimeApi, AvailabilityStore, NetworkBridgeRx, NetworkBridgeTx, ChainApi, CollationGeneration, CollatorProtocol, ApprovalDistribution, ApprovalVoting, GossipSupport, DisputeCoordinator, DisputeDistribution, ChainSelection>( ) -> OverseerBuilder<Missing<S>, Missing<CandidateValidation>, Missing<PvfChecker>, Missing<CandidateBacking>, Missing<StatementDistribution>, Missing<AvailabilityDistribution>, Missing<AvailabilityRecovery>, Missing<BitfieldSigning>, Missing<BitfieldDistribution>, Missing<Provisioner>, Missing<RuntimeApi>, Missing<AvailabilityStore>, Missing<NetworkBridgeRx>, Missing<NetworkBridgeTx>, Missing<ChainApi>, Missing<CollationGeneration>, Missing<CollatorProtocol>, Missing<ApprovalDistribution>, Missing<ApprovalVoting>, Missing<GossipSupport>, Missing<DisputeCoordinator>, Missing<DisputeDistribution>, Missing<ChainSelection>, Missing<HashMap<H256, Vec<Sender<Result<(), SubsystemError>>, Global>, RandomState>>, Missing<HashMap<H256, Arc<Span>, RandomState>>, Missing<Vec<(H256, u32), Global>>, Missing<HashMap<H256, u32, RandomState>>, Missing<SupportsParachains>, Missing<LruCache<H256, (), RandomState>>, Missing<Metrics>>where CandidateValidation: Subsystem<OverseerSubsystemContext<CandidateValidationMessage>, SubsystemError>, <OverseerSubsystemContext<CandidateValidationMessage> as CandidateValidationContextTrait>::Sender: CandidateValidationSenderTrait, OverseerSubsystemContext<CandidateValidationMessage>: CandidateValidationContextTrait, PvfChecker: Subsystem<OverseerSubsystemContext<PvfCheckerMessage>, SubsystemError>, <OverseerSubsystemContext<PvfCheckerMessage> as PvfCheckerContextTrait>::Sender: PvfCheckerSenderTrait, OverseerSubsystemContext<PvfCheckerMessage>: PvfCheckerContextTrait, CandidateBacking: Subsystem<OverseerSubsystemContext<CandidateBackingMessage>, SubsystemError>, <OverseerSubsystemContext<CandidateBackingMessage> as CandidateBackingContextTrait>::Sender: CandidateBackingSenderTrait, OverseerSubsystemContext<CandidateBackingMessage>: CandidateBackingContextTrait, StatementDistribution: Subsystem<OverseerSubsystemContext<StatementDistributionMessage>, SubsystemError>, <OverseerSubsystemContext<StatementDistributionMessage> as StatementDistributionContextTrait>::Sender: StatementDistributionSenderTrait, OverseerSubsystemContext<StatementDistributionMessage>: StatementDistributionContextTrait, AvailabilityDistribution: Subsystem<OverseerSubsystemContext<AvailabilityDistributionMessage>, SubsystemError>, <OverseerSubsystemContext<AvailabilityDistributionMessage> as AvailabilityDistributionContextTrait>::Sender: AvailabilityDistributionSenderTrait, OverseerSubsystemContext<AvailabilityDistributionMessage>: AvailabilityDistributionContextTrait, AvailabilityRecovery: Subsystem<OverseerSubsystemContext<AvailabilityRecoveryMessage>, SubsystemError>, <OverseerSubsystemContext<AvailabilityRecoveryMessage> as AvailabilityRecoveryContextTrait>::Sender: AvailabilityRecoverySenderTrait, OverseerSubsystemContext<AvailabilityRecoveryMessage>: AvailabilityRecoveryContextTrait, BitfieldSigning: Subsystem<OverseerSubsystemContext<BitfieldSigningMessage>, SubsystemError>, <OverseerSubsystemContext<BitfieldSigningMessage> as BitfieldSigningContextTrait>::Sender: BitfieldSigningSenderTrait, OverseerSubsystemContext<BitfieldSigningMessage>: BitfieldSigningContextTrait, BitfieldDistribution: Subsystem<OverseerSubsystemContext<BitfieldDistributionMessage>, SubsystemError>, <OverseerSubsystemContext<BitfieldDistributionMessage> as BitfieldDistributionContextTrait>::Sender: BitfieldDistributionSenderTrait, OverseerSubsystemContext<BitfieldDistributionMessage>: BitfieldDistributionContextTrait, Provisioner: Subsystem<OverseerSubsystemContext<ProvisionerMessage>, SubsystemError>, <OverseerSubsystemContext<ProvisionerMessage> as ProvisionerContextTrait>::Sender: ProvisionerSenderTrait, OverseerSubsystemContext<ProvisionerMessage>: ProvisionerContextTrait, RuntimeApi: Subsystem<OverseerSubsystemContext<RuntimeApiMessage>, SubsystemError>, <OverseerSubsystemContext<RuntimeApiMessage> as RuntimeApiContextTrait>::Sender: RuntimeApiSenderTrait, OverseerSubsystemContext<RuntimeApiMessage>: RuntimeApiContextTrait, AvailabilityStore: Subsystem<OverseerSubsystemContext<AvailabilityStoreMessage>, SubsystemError>, <OverseerSubsystemContext<AvailabilityStoreMessage> as AvailabilityStoreContextTrait>::Sender: AvailabilityStoreSenderTrait, OverseerSubsystemContext<AvailabilityStoreMessage>: AvailabilityStoreContextTrait, NetworkBridgeRx: Subsystem<OverseerSubsystemContext<NetworkBridgeRxMessage>, SubsystemError>, <OverseerSubsystemContext<NetworkBridgeRxMessage> as NetworkBridgeRxContextTrait>::Sender: NetworkBridgeRxSenderTrait, OverseerSubsystemContext<NetworkBridgeRxMessage>: NetworkBridgeRxContextTrait, NetworkBridgeTx: Subsystem<OverseerSubsystemContext<NetworkBridgeTxMessage>, SubsystemError>, <OverseerSubsystemContext<NetworkBridgeTxMessage> as NetworkBridgeTxContextTrait>::Sender: NetworkBridgeTxSenderTrait, OverseerSubsystemContext<NetworkBridgeTxMessage>: NetworkBridgeTxContextTrait, ChainApi: Subsystem<OverseerSubsystemContext<ChainApiMessage>, SubsystemError>, <OverseerSubsystemContext<ChainApiMessage> as ChainApiContextTrait>::Sender: ChainApiSenderTrait, OverseerSubsystemContext<ChainApiMessage>: ChainApiContextTrait, CollationGeneration: Subsystem<OverseerSubsystemContext<CollationGenerationMessage>, SubsystemError>, <OverseerSubsystemContext<CollationGenerationMessage> as CollationGenerationContextTrait>::Sender: CollationGenerationSenderTrait, OverseerSubsystemContext<CollationGenerationMessage>: CollationGenerationContextTrait, CollatorProtocol: Subsystem<OverseerSubsystemContext<CollatorProtocolMessage>, SubsystemError>, <OverseerSubsystemContext<CollatorProtocolMessage> as CollatorProtocolContextTrait>::Sender: CollatorProtocolSenderTrait, OverseerSubsystemContext<CollatorProtocolMessage>: CollatorProtocolContextTrait, ApprovalDistribution: Subsystem<OverseerSubsystemContext<ApprovalDistributionMessage>, SubsystemError>, <OverseerSubsystemContext<ApprovalDistributionMessage> as ApprovalDistributionContextTrait>::Sender: ApprovalDistributionSenderTrait, OverseerSubsystemContext<ApprovalDistributionMessage>: ApprovalDistributionContextTrait, ApprovalVoting: Subsystem<OverseerSubsystemContext<ApprovalVotingMessage>, SubsystemError>, <OverseerSubsystemContext<ApprovalVotingMessage> as ApprovalVotingContextTrait>::Sender: ApprovalVotingSenderTrait, OverseerSubsystemContext<ApprovalVotingMessage>: ApprovalVotingContextTrait, GossipSupport: Subsystem<OverseerSubsystemContext<GossipSupportMessage>, SubsystemError>, <OverseerSubsystemContext<GossipSupportMessage> as GossipSupportContextTrait>::Sender: GossipSupportSenderTrait, OverseerSubsystemContext<GossipSupportMessage>: GossipSupportContextTrait, DisputeCoordinator: Subsystem<OverseerSubsystemContext<DisputeCoordinatorMessage>, SubsystemError>, <OverseerSubsystemContext<DisputeCoordinatorMessage> as DisputeCoordinatorContextTrait>::Sender: DisputeCoordinatorSenderTrait, OverseerSubsystemContext<DisputeCoordinatorMessage>: DisputeCoordinatorContextTrait, DisputeDistribution: Subsystem<OverseerSubsystemContext<DisputeDistributionMessage>, SubsystemError>, <OverseerSubsystemContext<DisputeDistributionMessage> as DisputeDistributionContextTrait>::Sender: DisputeDistributionSenderTrait, OverseerSubsystemContext<DisputeDistributionMessage>: DisputeDistributionContextTrait, ChainSelection: Subsystem<OverseerSubsystemContext<ChainSelectionMessage>, SubsystemError>, <OverseerSubsystemContext<ChainSelectionMessage> as ChainSelectionContextTrait>::Sender: ChainSelectionSenderTrait, OverseerSubsystemContext<ChainSelectionMessage>: ChainSelectionContextTrait,

Create a new orchestra utilizing the builder.

impl<S, SupportsParachains> Overseer<S, SupportsParachains>where SupportsParachains: HeadSupportsParachains, S: Spawner,

pub async fn run(self) -> impl Future<Output = ()>

Run the Overseer.

Logging any errors.