pacifica-rs 1.0.0

rust implementation of PacificA: Replication in Log-Based Distributed Storage Systems
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
60
61

use anyerror::AnyError;
use crate::{LogId, ReplicaId, TypeConfig};
use crate::storage::GetFileService;
use crate::util::Closeable;

pub trait SnapshotReader: Closeable + Send + Sync + 'static{

    /// return snapshot LogId
    fn read_snapshot_log_id(&self) -> Result<LogId, AnyError>;


    /// return unique reader id for downloading files of snapshot.
    fn generate_reader_id(&self) -> Result<usize, AnyError>;
}


pub trait SnapshotWriter: Closeable + Send + Sync + 'static{
    /// write snapshot log id
    ///
    fn write_snapshot_log_id(&mut self, log_id: LogId) -> Result<(), AnyError>;


    /// When StateMachine's on_save_snapshot callback succeeds,
    /// this method is invoked to flush the snapshot
    /// Not implemented by default
    fn flush(&mut self) -> Result<(), AnyError> {
        Ok(())
    }

}


pub trait SnapshotDownloader: Send + Sync + 'static {

    fn download(&mut self) -> impl std::future::Future<Output=Result<(), AnyError>> + Send;

}

pub trait SnapshotStorage<C>: Send + Sync + 'static
where C: TypeConfig {
    type Reader: SnapshotReader;
    type Writer: SnapshotWriter;
    type Downloader: SnapshotDownloader;
    type FileService: GetFileService<C>;

    /// open snapshot reader for load snapshot image.
    /// return None if noting
    /// return AnyError if error
    fn open_reader(&mut self) -> Result<Option<Self::Reader>, AnyError>;

    /// open snapshot write for save snapshot image.
    /// return AnyError if error
    fn open_writer(&mut self) -> Result<Self::Writer, AnyError>;

    /// download snapshot from remote target_id replica
    fn open_downloader(&mut self, target_id: ReplicaId<C::NodeId>, reader_id: usize) -> Result<Self::Downloader, AnyError>;

    /// get file service
    fn file_service(&self) -> Result<Self::FileService, AnyError>;

}