Raft.Log

Documentation

data EntryIssuer

Constructors

ClientIssuer ClientId SerialNum

LeaderIssuer LeaderId

Instances

Eq EntryIssuer

Defined in Raft.Log

Methods

(==) :: EntryIssuer -> EntryIssuer -> Bool

(/=) :: EntryIssuer -> EntryIssuer -> Bool

Read EntryIssuer

Defined in Raft.Log

Methods

readsPrec :: Int -> ReadS EntryIssuer

readList :: ReadS [EntryIssuer]

readPrec :: ReadPrec EntryIssuer

readListPrec :: ReadPrec [EntryIssuer]

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

FromField EntryIssuer

Defined in Raft.Log

Methods

fromField :: FieldParser EntryIssuer

ToField EntryIssuer

Defined in Raft.Log

Methods

toField :: EntryIssuer -> Action

type Rep EntryIssuer

Defined in Raft.Log

type Rep EntryIssuer = D1 (MetaData "EntryIssuer" "Raft.Log" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "ClientIssuer" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ClientId) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SerialNum)) :+: 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

Eq v => Eq (EntryValue v)

Defined in Raft.Log

Methods

(==) :: EntryValue v -> EntryValue v -> Bool

(/=) :: EntryValue v -> EntryValue v -> Bool

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)

(Typeable v, Serialize v) => FromField (EntryValue v)

Defined in Raft.Log

Methods

fromField :: FieldParser (EntryValue v)

Serialize v => ToField (EntryValue v)

Defined in Raft.Log

Methods

toField :: EntryValue v -> Action

type Rep (EntryValue v)

Defined in Raft.Log

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

newtype EntryHash

Constructors

EntryHash

Fields

• unEntryHash :: ByteString

Instances

Eq EntryHash

Defined in Raft.Log

Methods

(==) :: EntryHash -> EntryHash -> Bool

(/=) :: EntryHash -> EntryHash -> Bool

Ord EntryHash

Defined in Raft.Log

Methods

compare :: EntryHash -> EntryHash -> Ordering

(<) :: EntryHash -> EntryHash -> Bool

(<=) :: EntryHash -> EntryHash -> Bool

(>) :: EntryHash -> EntryHash -> Bool

(>=) :: EntryHash -> EntryHash -> Bool

max :: EntryHash -> EntryHash -> EntryHash

min :: EntryHash -> EntryHash -> EntryHash

Read EntryHash

Defined in Raft.Log

Methods

readsPrec :: Int -> ReadS EntryHash

readList :: ReadS [EntryHash]

readPrec :: ReadPrec EntryHash

readListPrec :: ReadPrec [EntryHash]

Show EntryHash

Defined in Raft.Log

Methods

showsPrec :: Int -> EntryHash -> ShowS

show :: EntryHash -> String

showList :: [EntryHash] -> ShowS

Generic EntryHash

Defined in Raft.Log

Associated Types

type Rep EntryHash :: Type -> Type

Methods

from :: EntryHash -> Rep EntryHash x

to :: Rep EntryHash x -> EntryHash

Serialize EntryHash

Defined in Raft.Log

Methods

put :: Putter EntryHash

get :: Get EntryHash

FromField EntryHash

Defined in Raft.Log

Methods

fromField :: FieldParser EntryHash

ToField EntryHash

Defined in Raft.Log

Methods

toField :: EntryHash -> Action

type Rep EntryHash

Defined in Raft.Log

