GenMagic.Pool behaviour (GenMagic v1.1.1) View Source

The GenMagic.Pool behaviour defines functions that must be implemented by each pool module which is added under the GenMagic.Pool namespace.

Link to this section Summary

Types

name()

The name of the pool, which is usually a pid or an atom for named pools

perform_option()

startup_option()

The options that must be accepted by the pool

Callbacks

perform(name, arg2, list)

start_link(list)

Link to this section Types

name()

Specs

name() :: term()

The name of the pool, which is usually a pid or an atom for named pools

perform_option()

Specs

perform_option() :: {:timeout, timeout()}

startup_option()

Specs

startup_option() ::
  {:pool_name, atom()}
  | {:pool_size, non_neg_integer()}
  | {:startup_timeout, timeout()}
  | {:process_timeout, timeout()}
  | {:recycle_threshold, non_neg_integer() | :infinity}
  | {:database_patterns, [:default | Path.t(), ...]}

The options that must be accepted by the pool

Link to this section Callbacks

perform(name, arg2, list)

Specs

perform(name(), Path.t(), [perform_option()]) ::
  {:ok, GenMagic.Result.t()} | {:error, term()}

start_link(list)

Specs

start_link([startup_option()]) :: {:ok, pid()} | {:error, term()}