Raft.Client

Raft Interface

class RaftStateMachinePure sm v => RaftSendClient m sm v where

Interface for Raft nodes to send messages to clients

Methods

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

Instances

(Monad m, RaftSendClient m sm v) => RaftSendClient (RaftPostgresT m) sm v

Defined in Raft.Log.PostgreSQL

Methods

sendClient :: ClientId -> ClientResponse sm v -> RaftPostgresT m ()

(MonadIO m, MonadMask m, RaftSendClient m sm v) => RaftSendClient (RaftPersistFileStoreT m) sm v

Defined in Examples.Raft.FileStore.Persistent

Methods

sendClient :: ClientId -> ClientResponse sm v -> RaftPersistFileStoreT m ()

(Monad m, RaftSendClient m sm v) => RaftSendClient (RaftLogFileStoreT m) sm v

Defined in Examples.Raft.FileStore.Log

Methods

sendClient :: ClientId -> ClientResponse sm v -> RaftLogFileStoreT m ()

(RaftStateMachinePure sm v, MonadMask m, MonadCatch m, MonadIO m, Serialize sm, Serialize v) => RaftSendClient (RaftSocketT sm v m) sm v

Defined in Examples.Raft.Socket.Node

Methods

sendClient :: ClientId -> ClientResponse sm v -> RaftSocketT sm v m ()

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

Interface for Raft nodes to receive messages from clients

Associated Types

type RaftRecvClientError m v

Methods

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

Instances

(Monad m, RaftRecvClient m v) => RaftRecvClient (RaftPostgresT m) v

Defined in Raft.Log.PostgreSQL

Associated Types

type RaftRecvClientError (RaftPostgresT m) v :: Type

Methods

receiveClient :: RaftPostgresT m (Either (RaftRecvClientError (RaftPostgresT m) v) (ClientRequest v))

(MonadIO m, RaftRecvClient m v) => RaftRecvClient (RaftPersistFileStoreT m) v

Defined in Examples.Raft.FileStore.Persistent

Associated Types

type RaftRecvClientError (RaftPersistFileStoreT m) v :: Type

Methods

receiveClient :: RaftPersistFileStoreT m (Either (RaftRecvClientError (RaftPersistFileStoreT m) v) (ClientRequest v))

(Monad m, RaftRecvClient m v) => RaftRecvClient (RaftLogFileStoreT m) v

Defined in Examples.Raft.FileStore.Log

Associated Types

type RaftRecvClientError (RaftLogFileStoreT m) v :: Type

Methods

receiveClient :: RaftLogFileStoreT m (Either (RaftRecvClientError (RaftLogFileStoreT m) v) (ClientRequest v))

(MonadIO m, Serialize v) => RaftRecvClient (RaftSocketT sm v m) v

Defined in Examples.Raft.Socket.Node

Associated Types

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

Methods

receiveClient :: RaftSocketT sm v m (Either (RaftRecvClientError (RaftSocketT sm v m) v) (ClientRequest v))

newtype SerialNum

Constructors

SerialNum Natural

Instances

Enum SerialNum

Defined in Raft.Types

Methods

succ :: SerialNum -> SerialNum

pred :: SerialNum -> SerialNum

toEnum :: Int -> SerialNum

fromEnum :: SerialNum -> Int

enumFrom :: SerialNum -> [SerialNum]

enumFromThen :: SerialNum -> SerialNum -> [SerialNum]

enumFromTo :: SerialNum -> SerialNum -> [SerialNum]

enumFromThenTo :: SerialNum -> SerialNum -> SerialNum -> [SerialNum]

Eq SerialNum

Defined in Raft.Types

Methods

(==) :: SerialNum -> SerialNum -> Bool

(/=) :: SerialNum -> SerialNum -> Bool

Num SerialNum

Defined in Raft.Types

Methods

(+) :: SerialNum -> SerialNum -> SerialNum

(-) :: SerialNum -> SerialNum -> SerialNum

(*) :: SerialNum -> SerialNum -> SerialNum

negate :: SerialNum -> SerialNum

