Safe Haskell	None
Language	Haskell2010

Raft

Contents

State machine type class
Networking type classes
Client data types
Configuration
Events
Log
Logging
Raft node states
Persistent state
Basic types
RPC

Synopsis

class RaftStateMachinePure sm v | sm -> v where
- data RaftStateMachinePureError sm v
- type RaftStateMachinePureCtx sm v = ctx | ctx -> sm v
- rsmTransition :: RaftStateMachinePureCtx sm v -> sm -> v -> Either (RaftStateMachinePureError sm v) sm
class (Monad m, RaftStateMachinePure sm v) => RaftStateMachine m sm v where
- validateCmd :: v -> m (Either (RaftStateMachinePureError sm v) ())
- preprocessCmd :: v -> m v
- askRaftStateMachinePureCtx :: m (RaftStateMachinePureCtx sm v)
class RaftSendRPC m v where
- sendRPC :: NodeId -> RPCMessage v -> m ()
class Show (RaftRecvRPCError m v) => RaftRecvRPC m v where
- type RaftRecvRPCError m v
- receiveRPC :: m (Either (RaftRecvRPCError m v) (RPCMessage v))
class RaftStateMachinePure sm v => RaftSendClient m sm v where
- sendClient :: ClientId -> ClientResponse sm v -> m ()
class Show (RaftRecvClientError m v) => RaftRecvClient m v where
- type RaftRecvClientError m v
- receiveClient :: m (Either (RaftRecvClientError m v) (ClientRequest v))
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 RaftEnv v m = RaftEnv {
- eventChan :: RaftEventChan v m
- resetElectionTimer :: m ()
- resetHeartbeatTimer :: m ()
- raftNodeConfig :: RaftNodeConfig
- raftNodeLogCtx :: LogCtx (RaftT v m)
- raftNodeMetrics :: Metrics
}
runRaftNode :: forall m sm v. (Typeable m, Show v, Show sm, Serialize v, Show (Action sm v), Show (RaftLogError m), Show (RaftStateMachinePureError sm v), MonadIO m, MonadCatch m, MonadFail m, MonadMask m, MonadRaft v m, RaftStateMachine m sm v, RaftSendRPC m v, RaftRecvRPC m v, RaftSendClient m sm v, RaftRecvClient m v, RaftLog m v, RaftLogExceptions m, RaftPersist m, Exception (RaftPersistError m)) => RaftNodeConfig -> OptionalRaftNodeConfig -> LogCtx (RaftT v m) -> sm -> m ()
runRaftT :: Monad m => RaftNodeState v -> RaftEnv v m -> RaftT v m a -> m a
handleEventLoop :: forall sm v m. (Show v, Serialize v, Show sm, Show (Action sm v), Show (RaftLogError m), Typeable m, MonadIO m, MonadRaft v m, MonadFail m, MonadThrow m, MonadMask m, RaftStateMachine m sm v, Show (RaftStateMachinePureError sm v), RaftPersist m, RaftSendRPC m v, RaftSendClient m sm v, RaftLog m v, RaftLogExceptions m, RaftPersist m, Exception (RaftPersistError m)) => sm -> RaftT v m ()
data ClientRequest v = ClientRequest ClientId (ClientReq v)
data ClientReq v
- = ClientReadReq ClientReadReq
- | ClientWriteReq (ClientWriteReq v)
- | ClientMetricsReq ClientMetricsReq
data ClientResponse sm v
- = ClientReadResponse (ClientReadResp sm v)
- | ClientWriteResponse (ClientWriteResp sm v)
- | ClientRedirectResponse ClientRedirResp
- | ClientMetricsResponse ClientMetricsResp
data ClientReadResp sm v
- = ClientReadRespStateMachine sm
- | ClientReadRespEntry (Entry v)
- | ClientReadRespEntries (Entries v)
data ClientWriteResp sm v
- = ClientWriteRespSuccess Index SerialNum
- | ClientWriteRespFail SerialNum (RaftStateMachinePureError sm v)
data ClientRedirResp = ClientRedirResp CurrentLeader
data RaftNodeConfig = RaftNodeConfig {
- raftConfigNodeId :: NodeId
- raftConfigNodeIds :: NodeIds
- raftConfigElectionTimeout :: (Natural, Natural)
- raftConfigHeartbeatTimeout :: Natural
- raftConfigStorageState :: StorageState
}
data Event v
- = MessageEvent (MessageEvent v)
- | TimeoutEvent SystemTime Timeout
data Timeout
- = ElectionTimeout
- | HeartbeatTimeout
data MessageEvent v
- = RPCMessageEvent (RPCMessage v)
- | ClientRequestEvent (ClientRequest v)
data Entry v = Entry {
- entryIndex :: Index
- entryTerm :: Term
- entryValue :: EntryValue v
- entryIssuer :: EntryIssuer
- entryPrevHash :: EntryHash
}
type Entries v = Seq (Entry v)
class (Show (RaftWriteLogError m), Monad m) => RaftWriteLog m v where
- type RaftWriteLogError m
- writeLogEntries :: Exception (RaftWriteLogError m) => Entries v -> m (Either (RaftWriteLogError m) ())
data DeleteSuccess v = DeleteSuccess
class (Show (RaftDeleteLogError m), Monad m) => RaftDeleteLog m v where
- type RaftDeleteLogError m
- deleteLogEntriesFrom :: Exception (RaftDeleteLogError m) => Index -> m (Either (RaftDeleteLogError m) (DeleteSuccess v))
class (Show (RaftReadLogError m), Monad m) => RaftReadLog m v where
- type RaftReadLogError m
- readLogEntry :: Exception (RaftReadLogError m) => Index -> m (Either (RaftReadLogError m) (Maybe (Entry v)))
- readLogEntriesFrom :: Exception (RaftReadLogError m) => Index -> m (Either (RaftReadLogError m) (Entries v))
- readLastLogEntry :: Exception (RaftReadLogError m) => m (Either (RaftReadLogError m) (Maybe (Entry v)))
type RaftLog m v = (RaftInitLog m v, RaftReadLog m v, RaftWriteLog m v, RaftDeleteLog m v)
data RaftLogError m
type RaftLogExceptions m = (Exception (RaftInitLogError m), Exception (RaftReadLogError m), Exception (RaftWriteLogError m), Exception (RaftDeleteLogError m))
data LogCtx m
- = LogCtx {
  - logCtxDest :: LogDest m
  - logCtxSeverity :: Severity
  }
- | NoLogs
data LogDest m
- = LogWith (MonadIO m => Severity -> Text -> m ())
- | LogFile FilePath
- | LogStdout
data Severity
- = Debug
- | Info
- | Critical
data Mode
- = Follower
- | Candidate
- | Leader
data RaftNodeState v where
- RaftNodeState :: {..} -> RaftNodeState v
data NodeState (a :: Mode) v where
- NodeFollowerState :: FollowerState v -> NodeState Follower v
- NodeCandidateState :: CandidateState v -> NodeState Candidate v
- NodeLeaderState :: LeaderState v -> NodeState Leader v
data CurrentLeader
- = CurrentLeader LeaderId
- | NoLeader
data FollowerState v = FollowerState {
- fsCurrentLeader :: CurrentLeader
- fsCommitIndex :: Index
- fsLastApplied :: Index
- fsLastLogEntry :: LastLogEntry v
- fsTermAtAEPrevIndex :: Maybe Term
- fsClientReqCache :: ClientWriteReqCache
}
data CandidateState v = CandidateState {
- csCommitIndex :: Index
- csLastApplied :: Index
- csVotes :: NodeIds
- csLastLogEntry :: LastLogEntry v
- csClientReqCache :: ClientWriteReqCache
}
data LeaderState v = LeaderState {
- lsCommitIndex :: Index
- lsLastApplied :: Index
- lsNextIndex :: Map NodeId Index
- lsMatchIndex :: Map NodeId Index
- lsLastLogEntry :: LastLogEntry v
- lsReadReqsHandled :: Int
- lsReadRequest :: ClientReadReqs
- lsClientReqCache :: ClientWriteReqCache
}
initRaftNodeState :: RaftNodeState v
isFollower :: NodeState s v -> Bool
isCandidate :: NodeState s v -> Bool
isLeader :: NodeState s v -> Bool
setLastLogEntry :: NodeState s v -> Entries v -> NodeState s v
getLastLogEntry :: NodeState ns v -> LastLogEntry v
getLastAppliedAndCommitIndex :: NodeState ns v -> (Index, Index)
data PersistentState = PersistentState {
- currentTerm :: !Term
- votedFor :: !(Maybe NodeId)
}
initPersistentState :: PersistentState
type NodeId = ByteString
type NodeIds = Set NodeId
newtype ClientId = ClientId NodeId
newtype LeaderId = LeaderId {
- unLeaderId :: NodeId
}
newtype Term = Term Natural
newtype Index = Index Natural
term0 :: Term
index0 :: Index
data RPC v
- = AppendEntriesRPC (AppendEntries v)
- | AppendEntriesResponseRPC AppendEntriesResponse
- | RequestVoteRPC RequestVote
- | RequestVoteResponseRPC RequestVoteResponse
class RPCType a v where
- toRPC :: a -> RPC v
data RPCMessage v = RPCMessage {
- sender :: NodeId
- rpc :: RPC v
}
data AppendEntries v = AppendEntries {
- aeTerm :: Term
- aeLeaderId :: LeaderId
- aePrevLogIndex :: Index
- aePrevLogTerm :: Term
- aeEntries :: Entries v
- aeLeaderCommit :: Index
- aeReadRequest :: Maybe Int
}
data AppendEntriesResponse = AppendEntriesResponse {
- aerTerm :: Term
- aerSuccess :: Bool
- aerReadRequest :: Maybe Int
}
data RequestVote = RequestVote {
- rvTerm :: Term
- rvCandidateId :: NodeId
- rvLastLogIndex :: Index
- rvLastLogTerm :: Term
}
data RequestVoteResponse = RequestVoteResponse {
- rvrTerm :: Term
- rvrVoteGranted :: Bool
}
data AppendEntriesData v = AppendEntriesData {
- aedTerm :: Term
- aedLeaderCommit :: Index
- aedEntriesSpec :: AppendEntriesSpec v
}

