Supervisor.Spec

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

Функции в этом модуле устарели и не работают с спецификациями дочерних процессов на основе модулей, представленными в Elixir версии 1.5. Пожалуйста, обратитесь к документации 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)

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

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.init/1.

Параметры супервайзера и рабочих процессов

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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