abs :: SerialNum -> SerialNum

signum :: SerialNum -> SerialNum

fromInteger :: Integer -> SerialNum

Ord SerialNum

Defined in Raft.Types

Methods

compare :: SerialNum -> SerialNum -> Ordering

(<) :: SerialNum -> SerialNum -> Bool

(<=) :: SerialNum -> SerialNum -> Bool

(>) :: SerialNum -> SerialNum -> Bool

(>=) :: SerialNum -> SerialNum -> Bool

max :: SerialNum -> SerialNum -> SerialNum

min :: SerialNum -> SerialNum -> SerialNum

Read SerialNum

Defined in Raft.Types

Methods

readsPrec :: Int -> ReadS SerialNum

readList :: ReadS [SerialNum]

readPrec :: ReadPrec SerialNum

readListPrec :: ReadPrec [SerialNum]

Show SerialNum

Defined in Raft.Types

Methods

showsPrec :: Int -> SerialNum -> ShowS

show :: SerialNum -> String

showList :: [SerialNum] -> ShowS

Generic SerialNum

Defined in Raft.Types

Associated Types

type Rep SerialNum :: Type -> Type

Methods

from :: SerialNum -> Rep SerialNum x

to :: Rep SerialNum x -> SerialNum

Serialize SerialNum

Defined in Raft.Types

Methods

put :: Putter SerialNum

get :: Get SerialNum

type Rep SerialNum

Defined in Raft.Types

type Rep SerialNum = D1 (MetaData "SerialNum" "Raft.Types" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" True) (C1 (MetaCons "SerialNum" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Natural)))

Client Requests

data ClientRequest v

Representation of a client request coupled with the client id

Constructors

ClientRequest ClientId (ClientReq v)

Instances

Show v => Show (ClientRequest v)

Defined in Raft.Client

Methods

showsPrec :: Int -> ClientRequest v -> ShowS

show :: ClientRequest v -> String

showList :: [ClientRequest v] -> ShowS

Generic (ClientRequest v)

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)

Defined in Raft.Client

Methods

put :: Putter (ClientRequest v)

get :: Get (ClientRequest v)

type Rep (ClientRequest v)

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

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)

Defined in Raft.Client

Methods

showsPrec :: Int -> ClientReq v -> ShowS

show :: ClientReq v -> String

showList :: [ClientReq v] -> ShowS

Generic (ClientReq v)

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)

Defined in Raft.Client

Methods

put :: Putter (ClientReq v)

get :: Get (ClientReq v)

type Rep (ClientReq v)

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))))

class ClientReqType a v

Typeclass to make it easier to write polymorphic functions over ClientReq types

Instances

ClientReqType ClientMetricsReq v

Defined in Raft.Client

ClientReqType ClientReadReq v

Defined in Raft.Client

ClientReqType (ClientWriteReq v) v

Defined in Raft.Client

data ClientReadReq

Constructors

ClientReadEntries ReadEntriesSpec

ClientReadStateMachine

Instances

Show ClientReadReq

Defined in Raft.Client

Methods

showsPrec :: Int -> ClientReadReq -> ShowS

show :: ClientReadReq -> String

showList :: [ClientReadReq] -> ShowS

Generic ClientReadReq

Defined in Raft.Client

Associated Types

type Rep ClientReadReq :: Type -> Type

Methods

from :: ClientReadReq -> Rep ClientReadReq x

to :: Rep ClientReadReq x -> ClientReadReq

Serialize ClientReadReq

Defined in Raft.Client

Methods

put :: Putter ClientReadReq

get :: Get ClientReadReq

ClientReqType ClientReadReq v

Defined in Raft.Client

type Rep ClientReadReq

Defined in Raft.Client

type Rep ClientReadReq = D1 (MetaData "ClientReadReq" "Raft.Client" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "ClientReadEntries" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ReadEntriesSpec)) :+: C1 (MetaCons "ClientReadStateMachine" PrefixI False) (U1 :: Type -> Type))

data ReadEntriesSpec

Instances

Show ReadEntriesSpec

Defined in Raft.Log