State machine type class

class RaftStateMachinePure sm v | sm -> v where Source #

Interface to handle commands in the underlying state machine. Functional dependency permitting only a single state machine command to be defined to update the state machine.

Associated Types

data RaftStateMachinePureError sm v Source #

type RaftStateMachinePureCtx sm v = ctx | ctx -> sm v Source #

Methods

rsmTransition :: RaftStateMachinePureCtx sm v -> sm -> v -> Either (RaftStateMachinePureError sm v) sm Source #

class (Monad m, RaftStateMachinePure sm v) => RaftStateMachine m sm v where Source #

Minimal complete definition

validateCmd, askRaftStateMachinePureCtx

Methods

validateCmd :: v -> m (Either (RaftStateMachinePureError sm v) ()) Source #

Expensive validation using global state not cacheable in RaftStateMachinePureCtx

preprocessCmd :: v -> m v Source #

Some state machines need the leader to preprocess commands issued by client; e.g. attaching a timestamp before creating the log entry

askRaftStateMachinePureCtx :: m (RaftStateMachinePureCtx sm v) Source #

Query the RaftStateMachinePureCtx value from the monadic context

preprocessCmd :: v -> m v Source #

Some state machines need the leader to preprocess commands issued by client; e.g. attaching a timestamp before creating the log entry

Instances

RaftStateMachine m sm v => RaftStateMachine (RaftPostgresT m) sm v Source #
Instance details Defined in Raft.Log.PostgreSQL Methods validateCmd :: v -> RaftPostgresT m (Either (RaftStateMachinePureError sm v) ()) Source # preprocessCmd :: v -> RaftPostgresT m v Source # askRaftStateMachinePureCtx :: RaftPostgresT m (RaftStateMachinePureCtx sm v) Source #
RaftStateMachine m sm v => RaftStateMachine (RaftPersistFileStoreT m) sm v Source #
Instance details Defined in Examples.Raft.FileStore.Persistent Methods validateCmd :: v -> RaftPersistFileStoreT m (Either (RaftStateMachinePureError sm v) ()) Source # preprocessCmd :: v -> RaftPersistFileStoreT m v Source # askRaftStateMachinePureCtx :: RaftPersistFileStoreT m (RaftStateMachinePureCtx sm v) Source #
RaftStateMachine m sm v => RaftStateMachine (RaftLogFileStoreT m) sm v Source #
Instance details Defined in Examples.Raft.FileStore.Log Methods validateCmd :: v -> RaftLogFileStoreT m (Either (RaftStateMachinePureError sm v) ()) Source # preprocessCmd :: v -> RaftLogFileStoreT m v Source # askRaftStateMachinePureCtx :: RaftLogFileStoreT m (RaftStateMachinePureCtx sm v) Source #
RaftStateMachine m sm v => RaftStateMachine (RaftSocketT sm v m) sm v Source #
Instance details Defined in Examples.Raft.Socket.Node Methods validateCmd :: v -> RaftSocketT sm v m (Either (RaftStateMachinePureError sm v) ()) Source # preprocessCmd :: v -> RaftSocketT sm v m v Source # askRaftStateMachinePureCtx :: RaftSocketT sm v m (RaftStateMachinePureCtx sm v) Source #

Networking type classes

class RaftSendRPC m v where Source #

Interface for nodes to send messages to one another. E.g. Control.Concurrent.Chan, Network.Socket, etc.

Methods

sendRPC :: NodeId -> RPCMessage v -> m () Source #

Instances

(Monad m, RaftSendRPC m v) => RaftSendRPC (RaftPostgresT m) v Source #
Instance details Defined in Raft.Log.PostgreSQL Methods sendRPC :: NodeId -> RPCMessage v -> RaftPostgresT m () Source #
(MonadIO m, MonadMask m, RaftSendRPC m v) => RaftSendRPC (RaftPersistFileStoreT m) v Source #
Instance details Defined in Examples.Raft.FileStore.Persistent Methods sendRPC :: NodeId -> RPCMessage v -> RaftPersistFileStoreT m () Source #
(Monad m, RaftSendRPC m v) => RaftSendRPC (RaftLogFileStoreT m) v Source #
Instance details Defined in Examples.Raft.FileStore.Log Methods sendRPC :: NodeId -> RPCMessage v -> RaftLogFileStoreT m () Source #
(MonadCatch m, MonadMask m, MonadIO m, Serialize v, Show v) => RaftSendRPC (RaftSocketT sm v m) v Source #
Instance details Defined in Examples.Raft.Socket.Node Methods sendRPC :: NodeId -> RPCMessage v -> RaftSocketT sm v m () Source #

class Show (RaftRecvRPCError m v) => RaftRecvRPC m v where Source #

Interface for nodes to receive messages from one another

Associated Types

type RaftRecvRPCError m v Source #

Methods

receiveRPC :: m (Either (RaftRecvRPCError m v) (RPCMessage v)) Source #

Instances

(Monad m, RaftRecvRPC m v) => RaftRecvRPC (RaftPostgresT m) v Source #
Instance details Defined in Raft.Log.PostgreSQL Associated Types type RaftRecvRPCError (RaftPostgresT m) v :: Type Source # Methods receiveRPC :: RaftPostgresT m (Either (RaftRecvRPCError (RaftPostgresT m) v) (RPCMessage v)) Source #
(MonadIO m, RaftRecvRPC m v) => RaftRecvRPC (RaftPersistFileStoreT m) v Source #
Instance details Defined in Examples.Raft.FileStore.Persistent Associated Types type RaftRecvRPCError (RaftPersistFileStoreT m) v :: Type Source # Methods receiveRPC :: RaftPersistFileStoreT m (Either (RaftRecvRPCError (RaftPersistFileStoreT m) v) (RPCMessage v)) Source #
(Monad m, RaftRecvRPC m v) => RaftRecvRPC (RaftLogFileStoreT m) v Source #
Instance details Defined in Examples.Raft.FileStore.Log Associated Types type RaftRecvRPCError (RaftLogFileStoreT m) v :: Type Source # Methods receiveRPC :: RaftLogFileStoreT m (Either (RaftRecvRPCError (RaftLogFileStoreT m) v) (RPCMessage v)) Source #
(MonadIO m, Show v) => RaftRecvRPC (RaftSocketT sm v m) v Source #
Instance details Defined in Examples.Raft.Socket.Node Associated Types type RaftRecvRPCError (RaftSocketT sm v m) v :: Type Source # Methods receiveRPC :: RaftSocketT sm v m (Either (RaftRecvRPCError (RaftSocketT sm v m) v) (RPCMessage v)) Source #

class RaftStateMachinePure sm v => RaftSendClient m sm v where Source #

