Safe Haskell	None
Language	Haskell2010

Raft.Persistent

Synopsis

class Monad m => RaftPersist m where
- type RaftPersistError m
- initializePersistentState :: Exception (RaftPersistError m) => m (Either (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 Source #

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

Associated Types

type RaftPersistError m Source #

Methods

initializePersistentState :: Exception (RaftPersistError m) => m (Either (RaftPersistError m) ()) Source #

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

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

Instances

RaftPersist m => RaftPersist (RaftPostgresT m) Source #
Instance details Defined in Raft.Log.PostgreSQL Associated Types type RaftPersistError (RaftPostgresT m) :: Type Source # Methods initializePersistentState :: RaftPostgresT m (Either (RaftPersistError (RaftPostgresT m)) ()) Source # readPersistentState :: RaftPostgresT m (Either (RaftPersistError (RaftPostgresT m)) PersistentState) Source # writePersistentState :: PersistentState -> RaftPostgresT m (Either (RaftPersistError (RaftPostgresT m)) ()) Source #
MonadIO m => RaftPersist (RaftPersistFileStoreT m) Source #
Instance details Defined in Examples.Raft.FileStore.Persistent Associated Types type RaftPersistError (RaftPersistFileStoreT m) :: Type Source # Methods initializePersistentState :: RaftPersistFileStoreT m (Either (RaftPersistError (RaftPersistFileStoreT m)) ()) Source # readPersistentState :: RaftPersistFileStoreT m (Either (RaftPersistError (RaftPersistFileStoreT m)) PersistentState) Source # writePersistentState :: PersistentState -> RaftPersistFileStoreT m (Either (RaftPersistError (RaftPersistFileStoreT m)) ()) Source #
RaftPersist m => RaftPersist (RaftLogFileStoreT m) Source #
Instance details Defined in Examples.Raft.FileStore.Log Associated Types type RaftPersistError (RaftLogFileStoreT m) :: Type Source # Methods initializePersistentState :: RaftLogFileStoreT m (Either (RaftPersistError (RaftLogFileStoreT m)) ()) Source # readPersistentState :: RaftLogFileStoreT m (Either (RaftPersistError (RaftLogFileStoreT m)) PersistentState) Source # writePersistentState :: PersistentState -> RaftLogFileStoreT m (Either (RaftPersistError (RaftLogFileStoreT m)) ()) Source #
(MonadIO m, RaftPersist m) => RaftPersist (RaftSocketT sm v m) Source #
Instance details Defined in Examples.Raft.Socket.Node Associated Types type RaftPersistError (RaftSocketT sm v m) :: Type Source # Methods initializePersistentState :: RaftSocketT sm v m (Either (RaftPersistError (RaftSocketT sm v m)) ()) Source # readPersistentState :: RaftSocketT sm v m (Either (RaftPersistError (RaftSocketT sm v m)) PersistentState) Source # writePersistentState :: PersistentState -> RaftSocketT sm v m (Either (RaftPersistError (RaftSocketT sm v m)) ()) Source #

data PersistentState Source #

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

Eq PersistentState Source #
Instance details Defined in Raft.Persistent Methods (==) :: PersistentState -> PersistentState -> Bool # (/=) :: PersistentState -> PersistentState -> Bool #
Show PersistentState Source #
Instance details Defined in Raft.Persistent Methods showsPrec :: Int -> PersistentState -> ShowS # show :: PersistentState -> String # showList :: [PersistentState] -> ShowS #
Generic PersistentState Source #
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 Source #
Instance details Defined in Raft.Persistent Methods put :: Putter PersistentState # get :: Get PersistentState #
MonadState PersistentState (TransitionM sm v) Source #
Instance details Defined in Raft.Transition Methods get :: TransitionM sm v PersistentState # put :: PersistentState -> TransitionM sm v () # state :: (PersistentState -> (a, PersistentState)) -> TransitionM sm v a #
RaftLogger v (RWS (TransitionEnv sm v) [Action sm v] PersistentState) Source #
Instance details Defined in Raft.Transition Methods loggerCtx :: RWS (TransitionEnv sm v) [Action sm v] PersistentState (NodeId, RaftNodeState v) Source #
type Rep PersistentState Source #
Instance details Defined in Raft.Persistent type Rep PersistentState = D1 (MetaData "PersistentState" "Raft.Persistent" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "PersistentState" PrefixI True) (S1 (MetaSel (Just "currentTerm") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Term) :*: S1 (MetaSel (Just "votedFor") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe NodeId))))

initPersistentState :: PersistentState Source #

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