Methods

showsPrec :: Int -> ReadEntriesSpec -> ShowS

show :: ReadEntriesSpec -> String

showList :: [ReadEntriesSpec] -> ShowS

Generic ReadEntriesSpec

Defined in Raft.Log

Associated Types

type Rep ReadEntriesSpec :: Type -> Type

Methods

from :: ReadEntriesSpec -> Rep ReadEntriesSpec x

to :: Rep ReadEntriesSpec x -> ReadEntriesSpec

Serialize ReadEntriesSpec

Defined in Raft.Log

Methods

put :: Putter ReadEntriesSpec

get :: Get ReadEntriesSpec

type Rep ReadEntriesSpec

Defined in Raft.Log

type Rep ReadEntriesSpec = D1 (MetaData "ReadEntriesSpec" "Raft.Log" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "ByIndex" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Index)) :+: C1 (MetaCons "ByIndices" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 IndexInterval)))

data ClientWriteReq v

Constructors

ClientCmdReq SerialNum v

Issue a command to update the state machine

Instances

Show v => Show (ClientWriteReq v)

Defined in Raft.Client

Methods

showsPrec :: Int -> ClientWriteReq v -> ShowS

show :: ClientWriteReq v -> String

showList :: [ClientWriteReq v] -> ShowS

Generic (ClientWriteReq v)

Defined in Raft.Client

Associated Types

type Rep (ClientWriteReq v) :: Type -> Type

Methods

from :: ClientWriteReq v -> Rep (ClientWriteReq v) x

to :: Rep (ClientWriteReq v) x -> ClientWriteReq v

Serialize v => Serialize (ClientWriteReq v)

Defined in Raft.Client

Methods

put :: Putter (ClientWriteReq v)

get :: Get (ClientWriteReq v)

ClientReqType (ClientWriteReq v) v

Defined in Raft.Client

type Rep (ClientWriteReq v)

Defined in Raft.Client

type Rep (ClientWriteReq v) = D1 (MetaData "ClientWriteReq" "Raft.Client" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "ClientCmdReq" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SerialNum) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 v)))

data ClientMetricsReq

Constructors

ClientAllMetricsReq

Instances

Show ClientMetricsReq

Defined in Raft.Client

Methods

showsPrec :: Int -> ClientMetricsReq -> ShowS

show :: ClientMetricsReq -> String

showList :: [ClientMetricsReq] -> ShowS

Generic ClientMetricsReq

Defined in Raft.Client

Associated Types

type Rep ClientMetricsReq :: Type -> Type

Methods

from :: ClientMetricsReq -> Rep ClientMetricsReq x

to :: Rep ClientMetricsReq x -> ClientMetricsReq

Serialize ClientMetricsReq

Defined in Raft.Client

Methods

put :: Putter ClientMetricsReq

get :: Get ClientMetricsReq

ClientReqType ClientMetricsReq v

Defined in Raft.Client

type Rep ClientMetricsReq

Defined in Raft.Client

type Rep ClientMetricsReq = D1 (MetaData "ClientMetricsReq" "Raft.Client" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "ClientAllMetricsReq" PrefixI False) (U1 :: Type -> Type))

Client Responses

data ClientResponse sm v

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)

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)

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)

Defined in Raft.Client

Methods

put :: Putter (ClientResponse sm v)

get :: Get (ClientResponse sm v)

type Rep (ClientResponse sm v)

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

Specification for the data inside a ClientResponse

Constructors

ClientReadRespSpec (ClientReadRespSpec sm)

ClientWriteRespSpec (ClientWriteRespSpec sm v)

ClientRedirRespSpec CurrentLeader

ClientMetricsRespSpec RaftNodeMetrics

Instances

(Show sm, Show v, Show (RaftStateMachinePureError sm v)) => Show (ClientRespSpec sm v)

Defined in Raft.Client

Methods

showsPrec :: Int -> ClientRespSpec sm v -> ShowS

show :: ClientRespSpec sm v -> String

showList :: [ClientRespSpec sm v] -> ShowS

Generic (ClientRespSpec sm v)