Interface for Raft nodes to send messages to clients

Methods

sendClient :: ClientId -> ClientResponse sm v -> m () Source #

Instances

(Monad m, RaftSendClient m sm v) => RaftSendClient (RaftPostgresT m) sm v Source #
Instance details Defined in Raft.Log.PostgreSQL Methods sendClient :: ClientId -> ClientResponse sm v -> RaftPostgresT m () Source #
(MonadIO m, MonadMask m, RaftSendClient m sm v) => RaftSendClient (RaftPersistFileStoreT m) sm v Source #
Instance details Defined in Examples.Raft.FileStore.Persistent Methods sendClient :: ClientId -> ClientResponse sm v -> RaftPersistFileStoreT m () Source #
(Monad m, RaftSendClient m sm v) => RaftSendClient (RaftLogFileStoreT m) sm v Source #
Instance details Defined in Examples.Raft.FileStore.Log Methods sendClient :: ClientId -> ClientResponse sm v -> RaftLogFileStoreT m () Source #
(RaftStateMachinePure sm v, MonadMask m, MonadCatch m, MonadIO m, Serialize sm, Serialize v) => RaftSendClient (RaftSocketT sm v m) sm v Source #
Instance details Defined in Examples.Raft.Socket.Node Methods sendClient :: ClientId -> ClientResponse sm v -> RaftSocketT sm v m () Source #

class Show (RaftRecvClientError m v) => RaftRecvClient m v where Source #

Interface for Raft nodes to receive messages from clients

Associated Types

type RaftRecvClientError m v Source #

Methods

receiveClient :: m (Either (RaftRecvClientError m v) (ClientRequest v)) Source #

Instances

(Monad m, RaftRecvClient m v) => RaftRecvClient (RaftPostgresT m) v Source #
Instance details Defined in Raft.Log.PostgreSQL Associated Types type RaftRecvClientError (RaftPostgresT m) v :: Type Source # Methods receiveClient :: RaftPostgresT m (Either (RaftRecvClientError (RaftPostgresT m) v) (ClientRequest v)) Source #
(MonadIO m, RaftRecvClient m v) => RaftRecvClient (RaftPersistFileStoreT m) v Source #
Instance details Defined in Examples.Raft.FileStore.Persistent Associated Types type RaftRecvClientError (RaftPersistFileStoreT m) v :: Type Source # Methods receiveClient :: RaftPersistFileStoreT m (Either (RaftRecvClientError (RaftPersistFileStoreT m) v) (ClientRequest v)) Source #
(Monad m, RaftRecvClient m v) => RaftRecvClient (RaftLogFileStoreT m) v Source #
Instance details Defined in Examples.Raft.FileStore.Log Associated Types type RaftRecvClientError (RaftLogFileStoreT m) v :: Type Source # Methods receiveClient :: RaftLogFileStoreT m (Either (RaftRecvClientError (RaftLogFileStoreT m) v) (ClientRequest v)) Source #
(MonadIO m, Serialize v) => RaftRecvClient (RaftSocketT sm v m) v Source #
Instance details Defined in Examples.Raft.Socket.Node Associated Types type RaftRecvClientError (RaftSocketT sm v m) v :: Type Source # Methods receiveClient :: RaftSocketT sm v m (Either (RaftRecvClientError (RaftSocketT sm v m) v) (ClientRequest v)) Source #

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 RaftEnv v m Source #

The raft server environment composed of the concurrent variables used in the effectful raft layer.

Constructors

RaftEnv
Fields eventChan :: RaftEventChan v m resetElectionTimer :: m () resetHeartbeatTimer :: m () raftNodeConfig :: RaftNodeConfig raftNodeLogCtx :: LogCtx (RaftT v m) raftNodeMetrics :: Metrics

Instances

Monad m => MonadReader (RaftEnv v m) (RaftT v m) Source #
Instance details Defined in Raft.Monad Methods ask :: RaftT v m (RaftEnv v m) # local :: (RaftEnv v m -> RaftEnv v m) -> RaftT v m a -> RaftT v m a # reader :: (RaftEnv v m -> a) -> RaftT v m a #

runRaftNode Source #

Arguments

:: (Typeable m, Show v, Show sm, Serialize v, Show (Action sm v), Show (RaftLogError m), Show (RaftStateMachinePureError sm v), MonadIO m, MonadCatch m, MonadFail m, MonadMask m, MonadRaft v m, RaftStateMachine m sm v, RaftSendRPC m v, RaftRecvRPC m v, RaftSendClient m sm v, RaftRecvClient m v, RaftLog m v, RaftLogExceptions m, RaftPersist m, Exception (RaftPersistError m))
=> RaftNodeConfig	Node configuration
-> OptionalRaftNodeConfig	Config values that can be provided optionally
-> LogCtx (RaftT v m)	The means with which to log messages
-> sm	Initial state machine state
-> m ()

Run timers, RPC and client request handlers and start event loop. It should run forever

runRaftT :: Monad m => RaftNodeState v -> RaftEnv v m -> RaftT v m a -> m a Source #

handleEventLoop :: forall sm v m. (Show v, Serialize v, Show sm, Show (Action sm v), Show (RaftLogError m), Typeable m, MonadIO m, MonadRaft v m, MonadFail m, MonadThrow m, MonadMask m, RaftStateMachine m sm v, Show (RaftStateMachinePureError sm v), RaftPersist m, RaftSendRPC m v, RaftSendClient m sm v, RaftLog m v, RaftLogExceptions m, RaftPersist m, Exception (RaftPersistError m)) => sm -> RaftT v m () Source #

Client data types

data ClientRequest v Source #

Representation of a client request coupled with the client id

Constructors

ClientRequest ClientId (ClientReq v)

Instances

Show v => Show (ClientRequest v) Source #
Instance details Defined in Raft.Client Methods showsPrec :: Int -> ClientRequest v -> ShowS # show :: ClientRequest v -> String # showList :: [ClientRequest v] -> ShowS #
Generic (ClientRequest v) Source #
Instance details Defined in Raft.Client Associated Types type Rep (ClientRequest v) :: Type -> Type # Methods from :: ClientRequest v -> Rep (ClientRequest v) x # to :: Rep (ClientRequest v) x -> ClientRequest v #
Serialize v => Serialize (ClientRequest v) Source #
Instance details Defined in Raft.Client Methods put :: Putter (ClientRequest v) # get :: Get (ClientRequest v) #
type Rep (ClientRequest v) Source #
Instance details Defined in Raft.Client type Rep (ClientRequest v) = D1 (MetaData "ClientRequest" "Raft.Client" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "ClientRequest" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ClientId) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ClientReq v))))

data ClientReq v Source #

Representation of a client request

Constructors

ClientReadReq ClientReadReq	Request the latest state of the state machine
ClientWriteReq (ClientWriteReq v)	Write a command
ClientMetricsReq ClientMetricsReq	Request the metrics of a raft node

Instances

Show v => Show (ClientReq v) Source #
Instance details Defined in Raft.Client Methods showsPrec :: Int -> ClientReq v -> ShowS # show :: ClientReq v -> String # showList :: [ClientReq v] -> ShowS #
Generic (ClientReq v) Source #
Instance details Defined in Raft.Client Associated Types type Rep (ClientReq v) :: Type -> Type # Methods from :: ClientReq v -> Rep (ClientReq v) x # to :: Rep (ClientReq v) x -> ClientReq v #
Serialize v => Serialize (ClientReq v) Source #
Instance details Defined in Raft.Client Methods put :: Putter (ClientReq v) # get :: Get (ClientReq v) #
type Rep (ClientReq v) Source #
Instance details Defined in Raft.Client type Rep (ClientReq v) = D1 (MetaData "ClientReq" "Raft.Client" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "ClientReadReq" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ClientReadReq)) :+: (C1 (MetaCons "ClientWriteReq" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ClientWriteReq v))) :+: C1 (MetaCons "ClientMetricsReq" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ClientMetricsReq))))

data ClientResponse sm v Source #

The datatype sent back to the client as an actual response

Constructors

ClientReadResponse (ClientReadResp sm v)	Respond with the latest state of the state machine.
ClientWriteResponse (ClientWriteResp sm v)	Respond with the index of the entry appended to the log
ClientRedirectResponse ClientRedirResp	Respond with the node id of the current leader
ClientMetricsResponse ClientMetricsResp	Respond with the node's current metrics

Instances

