Safe Haskell	None
Language	Haskell2010

Raft.RPC

Synopsis

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))
data RPCMessage v = RPCMessage {
- sender :: NodeId
- rpc :: RPC v
}
data RPC v
class RPCType a v where
- toRPC :: a -> RPC v
rpcTerm :: RPC v -> Term
data NoEntriesSpec
- = FromInconsistency
- | FromHeartbeat
- | FromClientReadReq Int
data EntriesSpec v
- = FromIndex Index
- | FromNewLeader (Entry v)
- | FromClientWriteReq (Entry v)
- | NoEntries NoEntriesSpec
data AppendEntriesData v = AppendEntriesData {
- aedTerm :: Term
- aedLeaderCommit :: Index
- aedEntriesSpec :: EntriesSpec 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
}

Documentation

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

(MonadIO m, MonadConc m, Serialize v, Show v) => RaftSendRPC (RaftSocketT v m) v Source #
Instance details Defined in Examples.Raft.Socket.Node Methods sendRPC :: NodeId -> RPCMessage v -> RaftSocketT 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

(MonadIO m, MonadConc m, Show v) => RaftRecvRPC (RaftSocketT v m) v Source #
Instance details Defined in Examples.Raft.Socket.Node Associated Types type RaftRecvRPCError (RaftSocketT v m) v :: Type Source # Methods receiveRPC :: RaftSocketT v m (Either (RaftRecvRPCError (RaftSocketT v m) v) (RPCMessage 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.1.1.0-8nwazCMBvi7EUIW9UIbZhF" 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 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.1.1.0-8nwazCMBvi7EUIW9UIbZhF" 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 #

rpcTerm :: RPC v -> Term Source #

data NoEntriesSpec Source #

Constructors

FromInconsistency
FromHeartbeat
FromClientReadReq Int

Instances

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

data EntriesSpec v Source #

Constructors

FromIndex Index
FromNewLeader (Entry v)
FromClientWriteReq (Entry v)
NoEntries NoEntriesSpec

Instances

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

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 :: EntriesSpec 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 #

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.1.1.0-8nwazCMBvi7EUIW9UIbZhF" 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.1.1.0-8nwazCMBvi7EUIW9UIbZhF" 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.1.1.0-8nwazCMBvi7EUIW9UIbZhF" 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.1.1.0-8nwazCMBvi7EUIW9UIbZhF" False) (C1 (MetaCons "RequestVoteResponse" PrefixI True) (S1 (MetaSel (Just "rvrTerm") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Term) :*: S1 (MetaSel (Just "rvrVoteGranted") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))