Task.Supervisor

Introduction #

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).

The functions in this module allow tasks to be spawned and awaited from a supervisor, similar to the functions defined in the Task module.

Name Registration

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

Source

Functions #

async(supervisor, fun)

(function)

Specs

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)

(function)

Specs

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)

(function)

Specs

Returns all children pids.

start_child(supervisor, fun)

(function)

Specs

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)

(function)

Specs

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 \\ [])

(function)

Specs

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;

  • :shutdown - :brutal_kill if the tasks must be killed directly on shutdown or an integer indicating the timeout value, defaults to 5000 milliseconds;

terminate_child(supervisor, pid)

(function)

Specs

Terminates the child with the given pid.