Raft.Config

Documentation

data RaftNodeConfig

Configuration of a node in the cluster

Constructors

RaftNodeConfig

Fields

• raftConfigNodeId :: NodeId

  Node id of the running node

• raftConfigNodeIds :: NodeIds

  Set of all other node ids in the cluster

• raftConfigElectionTimeout :: (Natural, Natural)

  Range of times an election timeout can take

• raftConfigHeartbeatTimeout :: Natural

  Heartbeat timeout timer

• raftConfigStorageState :: StorageState

  Create a fresh DB or read from existing

Instances

Show RaftNodeConfig

Defined in Raft.Config

Methods

showsPrec :: Int -> RaftNodeConfig -> ShowS

show :: RaftNodeConfig -> String

showList :: [RaftNodeConfig] -> ShowS

data StorageState

Constructors

New

Existing

Instances

Show StorageState

Defined in Raft.Config

Methods

showsPrec :: Int -> StorageState -> ShowS

show :: StorageState -> String

showList :: [StorageState] -> ShowS

data OptionalRaftNodeConfig

Constructors

OptionalRaftNodeConfig

Fields

• raftConfigMetricsPort :: Maybe PortNumber
• raftConfigTimerSeed :: Maybe Int

Instances

Show OptionalRaftNodeConfig

Defined in Raft.Config

Methods

showsPrec :: Int -> OptionalRaftNodeConfig -> ShowS

show :: OptionalRaftNodeConfig -> String

showList :: [OptionalRaftNodeConfig] -> ShowS

defaultOptionalRaftNodeConfig :: OptionalRaftNodeConfig

data ConfigError

Constructors

InvalidMetricsPort

NoFreePortAvailable

Instances

Show ConfigError

Defined in Raft.Config

Methods

showsPrec :: Int -> ConfigError -> ShowS

show :: ConfigError -> String

showList :: [ConfigError] -> ShowS

resolveMetricsPort :: Maybe PortNumber -> IO (Maybe PortNumber)

resolveMetricsPortE :: PortNumber -> IO (Either ConfigError PortNumber)

If the user specifies a port to fork the EKG server on, make sure the port is open and return the valid port number. If the user does not specify a port to run the monitoring server on, return Nothing.

resolveTimerSeed :: Maybe Int -> IO Int