Defined in Raft.Client

Associated Types

type Rep (ClientRespSpec sm v) :: Type -> Type

Methods

from :: ClientRespSpec sm v -> Rep (ClientRespSpec sm v) x

to :: Rep (ClientRespSpec sm v) x -> ClientRespSpec sm v

(Serialize sm, Serialize v, Serialize (RaftStateMachinePureError sm v)) => Serialize (ClientRespSpec sm v)

Defined in Raft.Client

Methods

put :: Putter (ClientRespSpec sm v)

get :: Get (ClientRespSpec sm v)

type Rep (ClientRespSpec sm v)

Defined in Raft.Client

type Rep (ClientRespSpec sm v) = D1 (MetaData "ClientRespSpec" "Raft.Client" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) ((C1 (MetaCons "ClientReadRespSpec" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ClientReadRespSpec sm))) :+: C1 (MetaCons "ClientWriteRespSpec" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ClientWriteRespSpec sm v)))) :+: (C1 (MetaCons "ClientRedirRespSpec" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CurrentLeader)) :+: C1 (MetaCons "ClientMetricsRespSpec" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RaftNodeMetrics))))

data ClientReadRespSpec sm

Constructors

ClientReadRespSpecEntries ReadEntriesSpec

ClientReadRespSpecStateMachine sm

Instances

Show sm => Show (ClientReadRespSpec sm)

Defined in Raft.Client

Methods

showsPrec :: Int -> ClientReadRespSpec sm -> ShowS

show :: ClientReadRespSpec sm -> String

showList :: [ClientReadRespSpec sm] -> ShowS

Generic (ClientReadRespSpec sm)

Defined in Raft.Client

Associated Types

type Rep (ClientReadRespSpec sm) :: Type -> Type

Methods

from :: ClientReadRespSpec sm -> Rep (ClientReadRespSpec sm) x

to :: Rep (ClientReadRespSpec sm) x -> ClientReadRespSpec sm

Serialize sm => Serialize (ClientReadRespSpec sm)

Defined in Raft.Client

Methods

put :: Putter (ClientReadRespSpec sm)

get :: Get (ClientReadRespSpec sm)

type Rep (ClientReadRespSpec sm)

Defined in Raft.Client

type Rep (ClientReadRespSpec sm) = D1 (MetaData "ClientReadRespSpec" "Raft.Client" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "ClientReadRespSpecEntries" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ReadEntriesSpec)) :+: C1 (MetaCons "ClientReadRespSpecStateMachine" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 sm)))

data ClientWriteRespSpec sm v

Constructors

ClientWriteRespSpecSuccess Index SerialNum

ClientWriteRespSpecFail SerialNum (RaftStateMachinePureError sm v)

Instances

(Show sm, Show v, Show (RaftStateMachinePureError sm v)) => Show (ClientWriteRespSpec sm v)

Defined in Raft.Client

Methods

showsPrec :: Int -> ClientWriteRespSpec sm v -> ShowS

show :: ClientWriteRespSpec sm v -> String

showList :: [ClientWriteRespSpec sm v] -> ShowS

Generic (ClientWriteRespSpec sm v)

Defined in Raft.Client

Associated Types

type Rep (ClientWriteRespSpec sm v) :: Type -> Type

Methods

from :: ClientWriteRespSpec sm v -> Rep (ClientWriteRespSpec sm v) x

to :: Rep (ClientWriteRespSpec sm v) x -> ClientWriteRespSpec sm v

(Serialize sm, Serialize v, Serialize (RaftStateMachinePureError sm v)) => Serialize (ClientWriteRespSpec sm v)

Defined in Raft.Client

Methods

put :: Putter (ClientWriteRespSpec sm v)

get :: Get (ClientWriteRespSpec sm v)

type Rep (ClientWriteRespSpec sm v)

Defined in Raft.Client

type Rep (ClientWriteRespSpec sm v) = D1 (MetaData "ClientWriteRespSpec" "Raft.Client" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "ClientWriteRespSpecSuccess" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Index) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SerialNum)) :+: C1 (MetaCons "ClientWriteRespSpecFail" 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 ClientReadResp sm v

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)

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)

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)

