batched_communication v0.1.5 BatchedCommunication.Sender.State View Source

Link to this section Summary

Functions

Type-aware getter for buffers

Type-aware setter for buffers

Type-aware getter for compression

Type-aware setter for compression

Type-aware getter for max_messages_per_batch

Type-aware setter for max_messages_per_batch

Type-aware getter for max_wait_time

Type-aware setter for max_wait_time

Creates a new instance of BatchedCommunication.Sender.State by using the given dict

A variant of new/1 which returns t or raise if validation fails

Type-aware getter for receiver_name

Type-aware setter for receiver_name

Type-aware getter for stats

Type-aware setter for stats

Updates an existing instance of BatchedCommunication.Sender.State 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

Link to this type t() View Source
t() :: %BatchedCommunication.Sender.State{
  buffers: Croma.Map.t(),
  compression: BatchedCommunication.Compression.t(),
  max_messages_per_batch: Croma.PosInteger.t(),
  max_wait_time: Croma.PosInteger.t(),
  receiver_name: Croma.Atom.t(),
  stats: Croma.Map.t()
}

Link to this section Functions

Link to this function buffers(state) View Source
buffers(t()) :: Croma.Map.t()

Type-aware getter for buffers.

Link to this function buffers(s, field) View Source
buffers(t(), Croma.Map.t()) :: t()

Type-aware setter for buffers.

Type-aware getter for compression.

Type-aware setter for compression.

Link to this function max_messages_per_batch(state) View Source
max_messages_per_batch(t()) :: Croma.PosInteger.t()

Type-aware getter for max_messages_per_batch.

Link to this function max_messages_per_batch(s, field) View Source
max_messages_per_batch(t(), Croma.PosInteger.t()) :: t()

Type-aware setter for max_messages_per_batch.

Link to this function max_wait_time(state) View Source
max_wait_time(t()) :: Croma.PosInteger.t()

Type-aware getter for max_wait_time.

Link to this function max_wait_time(s, field) View Source
max_wait_time(t(), Croma.PosInteger.t()) :: t()

Type-aware setter for max_wait_time.

Creates a new instance of BatchedCommunication.Sender.State 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.

Link to this function receiver_name(state) View Source
receiver_name(t()) :: Croma.Atom.t()

Type-aware getter for receiver_name.

Link to this function receiver_name(s, field) View Source
receiver_name(t(), Croma.Atom.t()) :: t()

Type-aware setter for receiver_name.

Type-aware getter for stats.

Link to this function stats(s, field) View Source
stats(t(), Croma.Map.t()) :: t()

Type-aware setter for stats.

Updates an existing instance of BatchedCommunication.Sender.State 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}.

Link to this function update!(s, dict) View Source
update!(t(), Dict.t()) :: t()

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.