raft_fleet v0.5.1 RaftFleet.Manager.State 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
consensus_group_progress() :: :leader_started | {:leader_delegated_to, node()} | :process_exists | GenServer.from()
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
activate_worker(t()) :: Croma.TypeGen.Nilable.Croma.Pid.t()
Type-aware getter for activate_worker.
activate_worker(t(), Croma.TypeGen.Nilable.Croma.Pid.t()) :: t()
Type-aware setter for activate_worker.
adjust_timer(t()) :: Croma.TypeGen.Nilable.Croma.Reference.t()
Type-aware getter for adjust_timer.
adjust_timer(t(), Croma.TypeGen.Nilable.Croma.Reference.t()) :: t()
Type-aware setter for adjust_timer.
adjust_worker(t()) :: Croma.TypeGen.Nilable.Croma.Pid.t()
Type-aware getter for adjust_worker.
adjust_worker(t(), Croma.TypeGen.Nilable.Croma.Pid.t()) :: t()
Type-aware setter for adjust_worker.
being_added_consensus_groups(t()) :: Croma.Map.t()
Type-aware getter for being_added_consensus_groups.
being_added_consensus_groups(t(), Croma.Map.t()) :: t()
Type-aware setter for being_added_consensus_groups.
deactivate_worker(t()) :: Croma.TypeGen.Nilable.Croma.Pid.t()
Type-aware getter for deactivate_worker.
deactivate_worker(t(), Croma.TypeGen.Nilable.Croma.Pid.t()) :: t()
Type-aware setter for deactivate_worker.
Creates a new instance of RaftFleet.Manager.State by using the given dict
.
For missing fields, default/0
of each field type will be used.
Returns {:ok, valid_struct}
or {:error, reason}
.
The values in the dict
are validated by each field’s valid?/1
function.
A variant of new/1
which returns t
or raise if validation fails.
In other words, new/1
followed by Croma.Result.get!/1
.
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
.
update_being_added_consensus_groups(RaftFleet.Manager.State.t(), atom(), consensus_group_progress()) :: t()
Checks if the given value belongs to t/0
or not.