Defined in Raft.Client

Methods

put :: Putter (ClientReadResp sm v)

get :: Get (ClientReadResp sm v)

type Rep (ClientReadResp sm v)

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

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)

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)

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)

Defined in Raft.Client

Methods

put :: Putter (ClientWriteResp sm v)

get :: Get (ClientWriteResp sm v)

type Rep (ClientWriteResp sm v)

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

Representation of a redirect response to a client

Constructors

ClientRedirResp CurrentLeader

Instances

Show ClientRedirResp

Defined in Raft.Client

Methods

showsPrec :: Int -> ClientRedirResp -> ShowS

show :: ClientRedirResp -> String

showList :: [ClientRedirResp] -> ShowS

Generic ClientRedirResp

Defined in Raft.Client

Associated Types

type Rep ClientRedirResp :: Type -> Type

Methods

from :: ClientRedirResp -> Rep ClientRedirResp x

to :: Rep ClientRedirResp x -> ClientRedirResp

Serialize ClientRedirResp

Defined in Raft.Client

Methods

put :: Putter ClientRedirResp

get :: Get ClientRedirResp

type Rep ClientRedirResp

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)))

data ClientMetricsResp

Constructors

ClientMetricsResp RaftNodeMetrics

Instances

Show ClientMetricsResp

Defined in Raft.Client

Methods

showsPrec :: Int -> ClientMetricsResp -> ShowS

show :: ClientMetricsResp -> String

showList :: [ClientMetricsResp] -> ShowS

Generic ClientMetricsResp

Defined in Raft.Client

Associated Types

type Rep ClientMetricsResp :: Type -> Type

Methods

from :: ClientMetricsResp -> Rep ClientMetricsResp x

to :: Rep ClientMetricsResp x -> ClientMetricsResp

Serialize ClientMetricsResp

Defined in Raft.Client

Methods

put :: Putter ClientMetricsResp

get :: Get ClientMetricsResp

type Rep ClientMetricsResp

Defined in Raft.Client

type Rep ClientMetricsResp = D1 (MetaData "ClientMetricsResp" "Raft.Client" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "ClientMetricsResp" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RaftNodeMetrics)))

Client Interface

class Monad m => RaftClientSend m v where

Associated Types

type RaftClientSendError m v

Methods

raftClientSend :: NodeId -> ClientRequest v -> m (Either (RaftClientSendError m v) ())

Instances

RaftClientSend m v => RaftClientSend (RaftClientT s v m) v

Defined in Raft.Client

Associated Types

type RaftClientSendError (RaftClientT s v m) v :: Type

Methods

raftClientSend :: NodeId -> ClientRequest v -> RaftClientT s v m (Either (RaftClientSendError (RaftClientT s v m) v) ())

(Serialize s, Serialize v, Serialize (RaftStateMachinePureError s v), MonadIO m) => RaftClientSend (RaftClientRespChanT s v m) v

Defined in Examples.Raft.Socket.Client

Associated Types

type RaftClientSendError (RaftClientRespChanT s v m) v :: Type

Methods

raftClientSend :: NodeId -> ClientRequest v -> RaftClientRespChanT s v m (Either (RaftClientSendError (RaftClientRespChanT s v m) v) ())

class Monad m => RaftClientRecv m sm v | m sm -> v where

Associated Types

type RaftClientRecvError m sm

Methods

raftClientRecv :: m (Either (RaftClientRecvError m sm) (ClientResponse sm v))

Instances

RaftClientRecv m s v => RaftClientRecv (RaftClientT s v m) s v

Defined in Raft.Client

Associated Types

type RaftClientRecvError (RaftClientT s v m) s :: Type

Methods

raftClientRecv :: RaftClientT s v m (Either (RaftClientRecvError (RaftClientT s v m) s) (ClientResponse s v))

(Serialize s, Serialize v, MonadIO m) => RaftClientRecv (RaftClientRespChanT s v m) s v