(Show sm, Show v, Show (ClientWriteResp sm v)) => Show (ClientResponse sm v) Source #
Instance details Defined in Raft.Client Methods showsPrec :: Int -> ClientResponse sm v -> ShowS # show :: ClientResponse sm v -> String # showList :: [ClientResponse sm v] -> ShowS #
Generic (ClientResponse sm v) Source #
Instance details Defined in Raft.Client Associated Types type Rep (ClientResponse sm v) :: Type -> Type # Methods from :: ClientResponse sm v -> Rep (ClientResponse sm v) x # to :: Rep (ClientResponse sm v) x -> ClientResponse sm v #
(Serialize sm, Serialize v, Serialize (ClientWriteResp sm v)) => Serialize (ClientResponse sm v) Source #
Instance details Defined in Raft.Client Methods put :: Putter (ClientResponse sm v) # get :: Get (ClientResponse sm v) #
type Rep (ClientResponse sm v) Source #
Instance details Defined in Raft.Client type Rep (ClientResponse sm v) = D1 (MetaData "ClientResponse" "Raft.Client" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) ((C1 (MetaCons "ClientReadResponse" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ClientReadResp sm v))) :+: C1 (MetaCons "ClientWriteResponse" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ClientWriteResp sm v)))) :+: (C1 (MetaCons "ClientRedirectResponse" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ClientRedirResp)) :+: C1 (MetaCons "ClientMetricsResponse" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ClientMetricsResp))))

data ClientReadResp sm v Source #

Representation of a read response to a client

Constructors

ClientReadRespStateMachine sm
ClientReadRespEntry (Entry v)
ClientReadRespEntries (Entries v)

Instances

(Show sm, Show v) => Show (ClientReadResp sm v) Source #
Instance details Defined in Raft.Client Methods showsPrec :: Int -> ClientReadResp sm v -> ShowS # show :: ClientReadResp sm v -> String # showList :: [ClientReadResp sm v] -> ShowS #
Generic (ClientReadResp sm v) Source #
Instance details Defined in Raft.Client Associated Types type Rep (ClientReadResp sm v) :: Type -> Type # Methods from :: ClientReadResp sm v -> Rep (ClientReadResp sm v) x # to :: Rep (ClientReadResp sm v) x -> ClientReadResp sm v #
(Serialize sm, Serialize v) => Serialize (ClientReadResp sm v) Source #
Instance details Defined in Raft.Client Methods put :: Putter (ClientReadResp sm v) # get :: Get (ClientReadResp sm v) #
type Rep (ClientReadResp sm v) Source #
Instance details Defined in Raft.Client type Rep (ClientReadResp sm v) = D1 (MetaData "ClientReadResp" "Raft.Client" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "ClientReadRespStateMachine" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 sm)) :+: (C1 (MetaCons "ClientReadRespEntry" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Entry v))) :+: C1 (MetaCons "ClientReadRespEntries" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Entries v)))))

data ClientWriteResp sm v Source #

Representation of a write response to a client

Constructors

ClientWriteRespSuccess Index SerialNum	Index of the entry appended to the log due to the previous client request
ClientWriteRespFail SerialNum (RaftStateMachinePureError sm v)

Instances

(Show sm, Show v, Show (RaftStateMachinePureError sm v)) => Show (ClientWriteResp sm v) Source #
Instance details Defined in Raft.Client Methods showsPrec :: Int -> ClientWriteResp sm v -> ShowS # show :: ClientWriteResp sm v -> String # showList :: [ClientWriteResp sm v] -> ShowS #
Generic (ClientWriteResp sm v) Source #
Instance details Defined in Raft.Client Associated Types type Rep (ClientWriteResp sm v) :: Type -> Type # Methods from :: ClientWriteResp sm v -> Rep (ClientWriteResp sm v) x # to :: Rep (ClientWriteResp sm v) x -> ClientWriteResp sm v #
(Serialize sm, Serialize v, Serialize (RaftStateMachinePureError sm v)) => Serialize (ClientWriteResp sm v) Source #
Instance details Defined in Raft.Client Methods put :: Putter (ClientWriteResp sm v) # get :: Get (ClientWriteResp sm v) #
type Rep (ClientWriteResp sm v) Source #
Instance details Defined in Raft.Client type Rep (ClientWriteResp sm v) = D1 (MetaData "ClientWriteResp" "Raft.Client" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "ClientWriteRespSuccess" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Index) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SerialNum)) :+: C1 (MetaCons "ClientWriteRespFail" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SerialNum) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (RaftStateMachinePureError sm v))))

data ClientRedirResp Source #

Representation of a redirect response to a client

Constructors

ClientRedirResp CurrentLeader

Instances

Show ClientRedirResp Source #
Instance details Defined in Raft.Client Methods showsPrec :: Int -> ClientRedirResp -> ShowS # show :: ClientRedirResp -> String # showList :: [ClientRedirResp] -> ShowS #
Generic ClientRedirResp Source #
Instance details Defined in Raft.Client Associated Types type Rep ClientRedirResp :: Type -> Type # Methods from :: ClientRedirResp -> Rep ClientRedirResp x # to :: Rep ClientRedirResp x -> ClientRedirResp #
Serialize ClientRedirResp Source #
Instance details Defined in Raft.Client Methods put :: Putter ClientRedirResp # get :: Get ClientRedirResp #
type Rep ClientRedirResp Source #
Instance details Defined in Raft.Client type Rep ClientRedirResp = D1 (MetaData "ClientRedirResp" "Raft.Client" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "ClientRedirResp" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CurrentLeader)))

Configuration

data RaftNodeConfig Source #

Configuration of a node in the cluster

Constructors

RaftNodeConfig
Fields raftConfigNodeId :: NodeId Node id of the running node raftConfigNodeIds :: NodeIds Set of all other node ids in the cluster raftConfigElectionTimeout :: (Natural, Natural) Range of times an election timeout can take raftConfigHeartbeatTimeout :: Natural Heartbeat timeout timer raftConfigStorageState :: StorageState Create a fresh DB or read from existing

Instances

Show RaftNodeConfig Source #
Instance details Defined in Raft.Config Methods showsPrec :: Int -> RaftNodeConfig -> ShowS # show :: RaftNodeConfig -> String # showList :: [RaftNodeConfig] -> ShowS #

Events

data Event v Source #

Representation of events a raft node can send and receive

Constructors

MessageEvent (MessageEvent v)
TimeoutEvent SystemTime Timeout

Instances

Show v => Show (Event v) Source #
Instance details Defined in Raft.Event Methods showsPrec :: Int -> Event v -> ShowS # show :: Event v -> String # showList :: [Event v] -> ShowS #

data Timeout Source #

Representation of timeouts

Constructors

ElectionTimeout	Timeout after which a follower will become candidate
HeartbeatTimeout	Timeout after which a leader will send AppendEntries RPC to all peers

Instances

Show Timeout Source #
Instance details Defined in Raft.Event Methods showsPrec :: Int -> Timeout -> ShowS # show :: Timeout -> String # showList :: [Timeout] -> ShowS #

data MessageEvent v Source #

Representation of message events to a node

Constructors

RPCMessageEvent (RPCMessage v)	Incoming event from a peer
ClientRequestEvent (ClientRequest v)	Incoming event from a client

Instances

Show v => Show (MessageEvent v) Source #
Instance details Defined in Raft.Event Methods showsPrec :: Int -> MessageEvent v -> ShowS # show :: MessageEvent v -> String # showList :: [MessageEvent v] -> ShowS #
Generic (MessageEvent v) Source #
Instance details Defined in Raft.Event Associated Types type Rep (MessageEvent v) :: Type -> Type # Methods from :: MessageEvent v -> Rep (MessageEvent v) x # to :: Rep (MessageEvent v) x -> MessageEvent v #
Serialize v => Serialize (MessageEvent v) Source #
Instance details Defined in Raft.Event Methods put :: Putter (MessageEvent v) # get :: Get (MessageEvent v) #
type Rep (MessageEvent v) Source #
Instance details Defined in Raft.Event type Rep (MessageEvent v) = D1 (MetaData "MessageEvent" "Raft.Event" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "RPCMessageEvent" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (RPCMessage v))) :+: C1 (MetaCons "ClientRequestEvent" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ClientRequest v))))

Log

