Task.Supervisor

Наблюдатель задач.

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

Наблюдатель задач запускается без дочерних задач, часто под управлением наблюдателя и с именем:

children = [
  {Task.Supervisor, name: MyApp.TaskSupervisor}
]

Supervisor.start_link(children, strategy: :one_for_one)

Опции, указанные в спецификации дочерней задачи, документированы в start_link/1.

См. модуль Task для получения дополнительных примеров.

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

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

Краткое описание

Типы

option(): Значения опций, используемые start_link

Функции

async(supervisor, fun, options \\ []): Запускает задачу, на которой можно ожидать завершения
async(supervisor, module, fun, args, options \\ []): Запускает задачу, на которой можно ожидать завершения
async_nolink(supervisor, fun, options \\ []): Запускает задачу, на которой можно ожидать завершения
async_nolink(supervisor, module, fun, args, options \\ []): Запускает задачу, на которой можно ожидать завершения
async_stream(supervisor, enumerable, fun, options \\ []): Возвращает поток, который выполняет заданную функцию fun параллельно для каждого элемента в enumerable
async_stream(supervisor, enumerable, module, function, args, options \\ []): Возвращает поток, который выполняет заданную module, function, и args параллельно для каждого элемента в enumerable
async_stream_nolink(supervisor, enumerable, fun, options \\ []): Возвращает поток, который выполняет заданную function параллельно для каждого элемента в enumerable
async_stream_nolink(supervisor, enumerable, module, function, args, options \\ []): Возвращает поток, который выполняет заданную module, function, и args параллельно для каждого элемента в enumerable
children(supervisor): Возвращает все идентификаторы дочерних процессов
start_child(supervisor, fun, options \\ []): Запускает задачу как дочернюю задачу данного supervisor
start_child(supervisor, module, fun, args, options \\ []): Запускает задачу как дочернюю задачу данного supervisor
start_link(options \\ []): Запускает нового наблюдателя
terminate_child(supervisor, pid): Прерывает дочернюю задачу с заданным pid

Типы

option()

option() ::
  Supervisor.option()
  | {:restart, :supervisor.restart()}
  | {:shutdown, :supervisor.shutdown()}

Значения опций, используемые start_link

Функции

async(supervisor, fun, options \\ [])

async(Supervisor.supervisor(), (() -> any()), Keyword.t()) :: Task.t()

Запускает задачу, на которой можно ожидать завершения.

supervisor должно быть ссылкой, как определено в Task.Supervisor. Задача всё ещё будет связана с вызывающим процессом, см. Task.async/3 для получения дополнительной информации и async_nolink/2 для варианта без связи.

Опции

:shutdown - :brutal_kill если задачи должны быть убиты непосредственно при выключении, или целое число, указывающее значение таймаута, по умолчанию 5000 миллисекунд.

async(supervisor, module, fun, args, options \\ [])

async(Supervisor.supervisor(), module(), atom(), [term()], Keyword.t()) ::
  Task.t()

Запускает задачу, на которой можно ожидать завершения.

Опции

:shutdown - :brutal_kill если задачи должны быть убиты непосредственно при выключении, или целое число, указывающее значение таймаута, по умолчанию 5000 миллисекунд.

async_nolink(supervisor, fun, options \\ [])

async_nolink(Supervisor.supervisor(), (() -> any()), Keyword.t()) :: Task.t()

Запускает задачу, на которой можно ожидать завершения.

supervisor должно быть ссылкой, как определено в Task.Supervisor. Задача не будет связана с вызывающим процессом, см. Task.async/3 для получения дополнительной информации.

Опции

:shutdown - :brutal_kill если задачи должны быть убиты непосредственно при выключении, или целое число, указывающее значение таймаута, по умолчанию 5000 миллисекунд.

Совместимость с поведением OTP

Если вы создаёте задачу с использованием async_nolink внутри поведения OTP, такого как GenServer, вы должны обработать сообщение, приходящее от задачи, внутри вашего обратного вызова GenServer.handle_info/2.

Ответ, отправленный задачей, будет в формате {ref, result}, где ref - ссылка на монитор, хранящаяся в структуре задачи, а result - возвращаемое значение функции задачи.

Помните, что независимо от того, как завершается задача, созданная с помощью async_nolink, вызывающий процесс всегда получит сообщение :DOWN с тем же значением ref, которое хранится в структуре задачи. Если задача завершается нормально, причина в сообщении :DOWN будет :normal.

async_nolink(supervisor, module, fun, args, options \\ [])

async_nolink(Supervisor.supervisor(), module(), atom(), [term()], Keyword.t()) ::
  Task.t()

Запускает задачу, на которой можно ожидать завершения.

Обратите внимание, что эта функция требует, чтобы у наблюдателя задач была опция :temporary в качестве опции :restart (по умолчанию), поскольку async_nolink/4 сохраняет прямую ссылку на задачу, которая теряется, если задача перезапускается.

async_stream(supervisor, enumerable, fun, options \\ []) (since 1.4.0)

async_stream(
  Supervisor.supervisor(),
  Enumerable.t(),
  (term() -> term()),
  keyword()
) :: Enumerable.t()

Возвращает поток, который выполняет заданную функцию fun параллельно для каждого элемента в enumerable.

Каждый элемент в enumerable передаётся как аргумент заданной функции fun и обрабатывается своей собственной задачей. Задачи будут созданы под управлением заданного supervisor и связаны с текущим процессом, аналогично async/2.

См. async_stream/6 для обсуждения, опций и примеров.

async_stream(supervisor, enumerable, module, function, args, options \\ []) (since 1.4.0)

async_stream(
  Supervisor.supervisor(),
  Enumerable.t(),
  module(),
  atom(),
  [term()],
  keyword()
) :: Enumerable.t()

