rafted_value v0.3.0 RaftedValue.Config View Source
Link to this section Summary
Functions
Type-aware getter for communication_module
Type-aware setter for communication_module
Type-aware getter for data_module
Type-aware setter for data_module
Type-aware getter for election_timeout
Type-aware setter for election_timeout
Type-aware getter for election_timeout_clock_drift_margin
Type-aware setter for election_timeout_clock_drift_margin
Type-aware getter for heartbeat_timeout
Type-aware setter for heartbeat_timeout
Type-aware getter for leader_hook_module
Type-aware setter for leader_hook_module
Type-aware getter for max_retained_command_results
Type-aware setter for max_retained_command_results
Creates a new instance of RaftedValue.Config by using the given dict
A variant of new/1
which returns t
or raise if validation fails
Updates an existing instance of RaftedValue.Config with the given dict
.
The values in the dict
are validated by each field’s validate/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 that the given dict
is valid or not by using each field’s validate/1
function.
Returns {:ok, valid_struct}
or {:error, reason}
A variant of validate/1
which returns t
or raise if validation fails.
In other words, validate/1
followed by Croma.Result.get!/1
Link to this section Types
t() :: %RaftedValue.Config{communication_module: Croma.Atom.t, data_module: Croma.Atom.t, election_timeout: Croma.PosInteger.t, election_timeout_clock_drift_margin: Croma.PosInteger.t, heartbeat_timeout: Croma.PosInteger.t, leader_hook_module: Croma.Atom.t, max_retained_command_results: Croma.PosInteger.t}
Link to this section Functions
communication_module(t) :: Croma.Atom.t
Type-aware getter for communication_module.
communication_module(t, Croma.Atom.t) :: t
Type-aware setter for communication_module.
Type-aware getter for data_module.
Type-aware setter for data_module.
election_timeout(t) :: Croma.PosInteger.t
Type-aware getter for election_timeout.
election_timeout(t, Croma.PosInteger.t) :: t
Type-aware setter for election_timeout.
election_timeout_clock_drift_margin(t) :: Croma.PosInteger.t
Type-aware getter for election_timeout_clock_drift_margin.
election_timeout_clock_drift_margin(t, Croma.PosInteger.t) :: t
Type-aware setter for election_timeout_clock_drift_margin.
heartbeat_timeout(t) :: Croma.PosInteger.t
Type-aware getter for heartbeat_timeout.
heartbeat_timeout(t, Croma.PosInteger.t) :: t
Type-aware setter for heartbeat_timeout.
Type-aware getter for leader_hook_module.
leader_hook_module(t, Croma.Atom.t) :: t
Type-aware setter for leader_hook_module.
max_retained_command_results(t) :: Croma.PosInteger.t
Type-aware getter for max_retained_command_results.
max_retained_command_results(t, Croma.PosInteger.t) :: t
Type-aware setter for max_retained_command_results.
Creates a new instance of RaftedValue.Config 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 validate/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 RaftedValue.Config with the given dict
.
The values in the dict
are validated by each field’s validate/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 that the given dict
is valid or not by using each field’s validate/1
function.
Returns {:ok, valid_struct}
or {:error, reason}
.
A variant of validate/1
which returns t
or raise if validation fails.
In other words, validate/1
followed by Croma.Result.get!/1
.