data Entry v Source #

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) Source #
Instance details Defined in Raft.Log Methods (==) :: Entry v -> Entry v -> Bool # (/=) :: Entry v -> Entry v -> Bool #
Show v => Show (Entry v) Source #
Instance details Defined in Raft.Log Methods showsPrec :: Int -> Entry v -> ShowS # show :: Entry v -> String # showList :: [Entry v] -> ShowS #
Generic (Entry v) Source #
Instance details 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) Source #
Instance details Defined in Raft.Log Methods put :: Putter (Entry v) # get :: Get (Entry v) #
type Rep (Entry v) Source #
Instance details 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) Source #

class (Show (RaftWriteLogError m), Monad m) => RaftWriteLog m v where Source #

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

Associated Types

type RaftWriteLogError m Source #

Methods

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

Write the given log entries to storage

Instances

(Serialize v, MonadIO m) => RaftWriteLog (RaftPostgresT m) v Source #
Instance details Defined in Raft.Log.PostgreSQL Associated Types type RaftWriteLogError (RaftPostgresT m) :: Type Source # Methods writeLogEntries :: Entries v -> RaftPostgresT m (Either (RaftWriteLogError (RaftPostgresT m)) ()) Source #
RaftWriteLog m v => RaftWriteLog (RaftPersistFileStoreT m) v Source #
Instance details Defined in Examples.Raft.FileStore.Persistent Associated Types type RaftWriteLogError (RaftPersistFileStoreT m) :: Type Source # Methods writeLogEntries :: Entries v -> RaftPersistFileStoreT m (Either (RaftWriteLogError (RaftPersistFileStoreT m)) ()) Source #
(MonadIO m, Serialize v) => RaftWriteLog (RaftLogFileStoreT m) v Source #
Instance details Defined in Examples.Raft.FileStore.Log Associated Types type RaftWriteLogError (RaftLogFileStoreT m) :: Type Source # Methods writeLogEntries :: Entries v -> RaftLogFileStoreT m (Either (RaftWriteLogError (RaftLogFileStoreT m)) ()) Source #
RaftWriteLog m v => RaftWriteLog (RaftSocketT sm v m) v Source #
Instance details Defined in Examples.Raft.Socket.Node Associated Types type RaftWriteLogError (RaftSocketT sm v m) :: Type Source # Methods writeLogEntries :: Entries v -> RaftSocketT sm v m (Either (RaftWriteLogError (RaftSocketT sm v m)) ()) Source #

data DeleteSuccess v Source #

Constructors

DeleteSuccess

class (Show (RaftDeleteLogError m), Monad m) => RaftDeleteLog m v where Source #

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

Associated Types

type RaftDeleteLogError m Source #

Methods

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

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 Source #
Instance details Defined in Raft.Log.PostgreSQL Associated Types type RaftDeleteLogError (RaftPostgresT m) :: Type Source # Methods deleteLogEntriesFrom :: Index -> RaftPostgresT m (Either (RaftDeleteLogError (RaftPostgresT m)) (DeleteSuccess v)) Source #
RaftDeleteLog m v => RaftDeleteLog (RaftPersistFileStoreT m) v Source #
Instance details Defined in Examples.Raft.FileStore.Persistent Associated Types type RaftDeleteLogError (RaftPersistFileStoreT m) :: Type Source # Methods deleteLogEntriesFrom :: Index -> RaftPersistFileStoreT m (Either (RaftDeleteLogError (RaftPersistFileStoreT m)) (DeleteSuccess v)) Source #
(MonadIO m, Serialize v) => RaftDeleteLog (RaftLogFileStoreT m) v Source #
Instance details Defined in Examples.Raft.FileStore.Log Associated Types type RaftDeleteLogError (RaftLogFileStoreT m) :: Type Source # Methods deleteLogEntriesFrom :: Index -> RaftLogFileStoreT m (Either (RaftDeleteLogError (RaftLogFileStoreT m)) (DeleteSuccess v)) Source #
RaftDeleteLog m v => RaftDeleteLog (RaftSocketT sm v m) v Source #
Instance details Defined in Examples.Raft.Socket.Node Associated Types type RaftDeleteLogError (RaftSocketT sm v m) :: Type Source # Methods deleteLogEntriesFrom :: Index -> RaftSocketT sm v m (Either (RaftDeleteLogError (RaftSocketT sm v m)) (DeleteSuccess v)) Source #

class (Show (RaftReadLogError m), Monad m) => RaftReadLog m v where Source #

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

Minimal complete definition

readLogEntry, readLastLogEntry

Associated Types

type RaftReadLogError m Source #

Methods

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

Read the log at a given index

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

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

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

Read the last log entry in the log

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

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

Instances

(Typeable v, Serialize v, MonadIO m) => RaftReadLog (RaftPostgresT m) v Source #
Instance details Defined in Raft.Log.PostgreSQL Associated Types type RaftReadLogError (RaftPostgresT m) :: Type Source # Methods readLogEntry :: Index -> RaftPostgresT m (Either (RaftReadLogError (RaftPostgresT m)) (Maybe (Entry v))) Source # readLogEntriesFrom :: Index -> RaftPostgresT m (Either (RaftReadLogError (RaftPostgresT m)) (Entries v)) Source # readLastLogEntry :: RaftPostgresT m (Either (RaftReadLogError (RaftPostgresT m)) (Maybe (Entry v))) Source #
RaftReadLog m v => RaftReadLog (RaftPersistFileStoreT m) v Source #
Instance details Defined in Examples.Raft.FileStore.Persistent Associated Types type RaftReadLogError (RaftPersistFileStoreT m) :: Type Source # Methods readLogEntry :: Index -> RaftPersistFileStoreT m (Either (RaftReadLogError (RaftPersistFileStoreT m)) (Maybe (Entry v))) Source # readLogEntriesFrom :: Index -> RaftPersistFileStoreT m (Either (RaftReadLogError (RaftPersistFileStoreT m)) (Entries v)) Source # readLastLogEntry :: RaftPersistFileStoreT m (Either (RaftReadLogError (RaftPersistFileStoreT m)) (Maybe (Entry v))) Source #
(MonadIO m, Serialize v) => RaftReadLog (RaftLogFileStoreT m) v Source #
Instance details Defined in Examples.Raft.FileStore.Log Associated Types type RaftReadLogError (RaftLogFileStoreT m) :: Type Source # Methods readLogEntry :: Index -> RaftLogFileStoreT m (Either (RaftReadLogError (RaftLogFileStoreT m)) (Maybe (Entry v))) Source # readLogEntriesFrom :: Index -> RaftLogFileStoreT m (Either (RaftReadLogError (RaftLogFileStoreT m)) (Entries v)) Source # readLastLogEntry :: RaftLogFileStoreT m (Either (RaftReadLogError (RaftLogFileStoreT m)) (Maybe (Entry v))) Source #
RaftReadLog m v => RaftReadLog (RaftSocketT sm v m) v Source #
Instance details Defined in Examples.Raft.Socket.Node Associated Types type RaftReadLogError (RaftSocketT sm v m) :: Type Source # Methods readLogEntry :: Index -> RaftSocketT sm v m (Either (RaftReadLogError (RaftSocketT sm v m)) (Maybe (Entry v))) Source # readLogEntriesFrom :: Index -> RaftSocketT sm v m (Either (RaftReadLogError (RaftSocketT sm v m)) (Entries v)) Source # readLastLogEntry :: RaftSocketT sm v m (Either (RaftReadLogError (RaftSocketT sm v m)) (Maybe (Entry v))) Source #

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

data RaftLogError m Source #

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

Instances

Show (RaftLogError m) Source #
Instance details 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)) Source #

Logging

data LogCtx m Source #

Representation of the logs' context

Constructors

LogCtx
Fields logCtxDest :: LogDest m logCtxSeverity :: Severity
NoLogs

data LogDest m Source #

Representation of the logs' destination

Constructors

LogWith (MonadIO m => Severity -> Text -> m ())
LogFile FilePath
LogStdout

data Severity Source #

Representation of the severity of the logs

Constructors

Debug
Info
Critical

Instances

Eq Severity Source #
Instance details Defined in Raft.Logging Methods (==) :: Severity -> Severity -> Bool # (/=) :: Severity -> Severity -> Bool #
Ord Severity Source #
Instance details Defined in Raft.Logging Methods compare :: Severity -> Severity -> Ordering # (<) :: Severity -> Severity -> Bool # (<=) :: Severity -> Severity -> Bool # (>) :: Severity -> Severity -> Bool # (>=) :: Severity -> Severity -> Bool # max :: Severity -> Severity -> Severity # min :: Severity -> Severity -> Severity #
Show Severity Source #
Instance details Defined in Raft.Logging Methods showsPrec :: Int -> Severity -> ShowS # show :: Severity -> String # showList :: [Severity] -> ShowS #

