RaftFleet.Cluster.State (raft_fleet v0.11.0)

Updates an existing instance of RaftFleet.Cluster.State with the given dict. The values in the dict are validated by each field's valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}.

update!(s, dict)

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

update_removed_groups(state0, node, index_or_nil, now, wait_time)

valid?(value)

Checks if the given value belongs to t/0 or not.

Types

t()

@type t() :: %RaftFleet.Cluster.State{
  consensus_groups: RaftFleet.ConsensusGroups.t(),
  members_per_leader_node: RaftFleet.MembersPerLeaderNode.t(),
  nodes_per_zone: RaftFleet.NodesPerZone.t(),
  recently_removed_groups: RaftFleet.RecentlyRemovedGroups.t()
}

Functions

add_group(state0, group, n_replica)

add_node(state0, n, z)

consensus_groups(state)

@spec consensus_groups(t()) :: RaftFleet.ConsensusGroups.t()

Type-aware getter for consensus_groups.

consensus_groups(s, field)

@spec consensus_groups(t(), RaftFleet.ConsensusGroups.t()) :: t()

Type-aware setter for consensus_groups.

members_per_leader_node(state)

@spec members_per_leader_node(t()) :: RaftFleet.MembersPerLeaderNode.t()

Type-aware getter for members_per_leader_node.

members_per_leader_node(s, field)

@spec members_per_leader_node(t(), RaftFleet.MembersPerLeaderNode.t()) :: t()

Type-aware setter for members_per_leader_node.

new(dict)

@spec new(term()) :: Croma.Result.t(t())

Creates a new instance of RaftFleet.Cluster.State by using the given dict.

Values associated with the struct field names are fetched from the given dict and then validated/converted with valid?/1/new/1. For missing fields default values (if any) are used.

Returns {:ok, valid_struct} when all fields are filled with valid values. Returns {:error, reason} if any error occurs (invalid value or no value is available).

new!(dict)

@spec new!(term()) :: t()

A variant of new/1 which returns t or raise if validation fails.

In other words, new/1 followed by Croma.Result.get!/1.

nodes_per_zone(state)

@spec nodes_per_zone(t()) :: RaftFleet.NodesPerZone.t()

Type-aware getter for nodes_per_zone.

nodes_per_zone(s, field)

@spec nodes_per_zone(t(), RaftFleet.NodesPerZone.t()) :: t()

Type-aware setter for nodes_per_zone.

recently_removed_groups(state)

@spec recently_removed_groups(t()) :: RaftFleet.RecentlyRemovedGroups.t()

Type-aware getter for recently_removed_groups.

recently_removed_groups(s, field)

@spec recently_removed_groups(t(), RaftFleet.RecentlyRemovedGroups.t()) :: t()

Type-aware setter for recently_removed_groups.

remove_group(state0, group)

remove_node(state0, n)

update(s, dict)

@spec update(t(), Dict.t()) :: Croma.Result.t(t())

update!(s, dict)

@spec update!(t(), Dict.t()) :: t()

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

update_removed_groups(state0, node, index_or_nil, now, wait_time)

valid?(value)

@spec valid?(term()) :: boolean()

Checks if the given value belongs to t/0 or not.