Struct SyncTask

pub struct SyncTask<P, E, C>
where
    P: PeerToPeerPort + Send + Sync + 'static,
    E: BlockImporterPort + Send + Sync + 'static,
    C: ConsensusPort + Send + Sync + 'static,
{ /* private fields */ }

Task for syncing heights. Contains import task as a child task.

Trait Implementations

impl<P, E, C> RunnableService for SyncTask<P, E, C>

where P: PeerToPeerPort + Send + Sync + 'static, E: BlockImporterPort + Send + Sync + 'static, C: ConsensusPort + Send + Sync + 'static,

const NAME: &'static str = "SyncTask"

The name of the runnable service, used for namespacing error messages.

type SharedData = ()

Service specific shared data. This is used when you have data that needs to be shared by one or more tasks. It is the implementors responsibility to ensure cloning this type is shallow and doesn’t provide a full duplication of data that is meant to be shared between asynchronous processes.

type Task = SyncTask<P, E, C>

The initialized runnable task type.

type TaskParams = ()

Optional parameters used to when initializing into task.

fn shared_data(&self) -> Self::SharedData

A cloned instance of the shared data

fn into_task<'life0, 'async_trait>( self, watcher: &'life0 StateWatcher, __arg2: Self::TaskParams, ) -> Pin<Box<dyn Future<Output = Result<Self::Task>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Converts the service into a runnable task before the main run loop.

impl<P, E, C> RunnableTask for SyncTask<P, E, C>

where P: PeerToPeerPort + Send + Sync + 'static, E: BlockImporterPort + Send + Sync + 'static, C: ConsensusPort + Send + Sync + 'static,

fn run<'life0, 'life1, 'async_trait>( &'life0 mut self, _: &'life1 mut StateWatcher, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

This function should contain the main business logic of the service task. It will run until the service either returns false, panics or a stop signal is received. If the service returns an error, it will be logged and execution will resume. This is intended to be called only by the ServiceRunner.

fn shutdown<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait,

Gracefully shutdowns the task after the end of the execution cycle.