Raft node states

data Mode Source #

Constructors

Follower
Candidate
Leader

Instances

Read Mode Source #
Instance details Defined in Raft.Types Methods readsPrec :: Int -> ReadS Mode # readList :: ReadS [Mode] # readPrec :: ReadPrec Mode # readListPrec :: ReadPrec [Mode] #
Show Mode Source #
Instance details Defined in Raft.Types Methods showsPrec :: Int -> Mode -> ShowS # show :: Mode -> String # showList :: [Mode] -> ShowS #

data RaftNodeState v where Source #

Existential type hiding the internal node state

Constructors

RaftNodeState
Fields :: { unRaftNodeState :: NodeState s v } -> RaftNodeState v

Instances

Show v => Show (RaftNodeState v) Source #
Instance details Defined in Raft.NodeState Methods showsPrec :: Int -> RaftNodeState v -> ShowS # show :: RaftNodeState v -> String # showList :: [RaftNodeState v] -> ShowS #
Monad m => MonadState (RaftNodeState v) (RaftT v m) Source #
Instance details Defined in Raft.Monad Methods get :: RaftT v m (RaftNodeState v) # put :: RaftNodeState v -> RaftT v m () # state :: (RaftNodeState v -> (a, RaftNodeState v)) -> RaftT v m a #

data NodeState (a :: Mode) v where Source #

The volatile state of a Raft Node

Constructors

NodeFollowerState :: FollowerState v -> NodeState Follower v
NodeCandidateState :: CandidateState v -> NodeState Candidate v
NodeLeaderState :: LeaderState v -> NodeState Leader v

Instances

Show v => Show (NodeState s v) Source #
Instance details Defined in Raft.NodeState Methods showsPrec :: Int -> NodeState s v -> ShowS # show :: NodeState s v -> String # showList :: [NodeState s v] -> ShowS #

data CurrentLeader Source #

Representation of the current leader in the cluster. The system is considered to be unavailable if there is no leader

Constructors

CurrentLeader LeaderId
NoLeader

Instances

Eq CurrentLeader Source #
Instance details Defined in Raft.Types Methods (==) :: CurrentLeader -> CurrentLeader -> Bool # (/=) :: CurrentLeader -> CurrentLeader -> Bool #
Show CurrentLeader Source #
Instance details Defined in Raft.Types Methods showsPrec :: Int -> CurrentLeader -> ShowS # show :: CurrentLeader -> String # showList :: [CurrentLeader] -> ShowS #
Generic CurrentLeader Source #
Instance details Defined in Raft.Types Associated Types type Rep CurrentLeader :: Type -> Type # Methods from :: CurrentLeader -> Rep CurrentLeader x # to :: Rep CurrentLeader x -> CurrentLeader #
Serialize CurrentLeader Source #
Instance details Defined in Raft.Types Methods put :: Putter CurrentLeader # get :: Get CurrentLeader #
type Rep CurrentLeader Source #
Instance details Defined in Raft.Types type Rep CurrentLeader = D1 (MetaData "CurrentLeader" "Raft.Types" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "CurrentLeader" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 LeaderId)) :+: C1 (MetaCons "NoLeader" PrefixI False) (U1 :: Type -> Type))

data FollowerState v Source #

Constructors

FollowerState

Fields

fsCurrentLeader :: CurrentLeader
Id of the current leader
fsCommitIndex :: Index
Index of highest log entry known to be committed
fsLastApplied :: Index
Index of highest log entry applied to state machine
fsLastLogEntry :: LastLogEntry v
Index and term of the last log entry in the node's log
fsTermAtAEPrevIndex :: Maybe Term
The term of the log entry specified in and AppendEntriesRPC
fsClientReqCache :: ClientWriteReqCache
The client write request cache, growing linearly with the number of clients

Instances

Show v => Show (FollowerState v) Source #
Instance details Defined in Raft.NodeState Methods showsPrec :: Int -> FollowerState v -> ShowS # show :: FollowerState v -> String # showList :: [FollowerState v] -> ShowS #

data CandidateState v Source #

Constructors

CandidateState

Fields

csCommitIndex :: Index
Index of highest log entry known to be committed
csLastApplied :: Index
Index of highest log entry applied to state machine
csVotes :: NodeIds
Votes from other nodes in the raft network
csLastLogEntry :: LastLogEntry v
Index and term of the last log entry in the node's log
csClientReqCache :: ClientWriteReqCache
The client write request cache, growing linearly with the number of clients

Instances

Show v => Show (CandidateState v) Source #
Instance details Defined in Raft.NodeState Methods showsPrec :: Int -> CandidateState v -> ShowS # show :: CandidateState v -> String # showList :: [CandidateState v] -> ShowS #

data LeaderState v Source #

Constructors

LeaderState

Fields

lsCommitIndex :: Index
Index of highest log entry known to be committed
lsLastApplied :: Index
Index of highest log entry applied to state machine
lsNextIndex :: Map NodeId Index
For each server, index of the next log entry to send to that server
lsMatchIndex :: Map NodeId Index
For each server, index of highest log entry known to be replicated on server
lsLastLogEntry :: LastLogEntry v
Index, term, and client id of the last log entry in the node's log. The only time `Maybe ClientId` will be Nothing is at the initial term.
lsReadReqsHandled :: Int
Number of read requests handled this term
lsReadRequest :: ClientReadReqs
The number of successful responses received regarding a specific read request heartbeat.
lsClientReqCache :: ClientWriteReqCache
The cache of client write requests received by the leader

Instances

Show v => Show (LeaderState v) Source #
Instance details Defined in Raft.NodeState Methods showsPrec :: Int -> LeaderState v -> ShowS # show :: LeaderState v -> String # showList :: [LeaderState v] -> ShowS #

initRaftNodeState :: RaftNodeState v Source #

A node in Raft begins as a follower

isFollower :: NodeState s v -> Bool Source #

Check if node is in a follower state

isCandidate :: NodeState s v -> Bool Source #

Check if node is in a candidate state

isLeader :: NodeState s v -> Bool Source #

Check if node is in a leader state

setLastLogEntry :: NodeState s v -> Entries v -> NodeState s v Source #

Update the last log entry in the node's log

getLastLogEntry :: NodeState ns v -> LastLogEntry v Source #

Get the last applied index and the commit index of the last log entry in the node's log

getLastAppliedAndCommitIndex :: NodeState ns v -> (Index, Index) Source #

Get the index of highest log entry applied to state machine and the index of highest log entry known to be committed

Persistent state

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

Basic types

type NodeId = ByteString Source #

Unique identifier of a Raft node

type NodeIds = Set NodeId Source #

newtype ClientId Source #

Unique identifier of a client

Constructors

ClientId NodeId

Instances

Eq ClientId Source #
Instance details Defined in Raft.Types Methods (==) :: ClientId -> ClientId -> Bool # (/=) :: ClientId -> ClientId -> Bool #
Ord ClientId Source #
Instance details Defined in Raft.Types Methods compare :: ClientId -> ClientId -> Ordering # (<) :: ClientId -> ClientId -> Bool # (<=) :: ClientId -> ClientId -> Bool # (>) :: ClientId -> ClientId -> Bool # (>=) :: ClientId -> ClientId -> Bool # max :: ClientId -> ClientId -> ClientId # min :: ClientId -> ClientId -> ClientId #
Read ClientId Source #
Instance details Defined in Raft.Types Methods readsPrec :: Int -> ReadS ClientId # readList :: ReadS [ClientId] # readPrec :: ReadPrec ClientId # readListPrec :: ReadPrec [ClientId] #
Show ClientId Source #
Instance details Defined in Raft.Types Methods showsPrec :: Int -> ClientId -> ShowS # show :: ClientId -> String # showList :: [ClientId] -> ShowS #
Generic ClientId Source #
Instance details Defined in Raft.Types Associated Types type Rep ClientId :: Type -> Type # Methods from :: ClientId -> Rep ClientId x # to :: Rep ClientId x -> ClientId #
Serialize ClientId Source #
Instance details Defined in Raft.Types Methods put :: Putter ClientId # get :: Get ClientId #
type Rep ClientId Source #
Instance details Defined in Raft.Types type Rep ClientId = D1 (MetaData "ClientId" "Raft.Types" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" True) (C1 (MetaCons "ClientId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 NodeId)))

