Safe Haskell	None
Language	Haskell2010

Raft.Types

Synopsis

type NodeId = ByteString
type NodeIds = Set NodeId
newtype ClientId = ClientId NodeId
newtype LeaderId = LeaderId {
- unLeaderId :: NodeId
}
data CurrentLeader
- = CurrentLeader LeaderId
- | NoLeader
data Mode
- = Follower
- | Candidate
- | Leader
newtype Term = Term Natural
intToNatural :: Int -> Either [Char] Natural
term0 :: Term
incrTerm :: Term -> Term
prevTerm :: Term -> Term
newtype Index = Index Natural
index0 :: Index
incrIndex :: Index -> Index
decrIndexWithDefault0 :: Index -> Index
newtype SerialNum = SerialNum Natural

Documentation

type NodeId = ByteString Source #

Unique identifier of a Raft node

type NodeIds = Set NodeId Source #

newtype ClientId Source #

Unique identifier of a client

Constructors

ClientId NodeId

Instances

Eq ClientId Source #
Instance details Defined in Raft.Types Methods (==) :: ClientId -> ClientId -> Bool # (/=) :: ClientId -> ClientId -> Bool #
Ord ClientId Source #
Instance details Defined in Raft.Types Methods compare :: ClientId -> ClientId -> Ordering # (<) :: ClientId -> ClientId -> Bool # (<=) :: ClientId -> ClientId -> Bool # (>) :: ClientId -> ClientId -> Bool # (>=) :: ClientId -> ClientId -> Bool # max :: ClientId -> ClientId -> ClientId # min :: ClientId -> ClientId -> ClientId #
Read ClientId Source #
Instance details Defined in Raft.Types Methods readsPrec :: Int -> ReadS ClientId # readList :: ReadS [ClientId] # readPrec :: ReadPrec ClientId # readListPrec :: ReadPrec [ClientId] #
Show ClientId Source #
Instance details Defined in Raft.Types Methods showsPrec :: Int -> ClientId -> ShowS # show :: ClientId -> String # showList :: [ClientId] -> ShowS #
Generic ClientId Source #
Instance details Defined in Raft.Types Associated Types type Rep ClientId :: Type -> Type # Methods from :: ClientId -> Rep ClientId x # to :: Rep ClientId x -> ClientId #
Serialize ClientId Source #
Instance details Defined in Raft.Types Methods put :: Putter ClientId # get :: Get ClientId #
type Rep ClientId Source #
Instance details Defined in Raft.Types type Rep ClientId = D1 (MetaData "ClientId" "Raft.Types" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" True) (C1 (MetaCons "ClientId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 NodeId)))

newtype LeaderId Source #

Unique identifier of a leader

Constructors

LeaderId
Fields unLeaderId :: NodeId

Instances

Eq LeaderId Source #
Instance details Defined in Raft.Types Methods (==) :: LeaderId -> LeaderId -> Bool # (/=) :: LeaderId -> LeaderId -> Bool #
Read LeaderId Source #
Instance details Defined in Raft.Types Methods readsPrec :: Int -> ReadS LeaderId # readList :: ReadS [LeaderId] # readPrec :: ReadPrec LeaderId # readListPrec :: ReadPrec [LeaderId] #
Show LeaderId Source #
Instance details Defined in Raft.Types Methods showsPrec :: Int -> LeaderId -> ShowS # show :: LeaderId -> String # showList :: [LeaderId] -> ShowS #
Generic LeaderId Source #
Instance details Defined in Raft.Types Associated Types type Rep LeaderId :: Type -> Type # Methods from :: LeaderId -> Rep LeaderId x # to :: Rep LeaderId x -> LeaderId #
Serialize LeaderId Source #
Instance details Defined in Raft.Types Methods put :: Putter LeaderId # get :: Get LeaderId #
type Rep LeaderId Source #
Instance details Defined in Raft.Types type Rep LeaderId = D1 (MetaData "LeaderId" "Raft.Types" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" True) (C1 (MetaCons "LeaderId" PrefixI True) (S1 (MetaSel (Just "unLeaderId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 NodeId)))

data CurrentLeader Source #