Defined in Examples.Raft.Socket.Client

Associated Types

type RaftClientRecvError (RaftClientRespChanT s v m) s :: Type

Methods

raftClientRecv :: RaftClientRespChanT s v m (Either (RaftClientRecvError (RaftClientRespChanT s v m) s) (ClientResponse s v))

data RaftClientState

Each client may have at most one command outstanding at a time and commands must be dispatched in serial number order.

Constructors

RaftClientState

Fields

• raftClientCurrentLeader :: CurrentLeader
• raftClientSerialNum :: SerialNum
• raftClientRaftNodes :: Set NodeId
• raftClientRandomGen :: StdGen

Instances

Monad m => MonadState RaftClientState (RaftClientT s v m)

Defined in Raft.Client

Methods

get :: RaftClientT s v m RaftClientState

put :: RaftClientState -> RaftClientT s v m ()

state :: (RaftClientState -> (a, RaftClientState)) -> RaftClientT s v m a

data RaftClientEnv

Constructors

RaftClientEnv

Fields

• raftClientId :: ClientId

Instances

Monad m => MonadReader RaftClientEnv (RaftClientT s v m)

Defined in Raft.Client

Methods

ask :: RaftClientT s v m RaftClientEnv

local :: (RaftClientEnv -> RaftClientEnv) -> RaftClientT s v m a -> RaftClientT s v m a

reader :: (RaftClientEnv -> a) -> RaftClientT s v m a

initRaftClientState :: Set NodeId -> StdGen -> RaftClientState

data RaftClientT s v m a

Instances

MonadBase IO m => MonadBase IO (RaftClientT s v m)

Defined in Raft.Client

Methods

liftBase :: IO α -> RaftClientT s v m α

MonadBaseControl IO m => MonadBaseControl IO (RaftClientT s v m)

Defined in Raft.Client

Associated Types

type StM (RaftClientT s v m) a :: Type

Methods

liftBaseWith :: (RunInBase (RaftClientT s v m) IO -> IO a) -> RaftClientT s v m a

restoreM :: StM (RaftClientT s v m) a -> RaftClientT s v m a

Monad m => MonadState RaftClientState (RaftClientT s v m)

Defined in Raft.Client

Methods

get :: RaftClientT s v m RaftClientState

put :: RaftClientState -> RaftClientT s v m ()

state :: (RaftClientState -> (a, RaftClientState)) -> RaftClientT s v m a

Monad m => MonadReader RaftClientEnv (RaftClientT s v m)

Defined in Raft.Client

Methods

ask :: RaftClientT s v m RaftClientEnv

local :: (RaftClientEnv -> RaftClientEnv) -> RaftClientT s v m a -> RaftClientT s v m a

reader :: (RaftClientEnv -> a) -> RaftClientT s v m a

MonadTrans (RaftClientT s v)

Defined in Raft.Client

Methods

lift :: Monad m => m a -> RaftClientT s v m a

MonadTransControl (RaftClientT s v)

Defined in Raft.Client

Associated Types

type StT (RaftClientT s v) a :: Type

Methods

liftWith :: Monad m => (Run (RaftClientT s v) -> m a) -> RaftClientT s v m a

restoreT :: Monad m => m (StT (RaftClientT s v) a) -> RaftClientT s v m a

Monad m => Monad (RaftClientT s v m)

Defined in Raft.Client

Methods

(>>=) :: RaftClientT s v m a -> (a -> RaftClientT s v m b) -> RaftClientT s v m b

(>>) :: RaftClientT s v m a -> RaftClientT s v m b -> RaftClientT s v m b

return :: a -> RaftClientT s v m a

fail :: String -> RaftClientT s v m a

Functor m => Functor (RaftClientT s v m)

Defined in Raft.Client

Methods

fmap :: (a -> b) -> RaftClientT s v m a -> RaftClientT s v m b

(<$) :: a -> RaftClientT s v m b -> RaftClientT s v m a

MonadFail m => MonadFail (RaftClientT s v m)

Defined in Raft.Client

Methods

fail :: String -> RaftClientT s v m a

