Struct vapcore_snapshot::service::Service

pub struct Service<C: Send + Sync + 'static> { /* fields omitted */ }

SnapshotService implementation. This controls taking snapshots and restoring from them.

Implementations

impl<C> Service<C> where
    C: SnapshotClient + ChainInfo, 

pub fn new(params: ServiceParams<C>) -> Result<Self, Error>

Create a new snapshot service from the given parameters.

pub fn reader(&self) -> RwLockReadGuard<'_, Option<LooseReader>>

Get a reference to the snapshot reader.

pub fn tick(&self)

Tick the snapshot service. This will log any active snapshot being taken.

pub fn take_snapshot(&self, client: &C, num: u64) -> Result<(), Error>

Take a snapshot at the block with the given number. Calling this while a restoration is in progress or vice versa will lead to a race condition where the first one to finish will have their produced snapshot overwritten.

pub fn init_restore(
    &self,
    manifest: ManifestData,
    recover: bool
) -> Result<(), Error>

Initialize the restoration synchronously. The recover flag indicates whether to recover the restored snapshot.

pub fn feed_state_chunk(&self, hash: H256, chunk: &[u8])

Feed a state chunk to be processed synchronously.

pub fn feed_block_chunk(&self, hash: H256, chunk: &[u8])

Feed a block chunk to be processed synchronously.

Trait Implementations

impl<C: Send + Sync> Drop for Service<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C: Send + Sync> SnapshotService for Service<C>

fn manifest(&self) -> Option<ManifestData>

Query the most recent manifest data.

fn supported_versions(&self) -> Option<(u64, u64)>

Get the supported range of snapshot version numbers. None indicates warp sync isn’t supported by the consensus engine.

fn completed_chunks(&self) -> Option<Vec<H256>>

Returns a list of the completed chunks

fn chunk(&self, hash: H256) -> Option<Bytes>

Get raw chunk for a given hash.

fn status(&self) -> RestorationStatus

Ask the snapshot service for the restoration status.

fn begin_restore(&self, manifest: ManifestData)

Begin snapshot restoration. If a restoration is in progress, this will reset it and clear all data.

fn abort_restore(&self)

Abort an in-progress restoration if there is one.

fn restore_state_chunk(&self, hash: H256, chunk: Bytes)

Feed a raw state chunk to the service to be processed asynchronously. no-op if not currently restoring.

fn restore_block_chunk(&self, hash: H256, chunk: Bytes)

Feed a raw block chunk to the service to be processed asynchronously. no-op if currently restoring.

fn abort_snapshot(&self)

Abort in-progress snapshotting if there is one.

fn shutdown(&self)

Shutdown the Snapshot Service by aborting any ongoing restore