Raft.Monad

Documentation

type MonadRaft v m = (MonadRaftChan v m, MonadRaftFork m)

class Monad m => MonadRaftChan v m where

The typeclass specifying the datatype used as the core event channel in the main raft event loop, as well as functions for creating, reading, and writing to the channel, and how to fork a computation that performs some action with the channel.

Note: This module uses AllowAmbiguousTypes which removes the necessity for Proxy value arguments in lieu of TypeApplication. For example:

  newRaftChan @v

instead of

  newRaftChan (Proxy :: Proxy v)

Associated Types

type RaftEventChan v m

Methods

readRaftChan :: RaftEventChan v m -> m (Event v)

writeRaftChan :: RaftEventChan v m -> Event v -> m ()

newRaftChan :: m (RaftEventChan v m)

Instances

MonadRaftChan v ConcIO

Defined in Raft.Monad

Associated Types

type RaftEventChan v ConcIO :: Type

Methods

readRaftChan :: RaftEventChan v ConcIO -> ConcIO (Event v)

writeRaftChan :: RaftEventChan v ConcIO -> Event v -> ConcIO ()

newRaftChan :: ConcIO (RaftEventChan v ConcIO)

MonadRaftChan v IO

Defined in Raft.Monad

Associated Types

type RaftEventChan v IO :: Type

Methods

readRaftChan :: RaftEventChan v IO -> IO (Event v)

writeRaftChan :: RaftEventChan v IO -> Event v -> IO ()

newRaftChan :: IO (RaftEventChan v IO)

MonadRaftChan v m => MonadRaftChan v (RaftPostgresT m)

Defined in Raft.Log.PostgreSQL

Associated Types

type RaftEventChan v (RaftPostgresT m) :: Type

Methods

readRaftChan :: RaftEventChan v (RaftPostgresT m) -> RaftPostgresT m (Event v)

writeRaftChan :: RaftEventChan v (RaftPostgresT m) -> Event v -> RaftPostgresT m ()

newRaftChan :: RaftPostgresT m (RaftEventChan v (RaftPostgresT m))

MonadRaftChan v m => MonadRaftChan v (RaftPersistFileStoreT m)

Defined in Examples.Raft.FileStore.Persistent

Associated Types

type RaftEventChan v (RaftPersistFileStoreT m) :: Type

Methods

readRaftChan :: RaftEventChan v (RaftPersistFileStoreT m) -> RaftPersistFileStoreT m (Event v)

writeRaftChan :: RaftEventChan v (RaftPersistFileStoreT m) -> Event v -> RaftPersistFileStoreT m ()

newRaftChan :: RaftPersistFileStoreT m (RaftEventChan v (RaftPersistFileStoreT m))

MonadRaftChan v m => MonadRaftChan v (RaftLogFileStoreT m)

Defined in Examples.Raft.FileStore.Log

Associated Types

type RaftEventChan v (RaftLogFileStoreT m) :: Type

Methods

readRaftChan :: RaftEventChan v (RaftLogFileStoreT m) -> RaftLogFileStoreT m (Event v)

writeRaftChan :: RaftEventChan v (RaftLogFileStoreT m) -> Event v -> RaftLogFileStoreT m ()

newRaftChan :: RaftLogFileStoreT m (RaftEventChan v (RaftLogFileStoreT m))

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

Defined in Examples.Raft.Socket.Node

Associated Types

type RaftEventChan v (RaftSocketT sm v m) :: Type

Methods

readRaftChan :: RaftEventChan v (RaftSocketT sm v m) -> RaftSocketT sm v m (Event v)

writeRaftChan :: RaftEventChan v (RaftSocketT sm v m) -> Event v -> RaftSocketT sm v m ()

newRaftChan :: RaftSocketT sm v m (RaftEventChan v (RaftSocketT sm v m))

data RaftThreadRole

Constructors

RPCHandler

ClientRequestHandler

CustomThreadRole Text

Instances

Show RaftThreadRole

Defined in Raft.Monad

Methods

showsPrec :: Int -> RaftThreadRole -> ShowS

show :: RaftThreadRole -> String

showList :: [RaftThreadRole] -> ShowS

class Monad m => MonadRaftFork m where

The typeclass encapsulating the concurrency operations necessary for the implementation of the main event handling loop.

Associated Types

type RaftThreadId m

Methods

raftFork

Arguments

:: RaftThreadRole

The role of the current thread being forked

-> m ()

The action to fork

-> m (RaftThreadId m)

Instances

MonadRaftFork IO

Defined in Raft.Monad

Associated Types

type RaftThreadId IO :: Type

Methods

raftFork :: RaftThreadRole -> IO () -> IO (RaftThreadId IO)

MonadRaftFork ConcIO

Defined in Raft.Monad

Associated Types

type RaftThreadId ConcIO :: Type

Methods

raftFork :: RaftThreadRole -> ConcIO () -> ConcIO (RaftThreadId ConcIO)

(MonadIO m, MonadRaftFork m) => MonadRaftFork (RaftPostgresT m)

Defined in Raft.Log.PostgreSQL

Associated Types

type RaftThreadId (RaftPostgresT m) :: Type

Methods

raftFork :: RaftThreadRole -> RaftPostgresT m () -> RaftPostgresT m (RaftThreadId (RaftPostgresT m))

(MonadIO m, MonadRaftFork m) => MonadRaftFork (RaftPersistFileStoreT m)

Defined in Examples.Raft.FileStore.Persistent

Associated Types

