Raft.Log

Documentation

data EntryIssuer

Constructors

ClientIssuer ClientId

LeaderIssuer LeaderId

Instances

Show EntryIssuer

Defined in Raft.Log

Methods

showsPrec :: Int -> EntryIssuer -> ShowS

show :: EntryIssuer -> String

showList :: [EntryIssuer] -> ShowS

Generic EntryIssuer

Defined in Raft.Log

Associated Types

type Rep EntryIssuer :: Type -> Type

Methods

from :: EntryIssuer -> Rep EntryIssuer x

to :: Rep EntryIssuer x -> EntryIssuer

Serialize EntryIssuer

Defined in Raft.Log

Methods

put :: Putter EntryIssuer

get :: Get EntryIssuer

type Rep EntryIssuer

Defined in Raft.Log

type Rep EntryIssuer = D1 (MetaData "EntryIssuer" "Raft.Log" "libraft-0.1.1.0-8nwazCMBvi7EUIW9UIbZhF" False) (C1 (MetaCons "ClientIssuer" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ClientId)) :+: C1 (MetaCons "LeaderIssuer" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 LeaderId)))

data EntryValue v

Constructors

EntryValue v

NoValue

Used as a first committed entry of a new term

Instances

Show v => Show (EntryValue v)

Defined in Raft.Log

Methods

showsPrec :: Int -> EntryValue v -> ShowS

show :: EntryValue v -> String

showList :: [EntryValue v] -> ShowS

Generic (EntryValue v)

Defined in Raft.Log

Associated Types

type Rep (EntryValue v) :: Type -> Type

Methods

from :: EntryValue v -> Rep (EntryValue v) x

to :: Rep (EntryValue v) x -> EntryValue v

Serialize v => Serialize (EntryValue v)

Defined in Raft.Log

Methods

put :: Putter (EntryValue v)

get :: Get (EntryValue v)

type Rep (EntryValue v)

Defined in Raft.Log

type Rep (EntryValue v) = D1 (MetaData "EntryValue" "Raft.Log" "libraft-0.1.1.0-8nwazCMBvi7EUIW9UIbZhF" False) (C1 (MetaCons "EntryValue" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 v)) :+: C1 (MetaCons "NoValue" PrefixI False) (U1 :: Type -> Type))

data Entry v

Representation of an entry in the replicated log

Constructors

Entry

Fields

• entryIndex :: Index

  Index of entry in the log

• entryTerm :: Term

  Term when entry was received by leader

• entryValue :: EntryValue v

  Command to update state machine

• entryIssuer :: EntryIssuer

  Id of the client that issued the command

Instances

Show v => Show (Entry v)

Defined in Raft.Log

Methods

showsPrec :: Int -> Entry v -> ShowS

show :: Entry v -> String

showList :: [Entry v] -> ShowS

Generic (Entry v)

Defined in Raft.Log

Associated Types

type Rep (Entry v) :: Type -> Type

Methods

from :: Entry v -> Rep (Entry v) x

to :: Rep (Entry v) x -> Entry v

Serialize v => Serialize (Entry v)

Defined in Raft.Log

Methods

put :: Putter (Entry v)

get :: Get (Entry v)

type Rep (Entry v)

Defined in Raft.Log

