Spec-Zone.ru › Elixir 1.9

DynamicSupervisor поведение

Наблюдатель, который запускает детей динамически.

Модуль Supervisor был разработан для обработки в основном статических детей, которые запускаются в заданном порядке при запуске наблюдателя. DynamicSupervisor запускается без детей. Вместо этого дети запускаются по требованию с помощью start_child/2. Когда динамический наблюдатель завершается, все дети завершаются одновременно, без гарантии порядка.

Примеры

Динамический наблюдатель запускается без детей, часто под наблюдателем со стратегией наблюдения (единственная поддерживаемая в настоящее время стратегия — :one_for_one) и именем:

children = [
  {DynamicSupervisor, strategy: :one_for_one, name: MyApp.DynamicSupervisor}
]

Supervisor.start_link(children, strategy: :one_for_one)

Опции, заданные в спецификации ребенка, описаны в start_link/1.

После запуска динамического наблюдателя мы можем запустить детей с помощью start_child/2, который получает спецификацию ребенка:

{:ok, agent1} = DynamicSupervisor.start_child(MyApp.DynamicSupervisor, {Agent, fn -> %{} end})
Agent.update(agent1, &Map.put(&1, :key, "value"))
Agent.get(agent1, & &1)
#=> %{key: "value"}

{:ok, agent2} = DynamicSupervisor.start_child(MyApp.DynamicSupervisor, {Agent, fn -> %{} end})
Agent.get(agent2, & &1)
#=> %{}

DynamicSupervisor.count_children(MyApp.DynamicSupervisor)
#=> %{active: 2, specs: 2, supervisors: 0, workers: 2}

Модульные наблюдатели

Подобно Supervisor, динамические наблюдатели также поддерживают модульные наблюдатели.

defmodule MyApp.DynamicSupervisor do
  # Automatically defines child_spec/1
  use DynamicSupervisor

  def start_link(init_arg) do
    DynamicSupervisor.start_link(__MODULE__, init_arg, name: __MODULE__)
  end

  @impl true
  def init(_init_arg) do
    DynamicSupervisor.init(strategy: :one_for_one)
  end
end

См. документацию Supervisor для обсуждения случаев, когда вы можете использовать модульные наблюдатели. Аннотация @doc непосредственно перед use DynamicSupervisor будет прикреплена к сгенерированной функции child_spec/1.

Регистрация имен

Наблюдатель связан с теми же правилами регистрации имен, что и GenServer. Подробнее об этих правилах см. в документации по GenServer.

Миграция из Supervisor's :simple_one_for_one

В случае использования устаревшей стратегии :simple_one_for_one из модуля Supervisor, вы можете перейти к DynamicSupervisor в несколько шагов.

Представьте данный "старый" код:

defmodule MySupervisor do
  use Supervisor

  def start_link(init_arg) do
    Supervisor.start_link(__MODULE__, init_arg, name: __MODULE__)
  end

  def start_child(foo, bar, baz) do
    # This will start child by calling MyWorker.start_link(init_arg, foo, bar, baz)
    Supervisor.start_child(__MODULE__, [foo, bar, baz])
  end

  @impl true
  def init(init_arg) do
    children = [
      # Or the deprecated: worker(MyWorker, [init_arg])
      %{id: MyWorker, start: {MyWorker, :start_link, [init_arg]}}
    ]

    Supervisor.init(children, strategy: :simple_one_for_one)
  end
end

Он может быть обновлен до DynamicSupervisor следующим образом:

defmodule MySupervisor do
  use DynamicSupervisor

  def start_link(init_arg) do
    DynamicSupervisor.start_link(__MODULE__, init_arg, name: __MODULE__)
  end

  def start_child(foo, bar, baz) do
    # If MyWorker is not using the new child specs, we need to pass a map:
    # spec = %{id: MyWorker, start: {MyWorker, :start_link, [foo, bar, baz]}}
    spec = {MyWorker, foo: foo, bar: bar, baz: baz}
    DynamicSupervisor.start_child(__MODULE__, spec)
  end

  @impl true
  def init(init_arg) do
    DynamicSupervisor.init(
      strategy: :one_for_one,
      extra_arguments: [init_arg]
    )
  end
end

Разница в том, что DynamicSupervisor ожидает спецификацию ребенка в момент вызова start_child/2, а не во время обратного вызова init. Если при инициализации указаны какие-либо начальные аргументы, такие как [initial_arg], их можно указать в флаге :extra_arguments в DynamicSupervisor.init/1.

Обзор

Типы

init_option()

Опции, передаваемые в start_link/2 и init/1

on_start_child()

Возвращаемые значения функций start_child

option()

Значения опций, используемые функциями start*

options()

Опции, используемые функциями start*

strategy()

Поддерживаемые стратегии

sup_flags()

