Safe Haskell	None
Language	Haskell2010

Raft.Persistent

Synopsis

class Monad m => RaftPersist m where
- type RaftPersistError m
- readPersistentState :: Exception (RaftPersistError m) => m (Either (RaftPersistError m) PersistentState)
- writePersistentState :: Exception (RaftPersistError m) => PersistentState -> m (Either (RaftPersistError m) ())
data PersistentState = PersistentState {
- currentTerm :: Term
- votedFor :: Maybe NodeId
}
initPersistentState :: PersistentState

Documentation

class Monad m => RaftPersist m where #

Provides an interface to read and write the persistent state to disk.

Associated Types

type RaftPersistError m #

Methods

readPersistentState :: Exception (RaftPersistError m) => m (Either (RaftPersistError m) PersistentState) #

writePersistentState :: Exception (RaftPersistError m) => PersistentState -> m (Either (RaftPersistError m) ()) #

Instances

(MonadIO m, MonadConc m) => RaftPersist (RaftFileStoreT m) #
Instance details Defined in Examples.Raft.FileStore Associated Types type RaftPersistError (RaftFileStoreT m) :: Type # Methods readPersistentState :: RaftFileStoreT m (Either (RaftPersistError (RaftFileStoreT m)) PersistentState) # writePersistentState :: PersistentState -> RaftFileStoreT m (Either (RaftPersistError (RaftFileStoreT m)) ()) #

data PersistentState #

Persistent state that all Raft nodes maintain, regardless of node state.

Constructors

PersistentState
Fields currentTerm :: Term Last term server has seen votedFor :: Maybe NodeId Candidate id that received vote in current term

Instances

Show PersistentState #
Instance details Defined in Raft.Persistent Methods showsPrec :: Int -> PersistentState -> ShowS # show :: PersistentState -> String # showList :: [PersistentState] -> ShowS #
Generic PersistentState #
Instance details Defined in Raft.Persistent Associated Types type Rep PersistentState :: Type -> Type # Methods from :: PersistentState -> Rep PersistentState x # to :: Rep PersistentState x -> PersistentState #
Serialize PersistentState #
Instance details Defined in Raft.Persistent Methods put :: Putter PersistentState # get :: Get PersistentState #
MonadState PersistentState (TransitionM sm v) #
Instance details Defined in Raft.Monad Methods get :: TransitionM sm v PersistentState # put :: PersistentState -> TransitionM sm v () # state :: (PersistentState -> (a, PersistentState)) -> TransitionM sm v a #
RaftLogger (RWS (TransitionEnv sm) [Action sm v] PersistentState) #
Instance details Defined in Raft.Monad Methods loggerNodeId :: RWS (TransitionEnv sm) [Action sm v] PersistentState NodeId # loggerNodeState :: RWS (TransitionEnv sm) [Action sm v] PersistentState RaftNodeState #
type Rep PersistentState #
Instance details Defined in Raft.Persistent type Rep PersistentState = D1 (MetaData "PersistentState" "Raft.Persistent" "libraft-0.1.1.0-K88ErXXABXGJHe9OF75EJD" False) (C1 (MetaCons "PersistentState" PrefixI True) (S1 (MetaSel (Just "currentTerm") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Term) :*: S1 (MetaSel (Just "votedFor") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe NodeId))))

initPersistentState :: PersistentState #

A node initiates its persistent state with term 0 and with its vote blank