type Rep EntryHash = D1 (MetaData "EntryHash" "Raft.Log" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" True) (C1 (MetaCons "EntryHash" PrefixI True) (S1 (MetaSel (Just "unEntryHash") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)))

genesisHash :: EntryHash

hashEntry :: Serialize v => Entry v -> EntryHash

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

• entryPrevHash :: EntryHash

Instances

Eq v => Eq (Entry v)

Defined in Raft.Log

Methods

(==) :: Entry v -> Entry v -> Bool

(/=) :: Entry v -> Entry v -> Bool

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.5.0.0-J9sQlo4v2xjSwCkwompQR" 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) :*: S1 (MetaSel (Just "entryPrevHash") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 EntryHash)))))

type Entries v = Seq (Entry v)

lastEntryIndex :: Entries v -> Maybe Index

data LastLogEntry v

The datatype representing a node's last log entry

Constructors

LastLogEntry (Entry v)

NoLogEntries

Instances

Show v => Show (LastLogEntry v)

Defined in Raft.Log

Methods

showsPrec :: Int -> LastLogEntry v -> ShowS

show :: LastLogEntry v -> String

showList :: [LastLogEntry v] -> ShowS

hashLastLogEntry :: Serialize v => LastLogEntry v -> EntryHash

lastLogEntryIndex :: LastLogEntry v -> Index

lastLogEntryIssuer :: LastLogEntry v -> Maybe EntryIssuer

lastLogEntryTerm :: LastLogEntry v -> Term

lastLogEntryIndexAndTerm :: LastLogEntry v -> (Index, Term)

class RaftInitLog m v where

Provides an interface to initialize a fresh log entry storage

Associated Types

type RaftInitLogError m

Methods

initializeLog :: Proxy v -> m (Either (RaftInitLogError m) ())

Instances

MonadIO m => RaftInitLog (RaftPostgresT m) v

Defined in Raft.Log.PostgreSQL

Associated Types

type RaftInitLogError (RaftPostgresT m) :: Type

Methods

initializeLog :: Proxy v -> RaftPostgresT m (Either (RaftInitLogError (RaftPostgresT m)) ())

(MonadIO m, RaftInitLog m v) => RaftInitLog (RaftPersistFileStoreT m) v

Defined in Examples.Raft.FileStore.Persistent

Associated Types

type RaftInitLogError (RaftPersistFileStoreT m) :: Type

Methods

initializeLog :: Proxy v -> RaftPersistFileStoreT m (Either (RaftInitLogError (RaftPersistFileStoreT m)) ())

(Serialize v, MonadIO m) => RaftInitLog (RaftLogFileStoreT m) v

Defined in Examples.Raft.FileStore.Log

Associated Types

type RaftInitLogError (RaftLogFileStoreT m) :: Type

Methods

initializeLog :: Proxy v -> RaftLogFileStoreT m (Either (RaftInitLogError (RaftLogFileStoreT m)) ())

(MonadIO m, RaftInitLog m v) => RaftInitLog (RaftSocketT sm v m) v

Defined in Examples.Raft.Socket.Node

Associated Types

type RaftInitLogError (RaftSocketT sm v m) :: Type

Methods

initializeLog :: Proxy v -> RaftSocketT sm v m (Either (RaftInitLogError (RaftSocketT sm v m)) ())

data ReadEntriesSpec

Constructors

ByIndex Index

ByIndices IndexInterval

Instances

Show ReadEntriesSpec

Defined in Raft.Log

Methods

showsPrec :: Int -> ReadEntriesSpec -> ShowS

show :: ReadEntriesSpec -> String

showList :: [ReadEntriesSpec] -> ShowS

Generic ReadEntriesSpec

Defined in Raft.Log

Associated Types

type Rep ReadEntriesSpec :: Type -> Type

Methods

from :: ReadEntriesSpec -> Rep ReadEntriesSpec x

to :: Rep ReadEntriesSpec x -> ReadEntriesSpec

Serialize ReadEntriesSpec

Defined in Raft.Log

Methods

put :: Putter ReadEntriesSpec

get :: Get ReadEntriesSpec

type Rep ReadEntriesSpec

Defined in Raft.Log

type Rep ReadEntriesSpec = D1 (MetaData "ReadEntriesSpec" "Raft.Log" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "ByIndex" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Index)) :+: C1 (MetaCons "ByIndices" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 IndexInterval)))

data ReadEntriesRes v

The result of reading one or more

Constructors

OneEntry (Entry v)

ManyEntries (Entries v)

data IndexInterval

Constructors

IndexInterval (Maybe Index) (Maybe Index)

Instances

Show IndexInterval

Defined in Raft.Log

Methods

showsPrec :: Int -> IndexInterval -> ShowS

show :: IndexInterval -> String

showList :: [IndexInterval] -> ShowS

Generic IndexInterval

Defined in Raft.Log

Associated Types

type Rep IndexInterval :: Type -> Type

Methods

from :: IndexInterval -> Rep IndexInterval x

to :: Rep IndexInterval x -> IndexInterval

Serialize IndexInterval

Defined in Raft.Log