Возвращает поток, который выполняет заданную module, function, и args параллельно для каждого элемента в enumerable.

Каждый элемент будет добавлен в качестве префикса к заданному args и обработан своей собственной задачей. Задачи будут созданы под управлением заданного supervisor и связаны с текущим процессом, аналогично async/4.

При потоковой передаче каждая задача будет генерировать {:ok, value} при успешном выполнении или {:exit, reason} если вызывающий процесс перехватывает завершения. Результаты генерируются в том же порядке, что и исходный enumerable.

Уровень параллелизма можно контролировать с помощью опции :max_concurrency и по умолчанию он равен System.schedulers_online/0. Также можно указать таймаут в качестве опции, представляющей максимальное время ожидания ответа задачи.

Наконец, если вы перехватываете завершения для обработки завершений внутри асинхронного потока, рассмотрите использование async_stream_nolink/6 для запуска задач, которые не связаны с текущим процессом.

Опции

:max_concurrency - устанавливает максимальное количество задач, которые могут выполняться одновременно. По умолчанию значение System.schedulers_online/0.
:ordered - указывает, должны ли результаты возвращаться в том же порядке, что и входной поток. Этот параметр полезен при работе с большими потоками, когда вы не хотите буферизовать результаты перед их доставкой. По умолчанию true.
:timeout - максимальное время ожидания (в миллисекундах) без получения ответа на задачу (для всех выполняемых задач). По умолчанию 5000.
:on_timeout - действие, которое нужно выполнить при истечении времени ожидания задачи. Возможные значения:
- :exit (по умолчанию) - процесс, запустивший задачи, завершается.
- :kill_task - задача, которая превысила лимит времени, убивается. Значение, возвращаемое для этой задачи, равно {:exit, :timeout}.
:shutdown - :brutal_kill если задачи должны быть убиты при выходе, или целое число, обозначающее время ожидания, по умолчанию 5000 миллисекунд.

Примеры

Давайте создадим поток и затем перечислим его:

stream = Task.Supervisor.async_stream(MySupervisor, collection, Mod, :expensive_fun, [])
Enum.to_list(stream)

async_stream_nolink(supervisor, enumerable, fun, options \\ []) (с версии 1.4.0)

async_stream_nolink(
  Supervisor.supervisor(),
  Enumerable.t(),
  (term() -> term()),
  keyword()
) :: Enumerable.t()

Возвращает поток, который выполняет заданную function одновременно для каждого элемента в enumerable.

Каждый элемент в enumerable передается в качестве аргумента заданной функции fun и обрабатывается своей собственной задачей. Задачи будут запущены под заданным supervisor и не будут связаны с текущим процессом, аналогично async_nolink/2.

См. async_stream/6 для обсуждения и примеров.

async_stream_nolink(supervisor, enumerable, module, function, args, options \\ []) (с версии 1.4.0)

async_stream_nolink(
  Supervisor.supervisor(),
  Enumerable.t(),
  module(),
  atom(),
  [term()],
  keyword()
) :: Enumerable.t()

Возвращает поток, который выполняет заданный module, function, и args одновременно для каждого элемента в enumerable.

Каждый элемент в enumerable будет добавлен в качестве префикса к заданной args и обработан своей собственной задачей. Задачи будут запущены под заданным supervisor и не будут связаны с текущим процессом, аналогично async_nolink/4.

См. async_stream/6 для обсуждения, параметров и примеров.

children(supervisor)

children(Supervisor.supervisor()) :: [pid()]

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

start_child(supervisor, fun, options \\ [])

start_child(Supervisor.supervisor(), (() -> any()), keyword()) ::
  DynamicSupervisor.on_start_child()

Запускает задачу как дочернюю задачу для заданного supervisor.

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

Параметры

:restart - стратегия перезапуска, может быть :temporary (по умолчанию), :transient или :permanent. :temporary означает, что задача никогда не перезапускается, :transient означает, что она перезапускается, если выход не :normal, :shutdown или {:shutdown, reason}. Стратегия перезапуска :permanent означает, что она всегда перезапускается. По умолчанию :temporary.
:shutdown - :brutal_kill если задачи должны быть убиты при выходе, или целое число, обозначающее время ожидания, по умолчанию 5000 миллисекунд.

start_child(supervisor, module, fun, args, options \\ [])

start_child(Supervisor.supervisor(), module(), atom(), [term()], keyword()) ::
  DynamicSupervisor.on_start_child()

Запускает задачу как дочернюю задачу для заданного supervisor.

Аналогично start_child/2, за исключением того, что задача задается с помощью заданного module, fun и args.

start_link(options \\ [])

start_link([option()]) :: Supervisor.on_start()

Запускает нового диспетчера.

Примеры

Диспетчер задач обычно запускается в дереве управления с использованием формата кортежей:

{Task.Supervisor, name: MyApp.TaskSupervisor}

Вы также можете запустить его, вызвав start_link/1 напрямую:

Task.Supervisor.start_link(name: MyApp.TaskSupervisor)

Но это рекомендуется только для сценариев и следует избегать в коде для производства. Как правило, процессы всегда должны запускаться внутри деревьев управления.

Параметры

:name - используется для регистрации имени диспетчера, поддерживаемые значения описаны в разделе Name Registration в документации модуля GenServer;
:max_restarts, :max_seconds и :max_children - как указано в DynamicSupervisor;

Эта функция также может принимать :restart и :shutdown в качестве параметров, но эти два параметра устарели, и теперь предпочтительнее указывать их напрямую для start_child и async.

terminate_child(supervisor, pid)

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

Завершает дочерний процесс с заданным pid.

© 2012 Plataformatec
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/elixir/1.7.4/Task.Supervisor.html