rafted_value v0.11.1 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()
View Source
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()
}
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(e, arg1, voter)
View Source
gain_vote(RaftedValue.Election.t(), RaftedValue.Members.t(), pid()) ::
{t(), boolean()}
gain_vote(RaftedValue.Election.t(), RaftedValue.Members.t(), pid()) :: {t(), boolean()}
leader_message_at(election)
View Source
leader_message_at(t()) :: Croma.TypeGen.Nilable.RaftedValue.Monotonic.t()
leader_message_at(t()) :: Croma.TypeGen.Nilable.RaftedValue.Monotonic.t()
Type-aware getter for leader_message_at.
leader_message_at(s, field) View Source
Type-aware setter for leader_message_at.
minimum_timeout_elapsed_since_last_leader_message?(arg0, arg1)
View Source
minimum_timeout_elapsed_since_last_leader_message?(
RaftedValue.Election.t(),
RaftedValue.Config.t()
) :: boolean()
minimum_timeout_elapsed_since_last_leader_message?( RaftedValue.Election.t(), RaftedValue.Config.t() ) :: boolean()
new(dict)
View Source
new(term()) :: Croma.Result.t(t())
new(term()) :: Croma.Result.t(t())
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.
new!(dict) View Source
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(config)
View Source
new_for_follower(RaftedValue.Config.t()) :: t()
new_for_follower(RaftedValue.Config.t()) :: t()
new_for_leader()
View Source
new_for_leader() :: t()
new_for_leader() :: t()
reset_timer(e, config)
View Source
reset_timer(RaftedValue.Election.t(), RaftedValue.Config.t()) :: t()
reset_timer(RaftedValue.Election.t(), RaftedValue.Config.t()) :: t()
timer(election)
View Source
timer(t()) :: Croma.TypeGen.Nilable.Croma.Reference.t()
timer(t()) :: Croma.TypeGen.Nilable.Croma.Reference.t()
Type-aware getter for timer.
timer(s, field)
View Source
timer(t(), Croma.TypeGen.Nilable.Croma.Reference.t()) :: t()
timer(t(), Croma.TypeGen.Nilable.Croma.Reference.t()) :: t()
Type-aware setter for timer.
update(s, dict)
View Source
update(t(), Dict.t()) :: Croma.Result.t(t())
update(t(), Dict.t()) :: Croma.Result.t(t())
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}
.
update!(s, dict) View Source
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(e, config)
View Source
update_for_candidate(RaftedValue.Election.t(), RaftedValue.Config.t()) :: t()
update_for_candidate(RaftedValue.Election.t(), RaftedValue.Config.t()) :: t()
update_for_follower(e, config)
View Source
update_for_follower(RaftedValue.Election.t(), RaftedValue.Config.t()) :: t()
update_for_follower(RaftedValue.Election.t(), RaftedValue.Config.t()) :: t()
valid?(value) View Source
Checks if the given value belongs to t/0
or not.
vote_for(e, candidate, config)
View Source
vote_for(RaftedValue.Election.t(), pid(), RaftedValue.Config.t()) :: t()
vote_for(RaftedValue.Election.t(), pid(), RaftedValue.Config.t()) :: t()
voted_for(election)
View Source
voted_for(t()) :: Croma.TypeGen.Nilable.Croma.Pid.t()
voted_for(t()) :: Croma.TypeGen.Nilable.Croma.Pid.t()
Type-aware getter for voted_for.
voted_for(s, field)
View Source
voted_for(t(), Croma.TypeGen.Nilable.Croma.Pid.t()) :: t()
voted_for(t(), Croma.TypeGen.Nilable.Croma.Pid.t()) :: t()
Type-aware setter for voted_for.
votes(election)
View Source
votes(t()) :: Croma.TypeGen.Nilable.RaftedValue.PidSet.t()
votes(t()) :: Croma.TypeGen.Nilable.RaftedValue.PidSet.t()
Type-aware getter for votes.
votes(s, field) View Source
Type-aware setter for votes.