Monad m => Applicative (RaftClientT s v m)

Defined in Raft.Client

Methods

pure :: a -> RaftClientT s v m a

(<*>) :: RaftClientT s v m (a -> b) -> RaftClientT s v m a -> RaftClientT s v m b

liftA2 :: (a -> b -> c) -> RaftClientT s v m a -> RaftClientT s v m b -> RaftClientT s v m c

(*>) :: RaftClientT s v m a -> RaftClientT s v m b -> RaftClientT s v m b

(<*) :: RaftClientT s v m a -> RaftClientT s v m b -> RaftClientT s v m a

MonadPlus m => Alternative (RaftClientT s v m)

Defined in Raft.Client

Methods

empty :: RaftClientT s v m a

(<|>) :: RaftClientT s v m a -> RaftClientT s v m a -> RaftClientT s v m a

some :: RaftClientT s v m a -> RaftClientT s v m [a]

many :: RaftClientT s v m a -> RaftClientT s v m [a]

MonadPlus m => MonadPlus (RaftClientT s v m)

Defined in Raft.Client

Methods

mzero :: RaftClientT s v m a

mplus :: RaftClientT s v m a -> RaftClientT s v m a -> RaftClientT s v m a

MonadIO m => MonadIO (RaftClientT s v m)

Defined in Raft.Client

Methods

liftIO :: IO a -> RaftClientT s v m a

MonadThrow m => MonadThrow (RaftClientT s v m)

Defined in Raft.Client

Methods

throwM :: Exception e => e -> RaftClientT s v m a

MonadCatch m => MonadCatch (RaftClientT s v m)

Defined in Raft.Client

Methods

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

MonadMask m => MonadMask (RaftClientT s v m)

Defined in Raft.Client

Methods

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

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

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

MonadException m => MonadException (RaftClientT s v m)

Defined in Raft.Client

Methods

controlIO :: (RunIO (RaftClientT s v m) -> IO (RaftClientT s v m a)) -> RaftClientT s v m a

RaftClientSend m v => RaftClientSend (RaftClientT s v m) v

Defined in Raft.Client

Associated Types

type RaftClientSendError (RaftClientT s v m) v :: Type

Methods

raftClientSend :: NodeId -> ClientRequest v -> RaftClientT s v m (Either (RaftClientSendError (RaftClientT s v m) v) ())

RaftClientRecv m s v => RaftClientRecv (RaftClientT s v m) s v

Defined in Raft.Client

Associated Types

type RaftClientRecvError (RaftClientT s v m) s :: Type

Methods

raftClientRecv :: RaftClientT s v m (Either (RaftClientRecvError (RaftClientT s v m) s) (ClientResponse s v))

type StT (RaftClientT s v) a

Defined in Raft.Client

type StT (RaftClientT s v) a = StT (ReaderT RaftClientEnv :: (Type -> Type) -> Type -> Type) (StT (StateT RaftClientState) a)

type StM (RaftClientT s v m) a

Defined in Raft.Client

type StM (RaftClientT s v m) a = ComposeSt (RaftClientT s v) m a

type RaftClientRecvError (RaftClientT s v m) s

Defined in Raft.Client

type RaftClientRecvError (RaftClientT s v m) s = RaftClientRecvError m s

type RaftClientSendError (RaftClientT s v m) v

Defined in Raft.Client

type RaftClientSendError (RaftClientT s v m) v = RaftClientSendError m v

runRaftClientT :: Monad m => RaftClientEnv -> RaftClientState -> RaftClientT s v m a -> m a

data RaftClientError s v m where

Constructors

RaftClientSendError :: RaftClientSendError m v -> RaftClientError s v m

RaftClientRecvError :: RaftClientRecvError m s -> RaftClientError s v m

RaftClientTimeout :: Text -> RaftClientError s v m

RaftClientUnexpectedReadResp :: ClientReadResp s v -> RaftClientError s v m

RaftClientUnexpectedWriteResp :: ClientWriteResp s v -> RaftClientError s v m

RaftClientUnexpectedMetricsResp :: ClientMetricsResp -> RaftClientError s v m