newtype LeaderId Source #

Unique identifier of a leader

Constructors

LeaderId
Fields unLeaderId :: NodeId

Instances

Eq LeaderId Source #
Instance details Defined in Raft.Types Methods (==) :: LeaderId -> LeaderId -> Bool # (/=) :: LeaderId -> LeaderId -> Bool #
Read LeaderId Source #
Instance details Defined in Raft.Types Methods readsPrec :: Int -> ReadS LeaderId # readList :: ReadS [LeaderId] # readPrec :: ReadPrec LeaderId # readListPrec :: ReadPrec [LeaderId] #
Show LeaderId Source #
Instance details Defined in Raft.Types Methods showsPrec :: Int -> LeaderId -> ShowS # show :: LeaderId -> String # showList :: [LeaderId] -> ShowS #
Generic LeaderId Source #
Instance details Defined in Raft.Types Associated Types type Rep LeaderId :: Type -> Type # Methods from :: LeaderId -> Rep LeaderId x # to :: Rep LeaderId x -> LeaderId #
Serialize LeaderId Source #
Instance details Defined in Raft.Types Methods put :: Putter LeaderId # get :: Get LeaderId #
type Rep LeaderId Source #
Instance details Defined in Raft.Types type Rep LeaderId = D1 (MetaData "LeaderId" "Raft.Types" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" True) (C1 (MetaCons "LeaderId" PrefixI True) (S1 (MetaSel (Just "unLeaderId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 NodeId)))

newtype Term Source #

Representation of monotonic election terms

Constructors

Term Natural

Instances

Enum Term Source #
Instance details Defined in Raft.Types Methods succ :: Term -> Term # pred :: Term -> Term # toEnum :: Int -> Term # fromEnum :: Term -> Int # enumFrom :: Term -> [Term] # enumFromThen :: Term -> Term -> [Term] # enumFromTo :: Term -> Term -> [Term] # enumFromThenTo :: Term -> Term -> Term -> [Term] #
Eq Term Source #
Instance details Defined in Raft.Types Methods (==) :: Term -> Term -> Bool # (/=) :: Term -> Term -> Bool #
Ord Term Source #
Instance details Defined in Raft.Types Methods compare :: Term -> Term -> Ordering # (<) :: Term -> Term -> Bool # (<=) :: Term -> Term -> Bool # (>) :: Term -> Term -> Bool # (>=) :: Term -> Term -> Bool # max :: Term -> Term -> Term # min :: Term -> Term -> Term #
Show Term Source #
Instance details Defined in Raft.Types Methods showsPrec :: Int -> Term -> ShowS # show :: Term -> String # showList :: [Term] -> ShowS #
Generic Term Source #
Instance details Defined in Raft.Types Associated Types type Rep Term :: Type -> Type # Methods from :: Term -> Rep Term x # to :: Rep Term x -> Term #
Serialize Term Source #
Instance details Defined in Raft.Types Methods put :: Putter Term # get :: Get Term #
FromField Term Source #
Instance details Defined in Raft.Types Methods fromField :: FieldParser Term #
ToField Term Source #
Instance details Defined in Raft.Types Methods toField :: Term -> Action #
type Rep Term Source #
Instance details Defined in Raft.Types type Rep Term = D1 (MetaData "Term" "Raft.Types" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" True) (C1 (MetaCons "Term" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Natural)))

newtype Index Source #

Representation of monotonic indices

Constructors

Index Natural

Instances

Enum Index Source #
Instance details Defined in Raft.Types Methods succ :: Index -> Index # pred :: Index -> Index # toEnum :: Int -> Index # fromEnum :: Index -> Int # enumFrom :: Index -> [Index] # enumFromThen :: Index -> Index -> [Index] # enumFromTo :: Index -> Index -> [Index] # enumFromThenTo :: Index -> Index -> Index -> [Index] #
Eq Index Source #
Instance details Defined in Raft.Types Methods (==) :: Index -> Index -> Bool # (/=) :: Index -> Index -> Bool #
Integral Index Source #
Instance details Defined in Raft.Types Methods quot :: Index -> Index -> Index # rem :: Index -> Index -> Index # div :: Index -> Index -> Index # mod :: Index -> Index -> Index # quotRem :: Index -> Index -> (Index, Index) # divMod :: Index -> Index -> (Index, Index) # toInteger :: Index -> Integer #
Num Index Source #
Instance details Defined in Raft.Types Methods (+) :: Index -> Index -> Index # (-) :: Index -> Index -> Index # (*) :: Index -> Index -> Index # negate :: Index -> Index # abs :: Index -> Index # signum :: Index -> Index # fromInteger :: Integer -> Index #
Ord Index Source #
Instance details Defined in Raft.Types Methods compare :: Index -> Index -> Ordering # (<) :: Index -> Index -> Bool # (<=) :: Index -> Index -> Bool # (>) :: Index -> Index -> Bool # (>=) :: Index -> Index -> Bool # max :: Index -> Index -> Index # min :: Index -> Index -> Index #
Read Index Source #
Instance details Defined in Raft.Types Methods readsPrec :: Int -> ReadS Index # readList :: ReadS [Index] # readPrec :: ReadPrec Index # readListPrec :: ReadPrec [Index] #
Real Index Source #
Instance details Defined in Raft.Types Methods toRational :: Index -> Rational #
Show Index Source #
Instance details Defined in Raft.Types Methods showsPrec :: Int -> Index -> ShowS # show :: Index -> String # showList :: [Index] -> ShowS #
Generic Index Source #
Instance details Defined in Raft.Types Associated Types type Rep Index :: Type -> Type # Methods from :: Index -> Rep Index x # to :: Rep Index x -> Index #
Serialize Index Source #
Instance details Defined in Raft.Types Methods put :: Putter Index # get :: Get Index #
FromField Index Source #
Instance details Defined in Raft.Types Methods fromField :: FieldParser Index #
ToField Index Source #
Instance details Defined in Raft.Types Methods toField :: Index -> Action #
type Rep Index Source #
Instance details Defined in Raft.Types type Rep Index = D1 (MetaData "Index" "Raft.Types" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" True) (C1 (MetaCons "Index" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Natural)))

term0 :: Term Source #

Initial term. Terms start at 0

index0 :: Index Source #

Initial index. Indeces start at 0

RPC

data RPC v Source #

Constructors

AppendEntriesRPC (AppendEntries v)
AppendEntriesResponseRPC AppendEntriesResponse
RequestVoteRPC RequestVote
RequestVoteResponseRPC RequestVoteResponse

Instances

Show v => Show (RPC v) Source #
Instance details Defined in Raft.RPC Methods showsPrec :: Int -> RPC v -> ShowS # show :: RPC v -> String # showList :: [RPC v] -> ShowS #
Generic (RPC v) Source #
Instance details Defined in Raft.RPC Associated Types type Rep (RPC v) :: Type -> Type # Methods from :: RPC v -> Rep (RPC v) x # to :: Rep (RPC v) x -> RPC v #
Serialize v => Serialize (RPC v) Source #
Instance details Defined in Raft.RPC Methods put :: Putter (RPC v) # get :: Get (RPC v) #
type Rep (RPC v) Source #
Instance details Defined in Raft.RPC type Rep (RPC v) = D1 (MetaData "RPC" "Raft.RPC" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) ((C1 (MetaCons "AppendEntriesRPC" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (AppendEntries v))) :+: C1 (MetaCons "AppendEntriesResponseRPC" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AppendEntriesResponse))) :+: (C1 (MetaCons "RequestVoteRPC" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RequestVote)) :+: C1 (MetaCons "RequestVoteResponseRPC" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RequestVoteResponse))))

class RPCType a v where Source #

Methods

toRPC :: a -> RPC v Source #

Instances

RPCType RequestVoteResponse v Source #
Instance details Defined in Raft.RPC Methods toRPC :: RequestVoteResponse -> RPC v Source #
RPCType RequestVote v Source #
Instance details Defined in Raft.RPC Methods toRPC :: RequestVote -> RPC v Source #
RPCType AppendEntriesResponse v Source #
Instance details Defined in Raft.RPC Methods toRPC :: AppendEntriesResponse -> RPC v Source #
RPCType (AppendEntries v) v Source #
Instance details Defined in Raft.RPC Methods toRPC :: AppendEntries v -> RPC v Source #

data RPCMessage v Source #

Representation of a message sent between nodes

Constructors

