rafted_value v0.11.1 RaftedValue.RPC.AppendEntriesRequest View Source
Link to this section Summary
Functions
Type-aware getter for entries.
Type-aware setter for entries.
Type-aware getter for i_leader_commit.
Type-aware setter for i_leader_commit.
Type-aware getter for leader_pid.
Type-aware setter for leader_pid.
Type-aware getter for leader_timestamp.
Type-aware setter for leader_timestamp.
Creates a new instance of RaftedValue.RPC.AppendEntriesRequest by using the given dict
.
A variant of new/1
which returns t
or raise if validation fails.
Type-aware getter for prev_log.
Type-aware setter for prev_log.
Type-aware getter for term.
Type-aware setter for term.
Updates an existing instance of RaftedValue.RPC.AppendEntriesRequest 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()
View Source
t() :: %RaftedValue.RPC.AppendEntriesRequest{
entries: Croma.TypeGen.ListOf.RaftedValue.LogEntry.t(),
i_leader_commit: RaftedValue.LogIndex.t(),
leader_pid: Croma.Pid.t(),
leader_timestamp: RaftedValue.Monotonic.t(),
prev_log: RaftedValue.LogInfo.t(),
term: RaftedValue.TermNumber.t()
}
t() :: %RaftedValue.RPC.AppendEntriesRequest{ entries: Croma.TypeGen.ListOf.RaftedValue.LogEntry.t(), i_leader_commit: RaftedValue.LogIndex.t(), leader_pid: Croma.Pid.t(), leader_timestamp: RaftedValue.Monotonic.t(), prev_log: RaftedValue.LogInfo.t(), term: RaftedValue.TermNumber.t() }
Link to this section Functions
entries(append_entries_request)
View Source
entries(t()) :: Croma.TypeGen.ListOf.RaftedValue.LogEntry.t()
entries(t()) :: Croma.TypeGen.ListOf.RaftedValue.LogEntry.t()
Type-aware getter for entries.
entries(s, field) View Source
Type-aware setter for entries.
i_leader_commit(append_entries_request)
View Source
i_leader_commit(t()) :: RaftedValue.LogIndex.t()
i_leader_commit(t()) :: RaftedValue.LogIndex.t()
Type-aware getter for i_leader_commit.
i_leader_commit(s, field)
View Source
i_leader_commit(t(), RaftedValue.LogIndex.t()) :: t()
i_leader_commit(t(), RaftedValue.LogIndex.t()) :: t()
Type-aware setter for i_leader_commit.
leader_pid(append_entries_request)
View Source
leader_pid(t()) :: Croma.Pid.t()
leader_pid(t()) :: Croma.Pid.t()
Type-aware getter for leader_pid.
leader_pid(s, field)
View Source
leader_pid(t(), Croma.Pid.t()) :: t()
leader_pid(t(), Croma.Pid.t()) :: t()
Type-aware setter for leader_pid.
leader_timestamp(append_entries_request)
View Source
leader_timestamp(t()) :: RaftedValue.Monotonic.t()
leader_timestamp(t()) :: RaftedValue.Monotonic.t()
Type-aware getter for leader_timestamp.
leader_timestamp(s, field)
View Source
leader_timestamp(t(), RaftedValue.Monotonic.t()) :: t()
leader_timestamp(t(), RaftedValue.Monotonic.t()) :: t()
Type-aware setter for leader_timestamp.
new(dict)
View Source
new(term()) :: Croma.Result.t(t())
new(term()) :: Croma.Result.t(t())
Creates a new instance of RaftedValue.RPC.AppendEntriesRequest 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
.
prev_log(append_entries_request)
View Source
prev_log(t()) :: RaftedValue.LogInfo.t()
prev_log(t()) :: RaftedValue.LogInfo.t()
Type-aware getter for prev_log.
prev_log(s, field)
View Source
prev_log(t(), RaftedValue.LogInfo.t()) :: t()
prev_log(t(), RaftedValue.LogInfo.t()) :: t()
Type-aware setter for prev_log.
term(append_entries_request)
View Source
term(t()) :: RaftedValue.TermNumber.t()
term(t()) :: RaftedValue.TermNumber.t()
Type-aware getter for term.
term(s, field)
View Source
term(t(), RaftedValue.TermNumber.t()) :: t()
term(t(), RaftedValue.TermNumber.t()) :: t()
Type-aware setter for term.
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.RPC.AppendEntriesRequest 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
.
valid?(value) View Source
Checks if the given value belongs to t/0
or not.