type RaftThreadId (RaftPersistFileStoreT m) :: Type

Methods

raftFork :: RaftThreadRole -> RaftPersistFileStoreT m () -> RaftPersistFileStoreT m (RaftThreadId (RaftPersistFileStoreT m))

(MonadIO m, MonadRaftFork m) => MonadRaftFork (RaftLogFileStoreT m)

Defined in Examples.Raft.FileStore.Log

Associated Types

type RaftThreadId (RaftLogFileStoreT m) :: Type

Methods

raftFork :: RaftThreadRole -> RaftLogFileStoreT m () -> RaftLogFileStoreT m (RaftThreadId (RaftLogFileStoreT m))

MonadRaftFork m => MonadRaftFork (RaftT v m)

Defined in Raft.Monad

Associated Types

type RaftThreadId (RaftT v m) :: Type

Methods

raftFork :: RaftThreadRole -> RaftT v m () -> RaftT v m (RaftThreadId (RaftT v m))

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

Defined in Examples.Raft.Socket.Node

Associated Types

type RaftThreadId (RaftSocketT sm v m) :: Type

Methods

raftFork :: RaftThreadRole -> RaftSocketT sm v m () -> RaftSocketT sm v m (RaftThreadId (RaftSocketT sm v m))

data RaftEnv v m

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)

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

initializeRaftEnv :: MonadIO m => RaftEventChan v m -> m () -> m () -> RaftNodeConfig -> LogCtx (RaftT v m) -> m (RaftEnv v m)

data RaftT v m a

Instances

Monad m => RaftLogger v (RaftT v m)

Defined in Raft.Monad

Methods

loggerCtx :: RaftT v m (NodeId, RaftNodeState v)

MonadTrans (RaftT v)

Defined in Raft.Monad

Methods

lift :: Monad m => m a -> RaftT v m a

Monad m => MonadState (RaftNodeState v) (RaftT v m)

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

Monad m => Monad (RaftT v m)

Defined in Raft.Monad

Methods

(>>=) :: RaftT v m a -> (a -> RaftT v m b) -> RaftT v m b

(>>) :: RaftT v m a -> RaftT v m b -> RaftT v m b

return :: a -> RaftT v m a

fail :: String -> RaftT v m a

Functor m => Functor (RaftT v m)

Defined in Raft.Monad

Methods

fmap :: (a -> b) -> RaftT v m a -> RaftT v m b

(<$) :: a -> RaftT v m b -> RaftT v m a

MonadFail m => MonadFail (RaftT v m)

Defined in Raft.Monad

Methods

fail :: String -> RaftT v m a

Monad m => Applicative (RaftT v m)

Defined in Raft.Monad

Methods

pure :: a -> RaftT v m a

(<*>) :: RaftT v m (a -> b) -> RaftT v m a -> RaftT v m b

liftA2 :: (a -> b -> c) -> RaftT v m a -> RaftT v m b -> RaftT v m c

(*>) :: RaftT v m a -> RaftT v m b -> RaftT v m b

(<*) :: RaftT v m a -> RaftT v m b -> RaftT v m a

MonadPlus m => Alternative (RaftT v m)

Defined in Raft.Monad

Methods

empty :: RaftT v m a

(<|>) :: RaftT v m a -> RaftT v m a -> RaftT v m a

some :: RaftT v m a -> RaftT v m [a]

many :: RaftT v m a -> RaftT v m [a]

MonadPlus m => MonadPlus (RaftT v m)

Defined in Raft.Monad

Methods

mzero :: RaftT v m a

mplus :: RaftT v m a -> RaftT v m a -> RaftT v m a

MonadIO m => MonadIO (RaftT v m)

Defined in Raft.Monad

Methods

liftIO :: IO a -> RaftT v m a

MonadThrow m => MonadThrow (RaftT v m)

Defined in Raft.Monad

Methods

throwM :: Exception e => e -> RaftT v m a

MonadCatch m => MonadCatch (RaftT v m)

Defined in Raft.Monad

Methods

catch :: Exception e => RaftT v m a -> (e -> RaftT v m a) -> RaftT v m a

MonadMask m => MonadMask (RaftT v m)

Defined in Raft.Monad

Methods

mask :: ((forall a. RaftT v m a -> RaftT v m a) -> RaftT v m b) -> RaftT v m b

uninterruptibleMask :: ((forall a. RaftT v m a -> RaftT v m a) -> RaftT v m b) -> RaftT v m b

generalBracket :: RaftT v m a -> (a -> ExitCase b -> RaftT v m c) -> (a -> RaftT v m b) -> RaftT v m (b, c)

Monad m => MonadMetrics (RaftT v m)

Defined in Raft.Monad

Methods

getMetrics :: RaftT v m Metrics

MonadRaftFork m => MonadRaftFork (RaftT v m)

Defined in Raft.Monad

Associated Types

type RaftThreadId (RaftT v m) :: Type

Methods

raftFork :: RaftThreadRole -> RaftT v m () -> RaftT v m (RaftThreadId (RaftT v m))

Monad m => MonadReader (RaftEnv v m) (RaftT v m)

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

type RaftThreadId (RaftT v m)

Defined in Raft.Monad

type RaftThreadId (RaftT v m) = RaftThreadId m

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

logInfo :: MonadIO m => Text -> RaftT v m ()

logDebug :: MonadIO m => Text -> RaftT v m ()

logCritical :: MonadIO m => Text -> RaftT v m ()

logAndPanic :: MonadIO m => Text -> RaftT v m a