RPCMessage
Fields sender :: NodeId rpc :: RPC v

Instances

Show v => Show (RPCMessage v) Source #
Instance details Defined in Raft.RPC Methods showsPrec :: Int -> RPCMessage v -> ShowS # show :: RPCMessage v -> String # showList :: [RPCMessage v] -> ShowS #
Generic (RPCMessage v) Source #
Instance details Defined in Raft.RPC Associated Types type Rep (RPCMessage v) :: Type -> Type # Methods from :: RPCMessage v -> Rep (RPCMessage v) x # to :: Rep (RPCMessage v) x -> RPCMessage v #
Serialize v => Serialize (RPCMessage v) Source #
Instance details Defined in Raft.RPC Methods put :: Putter (RPCMessage v) # get :: Get (RPCMessage v) #
type Rep (RPCMessage v) Source #
Instance details Defined in Raft.RPC type Rep (RPCMessage v) = D1 (MetaData "RPCMessage" "Raft.RPC" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "RPCMessage" PrefixI True) (S1 (MetaSel (Just "sender") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 NodeId) :*: S1 (MetaSel (Just "rpc") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (RPC v))))

data AppendEntries v Source #

Representation of a message sent from a leader to its peers

Constructors

AppendEntries

Fields

aeTerm :: Term
Leader's term
aeLeaderId :: LeaderId
Leader's identifier so that followers can redirect clients
aePrevLogIndex :: Index
Index of log entry immediately preceding new ones
aePrevLogTerm :: Term
Term of aePrevLogIndex entry
aeEntries :: Entries v
Log entries to store (empty for heartbeat)
aeLeaderCommit :: Index
Leader's commit index
aeReadRequest :: Maybe Int
which read request the message corresponds to

Instances

Show v => Show (AppendEntries v) Source #
Instance details Defined in Raft.RPC Methods showsPrec :: Int -> AppendEntries v -> ShowS # show :: AppendEntries v -> String # showList :: [AppendEntries v] -> ShowS #
Generic (AppendEntries v) Source #
Instance details Defined in Raft.RPC Associated Types type Rep (AppendEntries v) :: Type -> Type # Methods from :: AppendEntries v -> Rep (AppendEntries v) x # to :: Rep (AppendEntries v) x -> AppendEntries v #
Serialize v => Serialize (AppendEntries v) Source #
Instance details Defined in Raft.RPC Methods put :: Putter (AppendEntries v) # get :: Get (AppendEntries v) #
RPCType (AppendEntries v) v Source #
Instance details Defined in Raft.RPC Methods toRPC :: AppendEntries v -> RPC v Source #
type Rep (AppendEntries v) Source #
Instance details Defined in Raft.RPC type Rep (AppendEntries v) = D1 (MetaData "AppendEntries" "Raft.RPC" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "AppendEntries" PrefixI True) ((S1 (MetaSel (Just "aeTerm") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Term) :: (S1 (MetaSel (Just "aeLeaderId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 LeaderId) :: S1 (MetaSel (Just "aePrevLogIndex") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Index))) :: ((S1 (MetaSel (Just "aePrevLogTerm") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Term) :: S1 (MetaSel (Just "aeEntries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Entries v))) :: (S1 (MetaSel (Just "aeLeaderCommit") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Index) :: S1 (MetaSel (Just "aeReadRequest") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))))))

data AppendEntriesResponse Source #

Representation of the response from a follower to an AppendEntries message

Constructors

AppendEntriesResponse
Fields aerTerm :: Term current term for leader to update itself aerSuccess :: Bool true if follower contained entry matching aePrevLogIndex and aePrevLogTerm aerReadRequest :: Maybe Int which read request the response corresponds to

Instances

Show AppendEntriesResponse Source #
Instance details Defined in Raft.RPC Methods showsPrec :: Int -> AppendEntriesResponse -> ShowS # show :: AppendEntriesResponse -> String # showList :: [AppendEntriesResponse] -> ShowS #
Generic AppendEntriesResponse Source #
Instance details Defined in Raft.RPC Associated Types type Rep AppendEntriesResponse :: Type -> Type # Methods from :: AppendEntriesResponse -> Rep AppendEntriesResponse x # to :: Rep AppendEntriesResponse x -> AppendEntriesResponse #
Serialize AppendEntriesResponse Source #
Instance details Defined in Raft.RPC Methods put :: Putter AppendEntriesResponse # get :: Get AppendEntriesResponse #
RPCType AppendEntriesResponse v Source #
Instance details Defined in Raft.RPC Methods toRPC :: AppendEntriesResponse -> RPC v Source #
type Rep AppendEntriesResponse Source #
Instance details Defined in Raft.RPC type Rep AppendEntriesResponse = D1 (MetaData "AppendEntriesResponse" "Raft.RPC" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "AppendEntriesResponse" PrefixI True) (S1 (MetaSel (Just "aerTerm") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Term) :: (S1 (MetaSel (Just "aerSuccess") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "aerReadRequest") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int)))))

data RequestVote Source #

Representation of the message sent by candidates to their peers to request their vote

Constructors

RequestVote
Fields rvTerm :: Term candidates term rvCandidateId :: NodeId candidate requesting vote rvLastLogIndex :: Index index of candidate's last log entry rvLastLogTerm :: Term term of candidate's last log entry

Instances

Show RequestVote Source #
Instance details Defined in Raft.RPC Methods showsPrec :: Int -> RequestVote -> ShowS # show :: RequestVote -> String # showList :: [RequestVote] -> ShowS #
Generic RequestVote Source #
Instance details Defined in Raft.RPC Associated Types type Rep RequestVote :: Type -> Type # Methods from :: RequestVote -> Rep RequestVote x # to :: Rep RequestVote x -> RequestVote #
Serialize RequestVote Source #
Instance details Defined in Raft.RPC Methods put :: Putter RequestVote # get :: Get RequestVote #
RPCType RequestVote v Source #
Instance details Defined in Raft.RPC Methods toRPC :: RequestVote -> RPC v Source #
type Rep RequestVote Source #
Instance details Defined in Raft.RPC type Rep RequestVote = D1 (MetaData "RequestVote" "Raft.RPC" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "RequestVote" PrefixI True) ((S1 (MetaSel (Just "rvTerm") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Term) :: S1 (MetaSel (Just "rvCandidateId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 NodeId)) :: (S1 (MetaSel (Just "rvLastLogIndex") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Index) :*: S1 (MetaSel (Just "rvLastLogTerm") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Term))))

data RequestVoteResponse Source #

Representation of a response to a RequestVote message

Constructors

RequestVoteResponse
Fields rvrTerm :: Term current term for candidate to update itself rvrVoteGranted :: Bool true means candidate recieved vote

Instances

Show RequestVoteResponse Source #
Instance details Defined in Raft.RPC Methods showsPrec :: Int -> RequestVoteResponse -> ShowS # show :: RequestVoteResponse -> String # showList :: [RequestVoteResponse] -> ShowS #
Generic RequestVoteResponse Source #
Instance details Defined in Raft.RPC Associated Types type Rep RequestVoteResponse :: Type -> Type # Methods from :: RequestVoteResponse -> Rep RequestVoteResponse x # to :: Rep RequestVoteResponse x -> RequestVoteResponse #
Serialize RequestVoteResponse Source #
Instance details Defined in Raft.RPC Methods put :: Putter RequestVoteResponse # get :: Get RequestVoteResponse #
RPCType RequestVoteResponse v Source #
Instance details Defined in Raft.RPC Methods toRPC :: RequestVoteResponse -> RPC v Source #
type Rep RequestVoteResponse Source #
Instance details Defined in Raft.RPC type Rep RequestVoteResponse = D1 (MetaData "RequestVoteResponse" "Raft.RPC" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "RequestVoteResponse" PrefixI True) (S1 (MetaSel (Just "rvrTerm") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Term) :*: S1 (MetaSel (Just "rvrVoteGranted") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))

data AppendEntriesData v Source #

The data used to construct an AppendEntries value, snapshotted from the node state at the time the AppendEntries val should be created.

Constructors

AppendEntriesData
Fields aedTerm :: Term aedLeaderCommit :: Index aedEntriesSpec :: AppendEntriesSpec v

Instances

Show v => Show (AppendEntriesData v) Source #
Instance details Defined in Raft.RPC Methods showsPrec :: Int -> AppendEntriesData v -> ShowS # show :: AppendEntriesData v -> String # showList :: [AppendEntriesData v] -> ShowS #