Устаревшие функции для создания спецификаций дочерних процессов.

Функции в этом модуле устарели и не работают с основанными на модуле спецификациями дочерних процессов, представленными в Elixir v1.5. Пожалуйста, обратитесь к документации Supervisor вместо этого.

Функции для удобства определения спецификаций Supervisor.

Пример

Используя функции в этом модуле, можно указать дочерние процессы, которые будут использоваться под Supervisor, запущенные с помощью Supervisor.start_link/2:

import Supervisor.Spec

children = [
  worker(MyWorker, [arg1, arg2, arg3]),
  supervisor(MySupervisor, [arg1])
]

Supervisor.start_link(children, strategy: :one_for_one)

Иногда может быть полезно определить Supervisor, основанный на модуле:

defmodule MySupervisor do
  use Supervisor

  def start_link(arg) do
    Supervisor.start_link(__MODULE__, arg)
  end

  def init(arg) do
    children = [
      worker(MyWorker, [arg], restart: :temporary)
    ]

    supervise(children, strategy: :simple_one_for_one)
  end
end

Обратите внимание, что в этом случае нам не нужно явно импортировать Supervisor.Spec, так как use Supervisor автоматически это делает. Определение Supervisor, основанного на модуле, может быть полезно, например, для выполнения задач инициализации в обратном вызове Supervisor.init/1.

Параметры Supervisor и worker

В примере выше мы определили спецификации для worker и Supervisor. Эти спецификации (как для worker, так и для Supervisor) принимают следующие параметры:

• :id — имя, используемое для идентификации спецификации дочернего процесса внутри Supervisor; по умолчанию совпадает с именем модуля дочернего worker/Supervisor

• :function — функция для вызова в дочернем процессе для его запуска

• :restart — атом, определяющий, когда завершенный дочерний процесс должен быть перезапущен (см. раздел «Значения перезапуска» ниже)

• :shutdown — атом, определяющий, как должен быть завершен дочерний процесс (см. раздел «Значения завершения» ниже)

• :modules — это должен быть список с одним элементом [module], где module — имя модуля обратного вызова только в том случае, если дочерний процесс является Supervisor или GenServer; если дочерний процесс является GenEvent, :modules должен быть :dynamic

Значения перезапуска (:restart)

В параметре :restart поддерживаются следующие значения перезапуска:

• :permanent — дочерний процесс всегда перезапускается

• :temporary — дочерний процесс никогда не перезапускается (даже если стратегия Supervisor — :rest_for_one или :one_for_all)

• :transient — дочерний процесс перезапускается только если он завершается аномально, то есть с причиной завершения, отличной от :normal, :shutdown или {:shutdown, term}

Обратите внимание, что Supervisor, достигший максимальной интенсивности перезапуска, завершится с причиной :shutdown. В этом случае Supervisor будет перезапущен только если его спецификация дочернего процесса была определена с параметром :restart, установленным в :permanent (по умолчанию).

Значения завершения (:shutdown)

В параметре :shutdown поддерживаются следующие значения завершения:

• :brutal_kill — дочерний процесс безусловно завершается с помощью Process.exit(child, :kill)

• :infinity — если дочерний процесс является Supervisor, это механизм, который даёт поддереву достаточно времени для завершения; его также можно использовать с worker, но с осторожностью

• неотрицательное целое число — количество миллисекунд, которое Supervisor сообщает дочернему процессу для завершения, вызывая Process.exit(child, :shutdown), и затем ожидает сигнала завершения. Если сигнал завершения не получен в течение указанного времени, дочерний процесс безусловно завершается с помощью Process.exit(child, :kill)