Utility typeclass to call public supervision API with types that contain a supervisor (e.g. Capataz record).

Internal record that indicates what type of callback function is being invoked; this is used for telemetry purposes

Specifies how a Supervisor deals with the lifecycle of worker process in case of completion without errors and failure.

Defines how a Worker process termination should be handled by its supervisor.

Specifies all options that can be used to create a Worker Process. You may create a record of this type via the smart constructor "buildWorkerOptions".

Record used to specify how to build a runtime Process in a static supervision tree; to create values of this type, you must use:

• "workerSpec" or "workerSpecWithDefaults" to build a worker process
• "supervisorSpec" or "supervisorSpecWithDefaults" to build a supervisor process

Specifies the order in which supervised process should be terminated by a Supervisor in case of a restart or shutdown.

Internal exception triggered when a callback of a Worker fails

Specifies how a Supervisor restarts a failing process.

Internal record used as a state machine, indicating the state of a supervisor process

Allows to:

• Specify options for The root supervisor of a capataz system.
• Provie a "notifyEvent" callback to monitor or log a capataz system.

Record that contains the environment of a capataz monitor, this is used as the main record to create workers and to stop the supervisor thread.

Builds a SupervisorOptions record with defaults from "buildSupervisorOptionsWithDefaults". This function allows overrides of these defaults using lenses.

This function is intended to be used in combination with "forkSupervisor".

Builds a SupervisorOptions record with defaults to create a supervisor process, these defaults are:

• Intensity error tolerance is set to 1 error every 5 seconds
• A SupervisorRestartStrategy of OneForOne
• A ProcessTerminationOrder of OldestFirst

This function is intended to be used in combination with "forkSupervisor".

Builds a WorkerOptions record, keeps the defaults from "buildWorkerOptionsWithDefaults" but allows overrides using lenses.

This function is intended to be used in combination with "forkWorker". See the ... example in the examples directory for a demonstration.

Builds a WorkerOptions record with defaults to create a worker process, the defaults are:

• A Transient WorkerRestartStrategy
• A WorkerTerminationPolicy of a 3 seconds timeout
• A _completion_ callback that just returns unit
• A _termination_ callback that just returns unit
• A _failure_ callback that just returns unit

This function is intended to be used in combination with "forkWorker", for creating a worker in an static supervision tree, use "workerSpecWithDefaults" instead. See the ... example for a demonstration.

Builds a ProcessSpec record for a supervisor process with defaults from "supervisorSpecWithDefaults". This function allows overrides of these defaults using lenses.

This function is used when building a supervisor branch in a static supervision trees.

Builds a ProcessSpec record for a supervisor process with defaults from "buildSupervisorOptionsWithDefaults".

This function is used when building a supervisor branch in a static supervision trees.

Builds a ProcessSpec record for a worker process with defaults from "workerSpecWithDefaults". This function allows overrides of these defaults using lenses.

This function is used when building a worker in a static supervision tree.

Builds a ProcessSpec record for a worker process with defaults from "buildSupervisorOptionsWithDefaults".

This function is used when building a worker in a static supervision tree.

Specifies how many errors is a supervisor able to handle; check: http://erlang.org/doc/design_principles/sup_princ.html#max_intensity.

Specifies period of time in which a supervisor can receive a number of errors specified in "supervisorIntensityL".

Specifies the SupervisorRestartStrategy for a root supervisor.

Specifies a static list of processes that start automatically with a supervisor.

Specifies order in which a supervisor is going to terminate its supervised processes.

Specifies a callback sub-routine that gets executed when there is a breach in a supervisor's error intensity.

Specifies callback sub-routine that gets executed when a supervisor fails.

Specifies callback that gets executed when worker sub-routine has runtime error.

NOTE: the given sub-routine execution may be interrupted depending on the worker WorkerTerminationPolicy.

Specifies callback that gets executed when worker sub-routine completes with no errors.

NOTE: the given sub-routine execution may be interrupted depending on the worker WorkerTerminationPolicy.

Specifies callback that gets executed when worker sub-routine is terminated by its supervisor; this may happen in case of a capataz system shutdown or when there is an AllForOne restart policy in place.

NOTE: the given sub-routine execution may be interrupted depending on the worker WorkerTerminationPolicy.

Specifies how to handle a worker termination. See WorkerTerminationPolicy documentation for more details.

Specifies how supervisor should deal with an error when worker fails or completes. See WorkerRestartStrategy documentation for more details.

Creates a green thread from an "IO ()" sub-routine. Depending in options defined in the WorkerOptions record, it will automatically restart this sub-routine in case of failures.

See documentation of related functions:

• "buildWorkerOptionsWithDefault"
• "buildWorkerOptions"

Creates a green thread which monitors other green threads for failures and restarts them using settings defined on SupervisorOptions.

See documentation of related functions:

• "buildSupervisorOptionsWithDefault"
• "buildSupervisorOptions"

Creates a Capataz record, which holds both a root supervisor and a Teardown to shut down the system. The root supervisor monitors failures on process threads defined with "supervisorProcessSpecList" or created dynamically using "forkWorker" or "forkSupervisor".

Stops the execution of a green thread being supervised by the given supervisor.

NOTE: If ProcessId maps to a worker that is configured with a Permanent worker restart strategy, the worker green thread will be restarted again.

Joins the thread of the root supervisor of the given capataz system to the current thread.

Gets the process identifier of a Supervisor; normally used for termination.

Gets the Async of a Supervisor thread.

NOTE: There is no way to get the Async value of the root supervisor; this is to avoid error scenarios.

Gets Teardown record of this capataz system.

Executes teardown sub-routine returning a TeardownResult

(.~) assigns a value to the target. It's the same thing as using (%~) with const:

l .~ x = l %~ const x

See set if you want a non-operator synonym.

Here it is used to change 2 fields of a 3-tuple:

>>> (0,0,0) & _1 .~ 1 & _3 .~ 3
(1,0,3)

& is a reverse application operator. This provides notational convenience. Its precedence is one higher than that of the forward application operator $, which allows & to be nested in $.

Since: 4.8.0.0

set is a synonym for (.~).

Setting the 1st component of a pair:

set _1 :: x -> (a, b) -> (x, b)
set _1 = \x t -> (x, snd t)

Using it to rewrite (<$):

set mapped :: Functor f => a -> f b -> f a
set mapped = (<$)