type Rep (Entry v) = D1 (MetaData "Entry" "Raft.Log" "libraft-0.1.1.0-8nwazCMBvi7EUIW9UIbZhF" False) (C1 (MetaCons "Entry" PrefixI True) ((S1 (MetaSel (Just "entryIndex") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Index) :*: S1 (MetaSel (Just "entryTerm") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Term)) :*: (S1 (MetaSel (Just "entryValue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (EntryValue v)) :*: S1 (MetaSel (Just "entryIssuer") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 EntryIssuer))))

type Entries v = Seq (Entry v)

class Monad m => RaftWriteLog m v where

Provides an interface for nodes to write log entries to storage.

Associated Types

type RaftWriteLogError m

Methods

writeLogEntries :: Exception (RaftWriteLogError m) => Entries v -> m (Either (RaftWriteLogError m) ())

Write the given log entries to storage

Instances

(MonadIO m, MonadConc m, Serialize v) => RaftWriteLog (RaftFileStoreT m) v

Defined in Examples.Raft.FileStore

Associated Types

type RaftWriteLogError (RaftFileStoreT m) :: Type

Methods

writeLogEntries :: Entries v -> RaftFileStoreT m (Either (RaftWriteLogError (RaftFileStoreT m)) ())

data DeleteSuccess v

Constructors

DeleteSuccess

class Monad m => RaftDeleteLog m v where

Provides an interface for nodes to delete log entries from storage.

Associated Types

type RaftDeleteLogError m

Methods

deleteLogEntriesFrom :: Exception (RaftDeleteLogError m) => Index -> m (Either (RaftDeleteLogError m) (DeleteSuccess v))

Delete log entries from a given index; e.g. 'deleteLogEntriesFrom 7' should delete every log entry with an index >= 7.

Instances

(MonadIO m, MonadConc m, Serialize v) => RaftDeleteLog (RaftFileStoreT m) v

Defined in Examples.Raft.FileStore

Associated Types

type RaftDeleteLogError (RaftFileStoreT m) :: Type

Methods

deleteLogEntriesFrom :: Index -> RaftFileStoreT m (Either (RaftDeleteLogError (RaftFileStoreT m)) (DeleteSuccess v))

class Monad m => RaftReadLog m v where

Provides an interface for nodes to read log entries from storage.

Minimal complete definition

readLogEntry, readLastLogEntry

Associated Types

type RaftReadLogError m

Methods

readLogEntry :: Exception (RaftReadLogError m) => Index -> m (Either (RaftReadLogError m) (Maybe (Entry v)))

Read the log at a given index

readLogEntriesFrom :: Exception (RaftReadLogError m) => Index -> m (Either (RaftReadLogError m) (Entries v))

Read log entries from a specific index onwards, including the specific index

readLastLogEntry :: Exception (RaftReadLogError m) => m (Either (RaftReadLogError m) (Maybe (Entry v)))

Read the last log entry in the log

readLogEntriesFrom :: Exception (RaftReadLogError m) => Index -> m (Either (RaftReadLogError m) (Entries v))

Read log entries from a specific index onwards, including the specific index

Instances

(MonadIO m, MonadConc m, Serialize v) => RaftReadLog (RaftFileStoreT m) v

Defined in Examples.Raft.FileStore

Associated Types

type RaftReadLogError (RaftFileStoreT m) :: Type

Methods

readLogEntry :: Index -> RaftFileStoreT m (Either (RaftReadLogError (RaftFileStoreT m)) (Maybe (Entry v)))

readLogEntriesFrom :: Index -> RaftFileStoreT m (Either (RaftReadLogError (RaftFileStoreT m)) (Entries v))

readLastLogEntry :: RaftFileStoreT m (Either (RaftReadLogError (RaftFileStoreT m)) (Maybe (Entry v)))

type RaftLog m v = (RaftReadLog m v, RaftWriteLog m v, RaftDeleteLog m v)

type RaftLogExceptions m = (Exception (RaftReadLogError m), Exception (RaftWriteLogError m), Exception (RaftDeleteLogError m))

data RaftLogError m

Representation of possible errors that come from reading, writing or deleting logs from the persistent storage

Constructors

RaftLogReadError (RaftReadLogError m)

RaftLogWriteError (RaftWriteLogError m)

RaftLogDeleteError (RaftDeleteLogError m)

updateLog :: forall m v. (RaftDeleteLog m v, Exception (RaftDeleteLogError m), RaftWriteLog m v, Exception (RaftWriteLogError m)) => Entries v -> m (Either (RaftLogError m) ())