Флаги наблюдателя, возвращаемые при инициализации

Функции

child_spec(opts)

Возвращает спецификацию для запуска динамического наблюдателя под наблюдателем.

count_children(supervisor)

Возвращает карту, содержащую значения подсчета для наблюдателя.

init(options)

Получает набор options для инициализации динамического наблюдателя.

start_child(supervisor, child_spec)

Динамически добавляет спецификацию ребенка к supervisor и запускает этого ребенка.

start_link(options)

Запускает наблюдателя с заданными опциями.

start_link(mod, init_arg, opts \\ [])

Запускает процесс модульного наблюдателя с заданными module и arg.

stop(supervisor, reason \\ :normal, timeout \\ :infinity)

Синхронно останавливает заданного наблюдателя с заданным reason.

terminate_child(supervisor, pid)

Завершает заданного ребенка, идентифицированного по pid.

which_children(supervisor)

Возвращает список с информацией обо всех детях.

Обратные вызовы

init(init_arg)

Обратный вызов, вызываемый для запуска наблюдателя и во время горячих обновлений кода.

Типы

init_option()

Specs

init_option() ::
  {:strategy, strategy()}
  | {:max_restarts, non_neg_integer()}
  | {:max_seconds, pos_integer()}
  | {:max_children, non_neg_integer() | :infinity}
  | {:extra_arguments, [term()]}

Опции, передаваемые в start_link/2 и init/1

on_start_child()

Specs

on_start_child() ::
  {:ok, pid()}
  | {:ok, pid(), info :: term()}
  | :ignore
  | {:error, {:already_started, pid()} | :max_children | term()}

Возвращаемые значения функций start_child

option()

Specs

option() :: {:name, Supervisor.name()} | init_option()

Значения опций, используемые функциями start*

options()

Specs

options() :: [option(), ...]

Опции, используемые функциями start*

strategy()

Specs

strategy() :: :one_for_one

Поддерживаемые стратегии

sup_flags()

Specs

sup_flags() :: %{
  strategy: strategy(),
  intensity: non_neg_integer(),
  period: pos_integer(),
  max_children: non_neg_integer() | :infinity,
  extra_arguments: [term()]
}

Флаги наблюдателя, возвращаемые при инициализации

END_OF_DOCUMENT_MARKER

Функции

child_spec(opts)

Возвращает спецификацию для запуска динамического надзорщика под надзорщиком.

См. Supervisor.

count_children(supervisor)

Спецификации

count_children(Supervisor.supervisor()) :: %{
  specs: non_neg_integer(),
  active: non_neg_integer(),
  supervisors: non_neg_integer(),
  workers: non_neg_integer()
}

Возвращает карту, содержащую значения счётчиков для надзорщика.

Карта содержит следующие ключи:

  • :specs - количество дочерних процессов

  • :active - количество активно работающих дочерних процессов, управляемых этим надзорщиком

  • :supervisors - количество всех надзорщиков, независимо от того, жив ли дочерний процесс

  • :workers - количество всех рабочих процессов, независимо от того, жив ли дочерний процесс

init(options)

Спецификации

init([init_option()]) :: {:ok, sup_flags()}

Получает набор options, которые инициализируют динамического надзорщика.

Обычно вызывается в конце обратного вызова init/1 надзорщиков на основе модулей. Подробнее см. раздел «Надзорщики на основе модулей» в документации модуля.

options, полученные этой функцией, также поддерживаются start_link/2.

Функция возвращает кортеж, содержащий параметры надзорщика.

Примеры 

def init(_arg) do
  DynamicSupervisor.init(max_children: 1000, strategy: :one_for_one)
end

Параметры

  • :strategy - стратегия перезапуска. Единственное поддерживаемое значение — :one_for_one, что означает, что другие дочерние процессы не завершаются при завершении дочернего процесса. Более подробно о стратегиях см. в документации модуля Supervisor.

  • :max_restarts - максимальное количество перезапусков, разрешенных за определенный период времени. По умолчанию 3.

  • :max_seconds - период времени, в течение которого действует :max_restarts. По умолчанию 5.

  • :max_children - максимальное количество дочерних процессов, работающих под этим надзорщиком одновременно. При превышении :max_children, start_child/2 возвращает {:error, :max_children}. По умолчанию :infinity.

  • :extra_arguments - аргументы, которые добавляются перед аргументами, указанными в спецификации дочернего процесса, переданной в start_child/2. По умолчанию — пустой список.

start_child(supervisor, child_spec)

Спецификации

start_child(
  Supervisor.supervisor(),
  Supervisor.child_spec() | {module(), term()} | module()
) :: on_start_child()

Динамически добавляет спецификацию дочернего процесса к supervisor и запускает этот процесс.

