Raft.Monad

Documentation

class RSMP sm v | sm -> v where

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 RSMPError sm v

type RSMPCtx sm v = ctx | ctx -> sm v

Methods

applyCmdRSMP :: RSMPCtx sm v -> sm -> v -> Either (RSMPError sm v) sm

class (Monad m, RSMP sm v) => RSM sm v m | m sm -> v where

Methods

validateCmd :: v -> m (Either (RSMPError sm v) ())

askRSMPCtx :: m (RSMPCtx sm v)

applyEntryRSM :: RSM sm v m => sm -> Entry v -> m (Either (RSMPError sm v) sm)

tellAction :: Action sm v -> TransitionM sm v ()

tellActions :: [Action sm v] -> TransitionM sm v ()

data TransitionEnv sm

Constructors

TransitionEnv

Fields

• nodeConfig :: NodeConfig
• stateMachine :: sm
• nodeState :: RaftNodeState

Instances

MonadReader (TransitionEnv sm) (TransitionM sm v)

Defined in Raft.Monad

Methods

ask :: TransitionM sm v (TransitionEnv sm)

local :: (TransitionEnv sm -> TransitionEnv sm) -> TransitionM sm v a -> TransitionM sm v a

reader :: (TransitionEnv sm -> a) -> TransitionM sm v a

RaftLogger (RWS (TransitionEnv sm) [Action sm v] PersistentState)

Defined in Raft.Monad

Methods

loggerNodeId :: RWS (TransitionEnv sm) [Action sm v] PersistentState NodeId

loggerNodeState :: RWS (TransitionEnv sm) [Action sm v] PersistentState RaftNodeState

newtype TransitionM sm v a

Constructors

TransitionM

Fields

• unTransitionM :: RaftLoggerT (RWS (TransitionEnv sm) [Action sm v] PersistentState) a

Instances

MonadState PersistentState (TransitionM sm v)

Defined in Raft.Monad

Methods

get :: TransitionM sm v PersistentState

put :: PersistentState -> TransitionM sm v ()

state :: (PersistentState -> (a, PersistentState)) -> TransitionM sm v a

MonadWriter [Action sm v] (TransitionM sm v)

Defined in Raft.Monad

Methods

writer :: (a, [Action sm v]) -> TransitionM sm v a

tell :: [Action sm v] -> TransitionM sm v ()

listen :: TransitionM sm v a -> TransitionM sm v (a, [Action sm v])

pass :: TransitionM sm v (a, [Action sm v] -> [Action sm v]) -> TransitionM sm v a

MonadReader (TransitionEnv sm) (TransitionM sm v)

Defined in Raft.Monad

Methods

ask :: TransitionM sm v (TransitionEnv sm)

local :: (TransitionEnv sm -> TransitionEnv sm) -> TransitionM sm v a -> TransitionM sm v a

reader :: (TransitionEnv sm -> a) -> TransitionM sm v a

Monad (TransitionM sm v)

Defined in Raft.Monad

Methods

(>>=) :: TransitionM sm v a -> (a -> TransitionM sm v b) -> TransitionM sm v b

(>>) :: TransitionM sm v a -> TransitionM sm v b -> TransitionM sm v b

return :: a -> TransitionM sm v a

fail :: String -> TransitionM sm v a

Functor (TransitionM sm v)

Defined in Raft.Monad

Methods

fmap :: (a -> b) -> TransitionM sm v a -> TransitionM sm v b

(<$) :: a -> TransitionM sm v b -> TransitionM sm v a

Applicative (TransitionM sm v)

Defined in Raft.Monad

Methods

pure :: a -> TransitionM sm v a

(<*>) :: TransitionM sm v (a -> b) -> TransitionM sm v a -> TransitionM sm v b

liftA2 :: (a -> b -> c) -> TransitionM sm v a -> TransitionM sm v b -> TransitionM sm v c

(*>) :: TransitionM sm v a -> TransitionM sm v b -> TransitionM sm v b

(<*) :: TransitionM sm v a -> TransitionM sm v b -> TransitionM sm v a

runTransitionM :: TransitionEnv sm -> PersistentState -> TransitionM sm v a -> ((a, [LogMsg]), PersistentState, [Action sm v])

askNodeId :: TransitionM sm v NodeId

type RPCHandler ns sm r v = RPCType r v => NodeState ns -> NodeId -> r -> TransitionM sm v (ResultState ns)

type TimeoutHandler ns sm v = NodeState ns -> Timeout -> TransitionM sm v (ResultState ns)

type ClientReqHandler ns sm v = NodeState ns -> ClientRequest v -> TransitionM sm v (ResultState ns)

broadcast :: SendRPCAction v -> TransitionM sm v ()

send :: NodeId -> SendRPCAction v -> TransitionM sm v ()

resetElectionTimeout :: TransitionM sm v ()

Resets the election timeout.

resetHeartbeatTimeout :: TransitionM sm v ()

redirectClientToLeader :: ClientId -> CurrentLeader -> TransitionM sm v ()

respondClientRead :: ClientId -> TransitionM sm v ()

appendLogEntries :: Show v => Seq (Entry v) -> TransitionM sm v ()

startElection

Arguments

:: Index

-> Index

-> (Index, Term)

Last log entry data

-> TransitionM sm v CandidateState

logInfo :: Text -> TransitionM sm v ()

logDebug :: Text -> TransitionM sm v ()