View Source AntikytheraCore.ExecutorPool.Setting (antikythera v0.5.1)

Summary

Functions

Type-aware getter for n_pools_a.

Type-aware setter for n_pools_a.

Creates a new instance of AntikytheraCore.ExecutorPool.Setting by using the given dict.

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

Type-aware getter for pool_size_a.

Type-aware setter for pool_size_a.

Type-aware getter for pool_size_j.

Type-aware setter for pool_size_j.

Updates an existing instance of AntikytheraCore.ExecutorPool.Setting 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 ws_max_connections.

Type-aware setter for ws_max_connections.

Types

@type t() :: %AntikytheraCore.ExecutorPool.Setting{
  n_pools_a: Croma.NonNegInteger.t(),
  pool_size_a: Croma.NonNegInteger.t(),
  pool_size_j: Croma.NonNegInteger.t(),
  ws_max_connections: Croma.NonNegInteger.t()
}

Functions

@spec all() :: %{required(Antikythera.GearName.t()) => t()}
@spec default() :: t()
@spec n_pools_a(t()) :: Croma.NonNegInteger.t()

Type-aware getter for n_pools_a.

@spec n_pools_a(t(), Croma.NonNegInteger.t()) :: t()

Type-aware setter for n_pools_a.

@spec new(term()) :: Croma.Result.t(t())

Creates a new instance of AntikytheraCore.ExecutorPool.Setting by using the given dict.

Returns {:ok, valid_struct} or {:error, reason}.

The values in the dict are validated by each field's valid?/1 function. If the value was invalid, it will be passed to new/1 of the field

For missing fields, followings will be tried:

  • default/0 of each field type
  • new/1 of each field type, with empty map as input
@spec new!(term()) :: t()

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

In other words, new/1 followed by Croma.Result.get!/1.

@spec of_gear(Antikythera.GearName.t()) :: t()
@spec pool_size_a(t()) :: Croma.NonNegInteger.t()

Type-aware getter for pool_size_a.

@spec pool_size_a(t(), Croma.NonNegInteger.t()) :: t()

Type-aware setter for pool_size_a.

@spec pool_size_j(t()) :: Croma.NonNegInteger.t()

Type-aware getter for pool_size_j.

@spec pool_size_j(t(), Croma.NonNegInteger.t()) :: t()

Type-aware setter for pool_size_j.

@spec update(t(), Dict.t()) :: Croma.Result.t(t())

Updates an existing instance of AntikytheraCore.ExecutorPool.Setting 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}.

@spec 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.

@spec valid?(term()) :: boolean()

Checks if the given value belongs to t/0 or not.

Link to this function

ws_max_connections(setting)

View Source
@spec ws_max_connections(t()) :: Croma.NonNegInteger.t()

Type-aware getter for ws_max_connections.

Link to this function

ws_max_connections(s, field)

View Source
@spec ws_max_connections(t(), Croma.NonNegInteger.t()) :: t()

Type-aware setter for ws_max_connections.