child_spec должна быть допустимой спецификацией дочернего процесса, как подробно описано в разделе «child_spec/1» документации Supervisor. Дочерний процесс будет запущен в соответствии со спецификацией.

Если функция запуска дочернего процесса возвращает {:ok, child} или {:ok, child, info}, то спецификация дочернего процесса и PID добавляются в надзорщик, и функция возвращает то же значение.

Если функция запуска дочернего процесса возвращает :ignore, то дочерний процесс не добавляется в дерево надзора, и функция также возвращает :ignore.

Если функция запуска дочернего процесса возвращает кортеж с ошибкой или ошибочное значение, или если произошла ошибка, то спецификация дочернего процесса отбрасывается, и функция возвращает {:error, error}, где error — это ошибка или ошибочное значение, возвращённое функцией запуска дочернего процесса, или причина ошибки, если она произошла.

Если у надзорщика уже есть N дочерних процессов, при этом N превышает количество :max_children , заданное при инициализации надзорщика (см. init/1), то функция возвращает {:error, :max_children}.

start_link(options)

Спецификации

start_link(options()) :: Supervisor.on_start()

Запускает надзорщика с заданными параметрами.

Параметр :strategy является обязательным и в настоящее время поддерживает значение :one_for_one. Остальные параметры можно найти в документации init/1.

Параметр :name также можно использовать для регистрации имени надзорщика. Поддерживаемые значения описаны в разделе «Регистрация имен» в документации модуля GenServer.

Если надзорщик успешно запущен, функция возвращает {:ok, pid}, где pid — PID надзорщика. Если надзорщику задано имя, и процесс с указанным именем уже существует, функция возвращает {:error, {:already_started, pid}}, где pid — PID этого процесса.

Обратите внимание, что надзорщик, запущенный с помощью этой функции, связан с родительским процессом и завершается не только при сбоях, но и если родительский процесс завершается с причиной :normal.

start_link(mod, init_arg, opts \\ [])

Спецификации

start_link(module(), term(), GenServer.options()) :: Supervisor.on_start()

Запускает процесс надзорщика на основе модуля с заданными module и arg.

Для запуска надзорщика вызывается обратный вызов init/1 в данном module, с arg в качестве аргумента. Обратный вызов init/1 должен вернуть спецификацию надзорщика, которая может быть создана с помощью функции init/1.

Если обратный вызов init/1 возвращает :ignore, эта функция также возвращает :ignore и надзорщик завершается с причиной :normal. Если произошла ошибка или возвращено некорректное значение, функция возвращает {:error, term}, где term — термин с информацией об ошибке, и надзорщик завершается с причиной term.

Параметр :name также может быть задан для регистрации имени надзорщика. Поддерживаемые значения описаны в разделе «Регистрация имен» в документации модуля GenServer.

stop(supervisor, reason \\ :normal, timeout \\ :infinity)

Спецификации

stop(Supervisor.supervisor(), reason :: term(), timeout()) :: :ok

Синхронно останавливает данный надзорщик с указанной reason.

Возвращает :ok если надзорщик завершается с данной причиной. Если он завершается по другой причине, вызов завершается.

Функция сохраняет семантику OTP в отношении обработки ошибок. Если причина отличается от :normal, :shutdown или {:shutdown, _}, регистрируется сообщение об ошибке.

terminate_child(supervisor, pid)

Спецификации

terminate_child(Supervisor.supervisor(), pid()) :: :ok | {:error, :not_found}

Завершает указанного дочернего процесса, идентифицированного по pid.

В случае успеха функция возвращает :ok. Если процесса с указанным PID нет, функция возвращает {:error, :not_found}.

which_children(supervisor)

Спецификации

which_children(Supervisor.supervisor()) :: [
  {:undefined, pid() | :restarting, :worker | :supervisor,
   :supervisor.modules()}
]

Возвращает список с информацией обо всех дочерних процессах.

Обратите внимание, что вызов этой функции при надзоре за большим количеством дочерних процессов в условиях низкой памяти может привести к исключению из-за нехватки памяти.

Функция возвращает список кортежей, содержащих:

  • id - всегда :undefined для динамических надзорщиков

  • child - PID соответствующего дочернего процесса или атом :restarting , если процесс собирается перезапуститься

  • type - :worker или :supervisor , как определено в спецификации дочернего процесса

  • modules - как определено в спецификации дочернего процесса

Обратные вызовы

init(init_arg)

Спецификации

init(init_arg :: term()) :: {:ok, sup_flags()} | :ignore

Обратный вызов, вызываемый для запуска надзорщика и во время горячих обновлений кода.

Разработчики обычно вызывают DynamicSupervisor.init/1 в конце своего обратного вызова init, чтобы вернуть соответствующие флаги надзора.

© 2012 Plataformatec
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/elixir/1.9.4/DynamicSupervisor.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API