Methods

put :: Putter IndexInterval

get :: Get IndexInterval

type Rep IndexInterval

Defined in Raft.Log

type Rep IndexInterval = D1 (MetaData "IndexInterval" "Raft.Log" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "IndexInterval" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Index)) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Index))))

class (Show (RaftReadLogError m), 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

(Typeable v, Serialize v, MonadIO m) => RaftReadLog (RaftPostgresT m) v

Defined in Raft.Log.PostgreSQL

Associated Types

type RaftReadLogError (RaftPostgresT m) :: Type

Methods

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

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

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

RaftReadLog m v => RaftReadLog (RaftPersistFileStoreT m) v

Defined in Examples.Raft.FileStore.Persistent

Associated Types

type RaftReadLogError (RaftPersistFileStoreT m) :: Type

Methods

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

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

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

(MonadIO m, Serialize v) => RaftReadLog (RaftLogFileStoreT m) v

Defined in Examples.Raft.FileStore.Log

Associated Types

type RaftReadLogError (RaftLogFileStoreT m) :: Type

Methods

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

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

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

RaftReadLog m v => RaftReadLog (RaftSocketT sm v m) v

Defined in Examples.Raft.Socket.Node

Associated Types

type RaftReadLogError (RaftSocketT sm v m) :: Type

Methods

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

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

readLastLogEntry :: RaftSocketT sm v m (Either (RaftReadLogError (RaftSocketT sm v m)) (Maybe (Entry v)))

class (Show (RaftWriteLogError m), 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

(Serialize v, MonadIO m) => RaftWriteLog (RaftPostgresT m) v

Defined in Raft.Log.PostgreSQL

Associated Types

type RaftWriteLogError (RaftPostgresT m) :: Type

Methods

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

RaftWriteLog m v => RaftWriteLog (RaftPersistFileStoreT m) v

Defined in Examples.Raft.FileStore.Persistent

Associated Types

type RaftWriteLogError (RaftPersistFileStoreT m) :: Type

Methods

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

(MonadIO m, Serialize v) => RaftWriteLog (RaftLogFileStoreT m) v

Defined in Examples.Raft.FileStore.Log

Associated Types

type RaftWriteLogError (RaftLogFileStoreT m) :: Type

Methods

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

RaftWriteLog m v => RaftWriteLog (RaftSocketT sm v m) v

Defined in Examples.Raft.Socket.Node

Associated Types

type RaftWriteLogError (RaftSocketT sm v m) :: Type

Methods

writeLogEntries :: Entries v -> RaftSocketT sm v m (Either (RaftWriteLogError (RaftSocketT sm v m)) ())

class (Show (RaftDeleteLogError m), 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

(Serialize v, MonadIO m) => RaftDeleteLog (RaftPostgresT m) v

Defined in Raft.Log.PostgreSQL

Associated Types

type RaftDeleteLogError (RaftPostgresT m) :: Type

Methods

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

RaftDeleteLog m v => RaftDeleteLog (RaftPersistFileStoreT m) v

Defined in Examples.Raft.FileStore.Persistent

Associated Types

type RaftDeleteLogError (RaftPersistFileStoreT m) :: Type

Methods

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

(MonadIO m, Serialize v) => RaftDeleteLog (RaftLogFileStoreT m) v

Defined in Examples.Raft.FileStore.Log

Associated Types

type RaftDeleteLogError (RaftLogFileStoreT m) :: Type

Methods

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

RaftDeleteLog m v => RaftDeleteLog (RaftSocketT sm v m) v

Defined in Examples.Raft.Socket.Node

Associated Types

type RaftDeleteLogError (RaftSocketT sm v m) :: Type

Methods

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

data DeleteSuccess v

Constructors

DeleteSuccess

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

data RaftLogError m

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

Instances

Show (RaftLogError m)

Defined in Raft.Log

Methods

showsPrec :: Int -> RaftLogError m -> ShowS

show :: RaftLogError m -> String

showList :: [RaftLogError m] -> ShowS

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

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

clientReqData :: Entries v -> Map ClientId (SerialNum, Index)

readEntries :: forall m v. (RaftReadLog m v, Exception (RaftReadLogError m)) => ReadEntriesSpec -> m (Either (ReadEntriesError m) (ReadEntriesRes v))