Trait EngineHook

pub trait EngineHook:
    Send
    + Sync
    + 'static {
    // Required methods
    fn name(&self) -> &'static str;
    fn poll(
        &mut self,
        cx: &mut Context<'_>,
        ctx: EngineHookContext,
    ) -> Poll<Result<EngineHookEvent, RethError>>;
    fn db_access_level(&self) -> EngineHookDBAccessLevel;
}

Hook that will be run during the main loop of consensus engine.

Required Methods

fn name(&self) -> &'static str

Returns a human-readable name for the hook.

fn poll( &mut self, cx: &mut Context<'_>, ctx: EngineHookContext, ) -> Poll<Result<EngineHookEvent, RethError>>

Advances the hook execution, emitting an event.

fn db_access_level(&self) -> EngineHookDBAccessLevel

Returns db access level the hook needs.

Implementors

impl<PF> EngineHook for PruneHook<PF>

where PF: DatabaseProviderFactory + 'static, <PF as DatabaseProviderFactory>::ProviderRW: PruneCheckpointReader + PruneCheckpointWriter,

impl<Provider> EngineHook for StaticFileHook<Provider>

where Provider: StaticFileProviderFactory + DatabaseProviderFactory + 'static, <Provider as DatabaseProviderFactory>::Provider: StaticFileProviderFactory + StageCheckpointReader + BlockReader + ChainStateBlockReader, <<Provider as DatabaseProviderFactory>::Provider as NodePrimitivesProvider>::Primitives: NodePrimitives, <<<Provider as DatabaseProviderFactory>::Provider as NodePrimitivesProvider>::Primitives as NodePrimitives>::SignedTx: Value + Compact, <<<Provider as DatabaseProviderFactory>::Provider as NodePrimitivesProvider>::Primitives as NodePrimitives>::BlockHeader: Value + Compact, <<<Provider as DatabaseProviderFactory>::Provider as NodePrimitivesProvider>::Primitives as NodePrimitives>::Receipt: Value + Compact,