TaskBunny

v0.3.4

TaskBunny v0.3.4 TaskBunny.WorkerSupervisor View Source

Supervises all TaskBunny workers.

You don’t have to call or start the Supervisor explicity. It will be automatically started by application and configure child workers based on configuration file.

It also provides graceful_halt/1 and graceful_halt/2 that allow you to shutdown the worker processes safely.

Link to this section Summary

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor

graceful_halt(timeout)

Similar to graceful_halt/2 but gets pid from module name

graceful_halt(pid, timeout)

Halts the job pocessing on workers gracefully. It makes workers to stop processing new jobs and waits for jobs currently running to finish

Link to this section Functions

Link to this function child_spec(arg) View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function graceful_halt(timeout) View Source 
graceful_halt(integer()) :: :ok | {:error, any()}

Similar to graceful_halt/2 but gets pid from module name.

Link to this function graceful_halt(pid, timeout) View Source 
graceful_halt(pid() | nil, integer()) :: :ok | {:error, any()}

Halts the job pocessing on workers gracefully. It makes workers to stop processing new jobs and waits for jobs currently running to finish.

Note: It doesn’t terminate any worker processes. The worker and worker supervisor processes will continue existing but won’t consume any new messages. To resume it, terminate the worker supervisor then the main supervisor will start new processes.