Raft.RPC

Documentation

class RaftSendRPC m v where

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

Methods

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

Instances

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

Defined in Raft.Log.PostgreSQL

Methods

sendRPC :: NodeId -> RPCMessage v -> RaftPostgresT m ()

(MonadIO m, MonadMask m, RaftSendRPC m v) => RaftSendRPC (RaftPersistFileStoreT m) v

Defined in Examples.Raft.FileStore.Persistent

Methods

sendRPC :: NodeId -> RPCMessage v -> RaftPersistFileStoreT m ()

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

Defined in Examples.Raft.FileStore.Log

Methods

sendRPC :: NodeId -> RPCMessage v -> RaftLogFileStoreT m ()

(MonadCatch m, MonadMask m, MonadIO m, Serialize v, Show v) => RaftSendRPC (RaftSocketT sm v m) v

Defined in Examples.Raft.Socket.Node

Methods

sendRPC :: NodeId -> RPCMessage v -> RaftSocketT sm v m ()

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

Interface for nodes to receive messages from one another

Associated Types

type RaftRecvRPCError m v

Methods

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

Instances

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

Defined in Raft.Log.PostgreSQL

Associated Types

type RaftRecvRPCError (RaftPostgresT m) v :: Type

Methods

receiveRPC :: RaftPostgresT m (Either (RaftRecvRPCError (RaftPostgresT m) v) (RPCMessage v))

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

Defined in Examples.Raft.FileStore.Persistent

Associated Types

type RaftRecvRPCError (RaftPersistFileStoreT m) v :: Type

Methods

receiveRPC :: RaftPersistFileStoreT m (Either (RaftRecvRPCError (RaftPersistFileStoreT m) v) (RPCMessage v))

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

Defined in Examples.Raft.FileStore.Log

Associated Types

type RaftRecvRPCError (RaftLogFileStoreT m) v :: Type

Methods

receiveRPC :: RaftLogFileStoreT m (Either (RaftRecvRPCError (RaftLogFileStoreT m) v) (RPCMessage v))

(MonadIO m, Show v) => RaftRecvRPC (RaftSocketT sm v m) v

Defined in Examples.Raft.Socket.Node

Associated Types

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

Methods

receiveRPC :: RaftSocketT sm v m (Either (RaftRecvRPCError (RaftSocketT sm v m) v) (RPCMessage v))

data RPCMessage v

Representation of a message sent between nodes

Constructors

RPCMessage

Fields

• sender :: NodeId
• rpc :: RPC v

Instances

Show v => Show (RPCMessage v)

Defined in Raft.RPC

Methods

showsPrec :: Int -> RPCMessage v -> ShowS

show :: RPCMessage v -> String

showList :: [RPCMessage v] -> ShowS

Generic (RPCMessage v)

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)

Defined in Raft.RPC

Methods

put :: Putter (RPCMessage v)

get :: Get (RPCMessage v)

type Rep (RPCMessage v)

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 RPC v

Constructors

AppendEntriesRPC (AppendEntries v)

AppendEntriesResponseRPC AppendEntriesResponse

RequestVoteRPC RequestVote

RequestVoteResponseRPC RequestVoteResponse

Instances

Show v => Show (RPC v)

Defined in Raft.RPC

Methods

showsPrec :: Int -> RPC v -> ShowS

show :: RPC v -> String

showList :: [RPC v] -> ShowS

Generic (RPC v)

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)

Defined in Raft.RPC

Methods

put :: Putter (RPC v)

get :: Get (RPC v)

type Rep (RPC v)

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

Methods

toRPC :: a -> RPC v

Instances

RPCType RequestVoteResponse v

Defined in Raft.RPC

Methods

toRPC :: RequestVoteResponse -> RPC v

RPCType RequestVote v

Defined in Raft.RPC

Methods

toRPC :: RequestVote -> RPC v

RPCType AppendEntriesResponse v

Defined in Raft.RPC

Methods

toRPC :: AppendEntriesResponse -> RPC v

RPCType (AppendEntries v) v

Defined in Raft.RPC