RaftClientUnexpectedRedirect :: ClientRedirResp -> RaftClientError s v m

Instances

(Show s, Show v, Show (RaftClientSendError m v), Show (RaftClientRecvError m s), Show (RaftStateMachinePureError s v)) => Show (RaftClientError s v m)

Defined in Raft.Client

Methods

showsPrec :: Int -> RaftClientError s v m -> ShowS

show :: RaftClientError s v m -> String

showList :: [RaftClientError s v m] -> ShowS

clientRead :: (RaftClientSend m v, RaftClientRecv m s v) => ClientReadReq -> RaftClientT s v m (Either (RaftClientError s v m) (ClientReadResp s v))

Send a read request to the curent leader and wait for a response

clientReadFrom :: (RaftClientSend m v, RaftClientRecv m s v) => NodeId -> ClientReadReq -> RaftClientT s v m (Either (RaftClientError s v m) (ClientReadResp s v))

Send a read request to a specific raft node, regardless of leader, and wait for a response.

clientReadTimeout :: (MonadBaseControl IO m, RaftClientSend m v, RaftClientRecv m s v) => Int -> ClientReadReq -> RaftClientT s v m (Either (RaftClientError s v m) (ClientReadResp s v))

clientRead but with a timeout

clientWrite :: (RaftClientSend m v, RaftClientRecv m s v) => v -> RaftClientT s v m (Either (RaftClientError s v m) (ClientWriteResp s v))

Send a write request to the current leader and wait for a response

clientWriteTo :: (RaftClientSend m v, RaftClientRecv m s v) => NodeId -> v -> RaftClientT s v m (Either (RaftClientError s v m) (ClientWriteResp s v))

Send a read request to a specific raft node, regardless of leader, and wait for a response.

clientWriteTimeout :: (MonadBaseControl IO m, RaftClientSend m v, RaftClientRecv m s v) => Int -> v -> RaftClientT s v m (Either (RaftClientError s v m) (ClientWriteResp s v))

clientQueryNodeMetrics :: (MonadBaseControl IO m, RaftClientSend m v, RaftClientRecv m s v) => NodeId -> RaftClientT s v m (Either (RaftClientError s v m) ClientMetricsResp)

clientQueryNodeMetricsTimeout :: (MonadBaseControl IO m, RaftClientSend m v, RaftClientRecv m s v) => Int -> NodeId -> RaftClientT s v m (Either (RaftClientError s v m) ClientMetricsResp)

clientSendRead :: RaftClientSend m v => ClientReadReq -> RaftClientT s v m (Either (RaftClientSendError m v) ())

Send a read request to the current leader. Nonblocking.

clientSendWrite :: RaftClientSend m v => v -> RaftClientT s v m (Either (RaftClientSendError m v) ())

Send a write request to the current leader. Nonblocking.

clientSendMetricsReqTo :: RaftClientSend m v => NodeId -> RaftClientT s v m (Either (RaftClientSendError m v) ())

clientSend :: RaftClientSend m v => ClientReq v -> RaftClientT s v m (Either (RaftClientSendError m v) ())

Send a request to the current leader. Nonblocking.

clientRecv :: RaftClientRecv m s v => RaftClientT s v m (Either (RaftClientRecvError m s) (ClientResponse s v))

Wait for a response from the current leader. This function handles leader changes and write request serial numbers.

clientTimeout :: (MonadBaseControl IO m, RaftClientSend m v, RaftClientRecv m s v) => Text -> Int -> RaftClientT s v m (Either (RaftClientError s v m) r) -> RaftClientT s v m (Either (RaftClientError s v m) r)

retryOnRedirect :: MonadBaseControl IO m => RaftClientT s v m (Either (RaftClientError s v m) r) -> RaftClientT s v m (Either (RaftClientError s v m) r)

Given a blocking client send/receive, retry if the received value is not expected

clientAddNode :: Monad m => NodeId -> RaftClientT s v m ()

clientGetNodes :: Monad m => RaftClientT s v m (Set NodeId)