rafted_value v0.7.0 RaftedValue.Leadership View Source
Link to this section Summary
Functions
Type-aware getter for follower_responded_times
Type-aware setter for follower_responded_times
Type-aware getter for heartbeat_timer
Type-aware setter for heartbeat_timer
Creates a new instance of RaftedValue.Leadership by using the given dict
A variant of new/1
which returns t
or raise if validation fails
Type-aware getter for quorum_timer
Type-aware setter for quorum_timer
Type-aware getter for quorum_timer_started_at
Type-aware setter for quorum_timer_started_at
Updates an existing instance of RaftedValue.Leadership 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
t() :: %RaftedValue.Leadership{follower_responded_times: Croma.Map.t(), heartbeat_timer: Croma.Reference.t(), quorum_timer: Croma.Reference.t(), quorum_timer_started_at: RaftedValue.Monotonic.t()}
Link to this section Functions
can_safely_remove?(RaftedValue.Leadership.t(), RaftedValue.Members.t(), pid(), RaftedValue.Config.t()) :: boolean()
follower_responded(RaftedValue.Leadership.t(), RaftedValue.Members.t(), pid(), RaftedValue.Monotonic.t(), RaftedValue.Config.t()) :: t()
follower_responded_times(t()) :: Croma.Map.t()
Type-aware getter for follower_responded_times.
follower_responded_times(t(), Croma.Map.t()) :: t()
Type-aware setter for follower_responded_times.
heartbeat_timer(t()) :: Croma.Reference.t()
Type-aware getter for heartbeat_timer.
heartbeat_timer(t(), Croma.Reference.t()) :: t()
Type-aware setter for heartbeat_timer.
lease_expired?(RaftedValue.Leadership.t(), RaftedValue.Members.t(), RaftedValue.Config.t()) :: boolean()
Creates a new instance of RaftedValue.Leadership 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_leader(RaftedValue.Config.t()) :: t()
Type-aware getter for quorum_timer.
quorum_timer(t(), Croma.Reference.t()) :: t()
Type-aware setter for quorum_timer.
quorum_timer_started_at(t()) :: RaftedValue.Monotonic.t()
Type-aware getter for quorum_timer_started_at.
quorum_timer_started_at(t(), RaftedValue.Monotonic.t()) :: t()
Type-aware setter for quorum_timer_started_at.
remove_follower_response_time_entry(RaftedValue.Leadership.t(), pid()) :: t()
reset_heartbeat_timer(RaftedValue.Leadership.t(), RaftedValue.Config.t()) :: t()
reset_quorum_timer(RaftedValue.Leadership.t(), RaftedValue.Config.t()) :: t()
unresponsive_followers(RaftedValue.Leadership.t(), RaftedValue.Members.t(), RaftedValue.Config.t()) :: [pid()]
Updates an existing instance of RaftedValue.Leadership 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.