Methods

toRPC :: AppendEntries v -> RPC v

rpcTerm :: RPC v -> Term

data NoEntriesSpec

Constructors

FromHeartbeat

FromClientReadReq Int

Instances

Show NoEntriesSpec

Defined in Raft.RPC

Methods

showsPrec :: Int -> NoEntriesSpec -> ShowS

show :: NoEntriesSpec -> String

showList :: [NoEntriesSpec] -> ShowS

data AppendEntriesSpec v

Constructors

FromIndex Index

FromNewLeader (Entry v)

FromClientWriteReq (Entry v)

NoEntries NoEntriesSpec

Instances

Show v => Show (AppendEntriesSpec v)

Defined in Raft.RPC

Methods

showsPrec :: Int -> AppendEntriesSpec v -> ShowS

show :: AppendEntriesSpec v -> String

showList :: [AppendEntriesSpec v] -> ShowS

data AppendEntriesData v

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)

Defined in Raft.RPC

Methods

showsPrec :: Int -> AppendEntriesData v -> ShowS

show :: AppendEntriesData v -> String

showList :: [AppendEntriesData v] -> ShowS

data AppendEntries v

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)

Defined in Raft.RPC

Methods

showsPrec :: Int -> AppendEntries v -> ShowS

show :: AppendEntries v -> String

showList :: [AppendEntries v] -> ShowS

Generic (AppendEntries v)

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)

Defined in Raft.RPC

Methods

put :: Putter (AppendEntries v)

get :: Get (AppendEntries v)

RPCType (AppendEntries v) v

Defined in Raft.RPC

Methods

toRPC :: AppendEntries v -> RPC v

type Rep (AppendEntries v)

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

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

Defined in Raft.RPC

Methods

showsPrec :: Int -> AppendEntriesResponse -> ShowS

show :: AppendEntriesResponse -> String

showList :: [AppendEntriesResponse] -> ShowS

Generic AppendEntriesResponse

Defined in Raft.RPC

Associated Types

type Rep AppendEntriesResponse :: Type -> Type

Methods

from :: AppendEntriesResponse -> Rep AppendEntriesResponse x

to :: Rep AppendEntriesResponse x -> AppendEntriesResponse

Serialize AppendEntriesResponse

Defined in Raft.RPC

Methods

put :: Putter AppendEntriesResponse

get :: Get AppendEntriesResponse

RPCType AppendEntriesResponse v

Defined in Raft.RPC

Methods

toRPC :: AppendEntriesResponse -> RPC v

type Rep AppendEntriesResponse

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

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

Defined in Raft.RPC

Methods

showsPrec :: Int -> RequestVote -> ShowS

show :: RequestVote -> String

showList :: [RequestVote] -> ShowS

Generic RequestVote

Defined in Raft.RPC

Associated Types

type Rep RequestVote :: Type -> Type

Methods

from :: RequestVote -> Rep RequestVote x

to :: Rep RequestVote x -> RequestVote

Serialize RequestVote

Defined in Raft.RPC

Methods

put :: Putter RequestVote

get :: Get RequestVote

RPCType RequestVote v

Defined in Raft.RPC

Methods

toRPC :: RequestVote -> RPC v

type Rep RequestVote

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

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

Defined in Raft.RPC

Methods

showsPrec :: Int -> RequestVoteResponse -> ShowS

show :: RequestVoteResponse -> String

showList :: [RequestVoteResponse] -> ShowS

Generic RequestVoteResponse

Defined in Raft.RPC

Associated Types

type Rep RequestVoteResponse :: Type -> Type

Methods

from :: RequestVoteResponse -> Rep RequestVoteResponse x

to :: Rep RequestVoteResponse x -> RequestVoteResponse

Serialize RequestVoteResponse

Defined in Raft.RPC

Methods

put :: Putter RequestVoteResponse

get :: Get RequestVoteResponse

RPCType RequestVoteResponse v

Defined in Raft.RPC

Methods

toRPC :: RequestVoteResponse -> RPC v

type Rep RequestVoteResponse

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