rafted_value v0.8.0 RaftedValue.Election View Source
Link to this section Summary
Functions
Type-aware getter for leader_message_at
Type-aware setter for leader_message_at
Creates a new instance of RaftedValue.Election by using the given dict
A variant of new/1
which returns t
or raise if validation fails
Type-aware getter for timer
Type-aware setter for timer
Updates an existing instance of RaftedValue.Election 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
Type-aware getter for voted_for
Type-aware setter for voted_for
Type-aware getter for votes
Type-aware setter for votes
Link to this section Types
t() :: %RaftedValue.Election{ leader_message_at: Croma.TypeGen.Nilable.RaftedValue.Monotonic.t(), timer: Croma.TypeGen.Nilable.Croma.Reference.t(), voted_for: Croma.TypeGen.Nilable.Croma.Pid.t(), votes: Croma.TypeGen.Nilable.RaftedValue.PidSet.t() }
Link to this section Functions
gain_vote(RaftedValue.Election.t(), RaftedValue.Members.t(), pid()) :: {t(), boolean()}
leader_message_at(t()) :: Croma.TypeGen.Nilable.RaftedValue.Monotonic.t()
Type-aware getter for leader_message_at.
Type-aware setter for leader_message_at.
minimum_timeout_elapsed_since_last_leader_message?( RaftedValue.Election.t(), RaftedValue.Config.t() ) :: boolean()
Creates a new instance of RaftedValue.Election 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
.
new_for_follower(RaftedValue.Config.t()) :: t()
reset_timer(RaftedValue.Election.t(), RaftedValue.Config.t()) :: t()
timer(t()) :: Croma.TypeGen.Nilable.Croma.Reference.t()
Type-aware getter for timer.
timer(t(), Croma.TypeGen.Nilable.Croma.Reference.t()) :: t()
Type-aware setter for timer.
Updates an existing instance of RaftedValue.Election 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_for_candidate(RaftedValue.Election.t(), RaftedValue.Config.t()) :: t()
update_for_follower(RaftedValue.Election.t(), RaftedValue.Config.t()) :: t()
Checks if the given value belongs to t/0
or not.
vote_for(RaftedValue.Election.t(), pid(), RaftedValue.Config.t()) :: t()
voted_for(t()) :: Croma.TypeGen.Nilable.Croma.Pid.t()
Type-aware getter for voted_for.
voted_for(t(), Croma.TypeGen.Nilable.Croma.Pid.t()) :: t()
Type-aware setter for voted_for.
votes(t()) :: Croma.TypeGen.Nilable.RaftedValue.PidSet.t()
Type-aware getter for votes.
Type-aware setter for votes.