Representation of the current leader in the cluster. The system is considered to be unavailable if there is no leader

Constructors

CurrentLeader LeaderId
NoLeader

Instances

Eq CurrentLeader Source #
Instance details Defined in Raft.Types Methods (==) :: CurrentLeader -> CurrentLeader -> Bool # (/=) :: CurrentLeader -> CurrentLeader -> Bool #
Show CurrentLeader Source #
Instance details Defined in Raft.Types Methods showsPrec :: Int -> CurrentLeader -> ShowS # show :: CurrentLeader -> String # showList :: [CurrentLeader] -> ShowS #
Generic CurrentLeader Source #
Instance details Defined in Raft.Types Associated Types type Rep CurrentLeader :: Type -> Type # Methods from :: CurrentLeader -> Rep CurrentLeader x # to :: Rep CurrentLeader x -> CurrentLeader #
Serialize CurrentLeader Source #
Instance details Defined in Raft.Types Methods put :: Putter CurrentLeader # get :: Get CurrentLeader #
type Rep CurrentLeader Source #
Instance details Defined in Raft.Types type Rep CurrentLeader = D1 (MetaData "CurrentLeader" "Raft.Types" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" False) (C1 (MetaCons "CurrentLeader" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 LeaderId)) :+: C1 (MetaCons "NoLeader" PrefixI False) (U1 :: Type -> Type))

data Mode Source #

Constructors

Follower
Candidate
Leader

Instances

Read Mode Source #
Instance details Defined in Raft.Types Methods readsPrec :: Int -> ReadS Mode # readList :: ReadS [Mode] # readPrec :: ReadPrec Mode # readListPrec :: ReadPrec [Mode] #
Show Mode Source #
Instance details Defined in Raft.Types Methods showsPrec :: Int -> Mode -> ShowS # show :: Mode -> String # showList :: [Mode] -> ShowS #

newtype Term Source #

Representation of monotonic election terms

Constructors

Term Natural

Instances

Enum Term Source #
Instance details Defined in Raft.Types Methods succ :: Term -> Term # pred :: Term -> Term # toEnum :: Int -> Term # fromEnum :: Term -> Int # enumFrom :: Term -> [Term] # enumFromThen :: Term -> Term -> [Term] # enumFromTo :: Term -> Term -> [Term] # enumFromThenTo :: Term -> Term -> Term -> [Term] #
Eq Term Source #
Instance details Defined in Raft.Types Methods (==) :: Term -> Term -> Bool # (/=) :: Term -> Term -> Bool #
Ord Term Source #
Instance details Defined in Raft.Types Methods compare :: Term -> Term -> Ordering # (<) :: Term -> Term -> Bool # (<=) :: Term -> Term -> Bool # (>) :: Term -> Term -> Bool # (>=) :: Term -> Term -> Bool # max :: Term -> Term -> Term # min :: Term -> Term -> Term #
Show Term Source #
Instance details Defined in Raft.Types Methods showsPrec :: Int -> Term -> ShowS # show :: Term -> String # showList :: [Term] -> ShowS #
Generic Term Source #
Instance details Defined in Raft.Types Associated Types type Rep Term :: Type -> Type # Methods from :: Term -> Rep Term x # to :: Rep Term x -> Term #
Serialize Term Source #
Instance details Defined in Raft.Types Methods put :: Putter Term # get :: Get Term #
FromField Term Source #
Instance details Defined in Raft.Types Methods fromField :: FieldParser Term #
ToField Term Source #
Instance details Defined in Raft.Types Methods toField :: Term -> Action #
type Rep Term Source #
Instance details Defined in Raft.Types type Rep Term = D1 (MetaData "Term" "Raft.Types" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" True) (C1 (MetaCons "Term" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Natural)))

intToNatural :: Int -> Either [Char] Natural Source #

term0 :: Term Source #

Initial term. Terms start at 0

incrTerm :: Term -> Term Source #

prevTerm :: Term -> Term Source #

newtype Index Source #

Representation of monotonic indices

Constructors

Index Natural

Instances

Enum Index Source #
Instance details Defined in Raft.Types Methods succ :: Index -> Index # pred :: Index -> Index # toEnum :: Int -> Index # fromEnum :: Index -> Int # enumFrom :: Index -> [Index] # enumFromThen :: Index -> Index -> [Index] # enumFromTo :: Index -> Index -> [Index] # enumFromThenTo :: Index -> Index -> Index -> [Index] #
Eq Index Source #
Instance details Defined in Raft.Types Methods (==) :: Index -> Index -> Bool # (/=) :: Index -> Index -> Bool #
Integral Index Source #
Instance details Defined in Raft.Types Methods quot :: Index -> Index -> Index # rem :: Index -> Index -> Index # div :: Index -> Index -> Index # mod :: Index -> Index -> Index # quotRem :: Index -> Index -> (Index, Index) # divMod :: Index -> Index -> (Index, Index) # toInteger :: Index -> Integer #
Num Index Source #
Instance details Defined in Raft.Types Methods (+) :: Index -> Index -> Index # (-) :: Index -> Index -> Index # (*) :: Index -> Index -> Index # negate :: Index -> Index # abs :: Index -> Index # signum :: Index -> Index # fromInteger :: Integer -> Index #
Ord Index Source #
Instance details Defined in Raft.Types Methods compare :: Index -> Index -> Ordering # (<) :: Index -> Index -> Bool # (<=) :: Index -> Index -> Bool # (>) :: Index -> Index -> Bool # (>=) :: Index -> Index -> Bool # max :: Index -> Index -> Index # min :: Index -> Index -> Index #
Read Index Source #
Instance details Defined in Raft.Types Methods readsPrec :: Int -> ReadS Index # readList :: ReadS [Index] # readPrec :: ReadPrec Index # readListPrec :: ReadPrec [Index] #
Real Index Source #
Instance details Defined in Raft.Types Methods toRational :: Index -> Rational #
Show Index Source #
Instance details Defined in Raft.Types Methods showsPrec :: Int -> Index -> ShowS # show :: Index -> String # showList :: [Index] -> ShowS #
Generic Index Source #
Instance details Defined in Raft.Types Associated Types type Rep Index :: Type -> Type # Methods from :: Index -> Rep Index x # to :: Rep Index x -> Index #
Serialize Index Source #
Instance details Defined in Raft.Types Methods put :: Putter Index # get :: Get Index #
FromField Index Source #
Instance details Defined in Raft.Types Methods fromField :: FieldParser Index #
ToField Index Source #
Instance details Defined in Raft.Types Methods toField :: Index -> Action #
type Rep Index Source #
Instance details Defined in Raft.Types type Rep Index = D1 (MetaData "Index" "Raft.Types" "libraft-0.5.0.0-J9sQlo4v2xjSwCkwompQR" True) (C1 (MetaCons "Index" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Natural)))

index0 :: Index Source #

Initial index. Indeces start at 0

incrIndex :: Index -> Index Source #

decrIndexWithDefault0 :: Index -> Index Source #

Decrement index. If the given index is 0, return the given index

newtype SerialNum Source #

Constructors

SerialNum Natural

Instances

Enum SerialNum Source #
Instance details 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 Source #
Instance details Defined in Raft.Types Methods (==) :: SerialNum -> SerialNum -> Bool # (/=) :: SerialNum -> SerialNum -> Bool #
Num SerialNum Source #
Instance details 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 Source #
Instance details 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 Source #
Instance details Defined in Raft.Types Methods readsPrec :: Int -> ReadS SerialNum # readList :: ReadS [SerialNum] # readPrec :: ReadPrec SerialNum # readListPrec :: ReadPrec [SerialNum] #
Show SerialNum Source #
Instance details Defined in Raft.Types Methods showsPrec :: Int -> SerialNum -> ShowS # show :: SerialNum -> String # showList :: [SerialNum] -> ShowS #
Generic SerialNum Source #
Instance details Defined in Raft.Types Associated Types type Rep SerialNum :: Type -> Type # Methods from :: SerialNum -> Rep SerialNum x # to :: Rep SerialNum x -> SerialNum #
Serialize SerialNum Source #
Instance details Defined in Raft.Types Methods put :: Putter SerialNum # get :: Get SerialNum #
type Rep SerialNum Source #
Instance details 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)))