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

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

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

Вызывает ошибку, если supervisor достигла максимального количества дочерних процессов.

Опции

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

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

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

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

Вызывает ошибку, если supervisor достигла максимального количества дочерних процессов.

Опции

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

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

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

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

Вызывает ошибку, если supervisor достигла максимального количества дочерних процессов.

Опции

• :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/3, когда есть разумное предположение, что задача может потерпеть неудачу, и вы не хотите, чтобы она приводила к сбою вызывающего процесса. Давайте рассмотрим пример, где GenServer предназначен для выполнения одной задачи и отслеживания её состояния:

defmodule MyApp.Server do
  use GenServer

  # ...

  def start_task do
    GenServer.call(__MODULE__, :start_task)
  end

  # In this case the task is already running, so we just return :ok.
  def handle_call(:start_task, _from, %{ref: ref} = state) when is_reference(ref) do
    {:reply, :ok, state}
  end

  # The task is not running yet, so let's start it.
  def handle_call(:start_task, _from, %{ref: nil} = state) do
    task =
      Task.Supervisor.async_nolink(MyApp.TaskSupervisor, fn ->
        ...
      end)

    # We return :ok and the server will continue running
    {:reply, :ok, %{state | ref: task.ref}}
  end

  # The task completed successfully
  def handle_info({ref, answer}, %{ref: ref} = state) do
    # We don't care about the DOWN message now, so let's demonitor and flush it
    Process.demonitor(ref, [:flush])
    # Do something with the result and then return
    {:noreply, %{state | ref: nil}}
  end

  # The task failed
  def handle_info({:DOWN, ref, :process, _pid, _reason}, %{ref: ref} = state) do
    # Log and possibly restart the task...
    {:noreply, %{state | ref: nil}}
  end
end

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

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

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

Вызывает ошибку, если supervisor достигла максимального количества дочерних процессов.

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

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

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

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

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

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

Возвращает поток, где заданная функция (module и function) применяется асинхронно к каждому элементу в enumerable.

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

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

Уровень параллельности и время работы задач можно контролировать с помощью опций (см. раздел «Опции» ниже).

Если вы обнаружите, что ловите выхода для обработки выходов внутри асинхронного потока, рассмотрите использование 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)

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

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

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

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

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

Возвращает поток, где заданная функция (module и function) применяется асинхронно к каждому элементу в enumerable.

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

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

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

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

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

Запускает задачу как дочерний процесс заданного supervisor.

Task.Supervisor.start_child(MyTaskSupervisor, fn ->
  IO.puts "I am running in a task"
end)

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

Параметры

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

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

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

Запускает задачу как дочерний процесс заданного supervisor.

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

@spec 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.

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

Прерывает дочерний процесс с указанным pid.