Struct polkadot_overseer::Overseer

pub struct Overseer<S, SupportsParachains> {
    pub activation_external_listeners: HashMap<Hash, Vec<Sender<SubsystemResult<()>>>>,
    pub span_per_active_leaf: HashMap<Hash, Arc<Span>>,
    pub leaves: Vec<(Hash, BlockNumber)>,
    pub active_leaves: HashMap<Hash, BlockNumber>,
    pub supports_parachains: SupportsParachains,
    pub known_leaves: LruCache<Hash, ()>,
    pub metrics: OverseerMetrics,
    /* private fields */
}

The orchestra.

Fields

activation_external_listeners: HashMap<Hash, Vec<Sender<SubsystemResult<()>>>>

A user specified addendum field.

span_per_active_leaf: HashMap<Hash, Arc<Span>>

A user specified addendum field.

leaves: Vec<(Hash, BlockNumber)>

A user specified addendum field.

active_leaves: HashMap<Hash, BlockNumber>

A user specified addendum field.

supports_parachains: SupportsParachains

A user specified addendum field.

known_leaves: LruCache<Hash, ()>

A user specified addendum field.

metrics: OverseerMetrics

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 ) -> 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 ) -> Result<(), SubsystemError>

Broadcast a signal to all subsystems.

pub async fn route_message( &mut self, message: AllMessages, origin: &'static str ) -> 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>where Mapper: MapSubsystem<&'a OrchestratedSubsystem<CandidateValidationMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<PvfCheckerMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<CandidateBackingMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<StatementDistributionMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<AvailabilityDistributionMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<AvailabilityRecoveryMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<BitfieldSigningMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<BitfieldDistributionMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<ProvisionerMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<RuntimeApiMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<AvailabilityStoreMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<NetworkBridgeRxMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<NetworkBridgeTxMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<ChainApiMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<CollationGenerationMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<CollatorProtocolMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<ApprovalDistributionMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<ApprovalVotingMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<GossipSupportMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<DisputeCoordinatorMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<DisputeDistributionMessage>, Output = Output> + MapSubsystem<&'a OrchestratedSubsystem<ChainSelectionMessage>, Output = Output>,

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<Hash, Vec<Sender<SubsystemResult<()>>>>>, Missing<HashMap<Hash, Arc<Span>>>, Missing<Vec<(Hash, BlockNumber)>>, Missing<HashMap<Hash, BlockNumber>>, Missing<SupportsParachains>, Missing<LruCache<Hash, ()>>, Missing<OverseerMetrics>>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)

Run the Overseer.

Logging any errors.