Quantum v2.3.4 Quantum.TaskRegistry View Source

Registry to check if a task is already running on a node.

Link to this section Summary

Functions

Query if any tasks are running in the cluster

Returns a specification to start this module under a supervisor

Query if a task with given name is running

Mark a task as Finished

Mark a task as Running

Start the registry

Link to this section Functions

Query if any tasks are running in the cluster

Examples

iex> Quantum.TaskRegistry.any_running?(server_with_running_tasks)
true

iex> Quantum.TaskRegistry.any_running?(server_without_running_tasks)
false

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function is_running?(server, task) View Source

Query if a task with given name is running

Examples

iex> Quantum.TaskRegistry.is_running?(server, running_job.name)
true

iex> Quantum.TaskRegistry.is_running?(server, not_running_job.name)
false
Link to this function mark_finished(server, task, node) View Source

Mark a task as Finished

Examples

iex> Quantum.TaskRegistry.mark_running(server, running_job.name, self())
:ok

iex> Quantum.TaskRegistry.mark_running(server, not_running_job.name, self())
:ok
Link to this function mark_running(server, task, node) View Source

Mark a task as Running

Examples

iex> Quantum.TaskRegistry.mark_running(server, running_job.name, self())
:already_running

iex> Quantum.TaskRegistry.mark_running(server, not_running_job.name, self())
:marked_running
Link to this function start_link(name) View Source
start_link(Quantum.TaskRegistry.StartOpts.t()) :: GenServer.on_start()
start_link(GenServer.server()) :: GenServer.on_start()

Start the registry