1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
// Copyright 2015-2017 Parity Technologies (UK) Ltd.
// This file is part of Parity.

// Parity is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// Parity is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with Parity.  If not, see <http://www.gnu.org/licenses/>.

use super::{ManifestData, RestorationStatus};
use util::{Bytes, H256};
use ipc::IpcConfig;

/// The interface for a snapshot network service.
/// This handles:
///    - restoration of snapshots to temporary databases.
///    - responding to queries for snapshot manifests and chunks
pub trait SnapshotService: Sync + Send {
    /// Query the most recent manifest data.
    fn manifest(&self)
    -> Option<ManifestData>;

    /// Get raw chunk for a given hash.
    fn chunk(&self, hash: H256)
    -> Option<Bytes>;

    /// Ask the snapshot service for the restoration status.
    fn status(&self)
    -> RestorationStatus;

    /// Begin snapshot restoration.
    /// If restoration in-progress, this will reset it.
    /// From this point on, any previous snapshot may become unavailable.
    fn begin_restore(&self, manifest: ManifestData);

    /// Abort an in-progress restoration if there is one.
    fn abort_restore(&self);

    /// Feed a raw state chunk to the service to be processed asynchronously.
    /// no-op if not currently restoring.
    fn restore_state_chunk(&self, hash: H256, chunk: Bytes);

    /// Feed a raw block chunk to the service to be processed asynchronously.
    /// no-op if currently restoring.
    fn restore_block_chunk(&self, hash: H256, chunk: Bytes);

    /// Give the restoration in-progress some canonical block hashes for
    /// extra verification (performed at the end)
    fn provide_canon_hashes(&self, canonical: &[(u64, H256)]);
}

impl IpcConfig for SnapshotService { }