Struct clepsydra::Database

pub struct Database<L: Lang, S: Store<L>> {
    pub self_id: PeerID,
    // some fields omitted
}

Main object that clients instantiate. Encapsulates the remainder of the system. Clients need to provide a Clock and Store, as well as some number of async IO connections to other peers.

Fields

self_id: PeerID

Implementations

impl<L: Lang, S: Store<L>> Database<L, S>

pub fn new(self_id: PeerID, clock: Box<dyn Clock>, store: S) -> Self

Construct a new Database for a given Clock and Store. The PeerID should be unique among peers in a group, and all peers should use compatible and roughly-synchronized clocks.

pub fn coordinate(
    &self,
    stmt: L::Stmt,
    vals: Vec<L::Val>
) -> Pin<Box<dyn Future<Output = Result<(GlobalTime, BTreeMap<L::Key, ExtVal<L>>), Error>> + Send + Sync + 'static>>

Main entrypoint for clients submitting transactions. Call this and await the response. If the response is Ok, a transaction containing stmt and vals was successfully replicated to a quorum of peers and executed at a specific GlobalTime in the consensus sequential order. The result will contain the that timestamp as a map populated with any keys and their values (evaluated at the transaction's time) specified by Lang::get_eval_set(stmt).

impl<L: Lang, S: Store<L>> Database<L, S>

pub async fn connect<IO: AsyncReadWrite>(&self, peer: PeerID, io: IO)

Adds a connection to a remote PeerID. The io handle should be a full-duplex AsyncRead+AsyncWrite type.

pub fn launch_workers(
    &self
) -> Pin<Box<dyn Future<Output = ()> + Send + Sync + 'static>>

Start network-service worker tasks on this database. Should be called before any calls to Database::coordinate.

Trait Implementations

impl<L: Lang, S: Store<L>> Clone for Database<L, S>

pub fn clone(&self) -> Self

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.