RaftFleet.Manager.State (raft_fleet v0.10.2) View Source
Link to this section Summary
Functions
Type-aware getter for activate_worker.
Type-aware setter for activate_worker.
Type-aware getter for adjust_timer.
Type-aware setter for adjust_timer.
Type-aware getter for adjust_worker.
Type-aware setter for adjust_worker.
Type-aware getter for being_added_consensus_groups.
Type-aware setter for being_added_consensus_groups.
Type-aware getter for deactivate_worker.
Type-aware setter for deactivate_worker.
Creates a new instance of RaftFleet.Manager.State by using the given dict.
A variant of new/1 which returns t or raise if validation fails.
Updates an existing instance of RaftFleet.Manager.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}.
A variant of update/2 which returns t or raise if validation fails.
In other words, update/2 followed by Croma.Result.get!/1.
Checks if the given value belongs to t/0 or not.
Link to this section Types
Specs
consensus_group_progress() ::
:leader_started
| {:leader_delegated_to, node()}
| :process_exists
| GenServer.from()
Specs
t() :: %RaftFleet.Manager.State{
activate_worker: Croma.TypeGen.Nilable.Croma.Pid.t(),
adjust_timer: Croma.TypeGen.Nilable.Croma.Reference.t(),
adjust_worker: Croma.TypeGen.Nilable.Croma.Pid.t(),
being_added_consensus_groups: Croma.Map.t(),
deactivate_worker: Croma.TypeGen.Nilable.Croma.Pid.t()
}
Link to this section Functions
Specs
activate_worker(t()) :: Croma.TypeGen.Nilable.Croma.Pid.t()
Type-aware getter for activate_worker.
Specs
Type-aware setter for activate_worker.
Specs
adjust_timer(t()) :: Croma.TypeGen.Nilable.Croma.Reference.t()
Type-aware getter for adjust_timer.
Specs
Type-aware setter for adjust_timer.
Specs
adjust_worker(t()) :: Croma.TypeGen.Nilable.Croma.Pid.t()
Type-aware getter for adjust_worker.
Specs
Type-aware setter for adjust_worker.
Specs
being_added_consensus_groups(t()) :: Croma.Map.t()
Type-aware getter for being_added_consensus_groups.
Specs
being_added_consensus_groups(t(), Croma.Map.t()) :: t()
Type-aware setter for being_added_consensus_groups.
Specs
deactivate_worker(t()) :: Croma.TypeGen.Nilable.Croma.Pid.t()
Type-aware getter for deactivate_worker.
Specs
Type-aware setter for deactivate_worker.
Specs
new(term()) :: Croma.Result.t(t())
Creates a new instance of RaftFleet.Manager.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).
See also moduledoc of Croma.Struct.
Specs
A variant of new/1 which returns t or raise if validation fails.
In other words, new/1 followed by Croma.Result.get!/1.
Specs
update(t(), Dict.t()) :: Croma.Result.t(t())
Updates an existing instance of RaftFleet.Manager.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}.
Specs
A variant of update/2 which returns t or raise if validation fails.
In other words, update/2 followed by Croma.Result.get!/1.
Specs
update_being_added_consensus_groups(t(), atom(), consensus_group_progress()) :: t()
Specs
Checks if the given value belongs to t/0 or not.