Elixir v1.1.1 Task.Supervisor

A tasks supervisor.

This module defines a supervisor which can be used to dynamically supervise tasks. Behind the scenes, this module is implemented as a :simple_one_for_one supervisor where the workers are temporary (i.e. they are not restarted after they die).

See the Task module for more information.

Name Registration

A Task.Supervisor is bound to the same name registration rules as a GenServer. Read more about it in the GenServer docs.

Summary

Functions

async(supervisor, fun)

Starts a task that can be awaited on

async(supervisor, module, fun, args)

Starts a task that can be awaited on

children(supervisor)

Returns all children pids

start_child(supervisor, fun)

Starts a task as child of the given supervisor

start_child(supervisor, module, fun, args)

Starts a task as child of the given supervisor

start_link(opts \\ [])

Starts a new supervisor

terminate_child(supervisor, pid)

Terminates the child with the given pid

Functions

async(supervisor, fun)

Specs

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

Starts a task that can be awaited on.

The supervisor must be a reference as defined in Task.Supervisor. For more information on tasks, check the Task module.

async(supervisor, module, fun, args)

Specs

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

Starts a task that can be awaited on.

The supervisor must be a reference as defined in Task.Supervisor. For more information on tasks, check the Task module.

children(supervisor)

Specs

children(Supervisor.supervisor) :: [pid]

Returns all children pids.

start_child(supervisor, fun)

Specs

start_child(Supervisor.supervisor, (... -> any)) :: {:ok, pid}

Starts a task as child of the given supervisor.

Note that the spawned process is not linked to the caller, but only to the supervisor. This command is useful in case the task needs to perform side-effects (like I/O) and does not need to report back to the caller.

start_child(supervisor, module, fun, args)

Specs

start_child(Supervisor.supervisor, module, atom, [term]) :: {:ok, pid}

Starts a task as child of the given supervisor.

Similar to start_child/2 except the task is specified by the given module, fun and args.

start_link(opts \\ [])

Specs

start_link(Supervisor.options) :: Supervisor.on_start

Starts a new supervisor.

The supported options are:

:name - used to register a supervisor name, the supported values are described under the Name Registration section in the GenServer module docs;
:restart - the restart strategy, may be :temporary (the default), :transient or :permanent. Check Supervisor.Spec for more info. Defaults to temporary as most tasks can’t be effectively restarted after a crash;
:shutdown - :brutal_kill if the tasks must be killed directly on shutdown or an integer indicating the timeout value, defaults to 5000 milliseconds;
:max_restarts and :max_seconds - as specified in Supervisor.Spec.supervise/2;

terminate_child(supervisor, pid)

Specs

terminate_child(Supervisor.supervisor, pid) :: :ok

Terminates the child with the given pid.