toniq v1.2.3 Toniq

Summary

Functions

Delete a failed job

Enqueue job to be run in the background as soon as possible

Enqueue job to be run in the background at a later time

List failed jobs

Flush all delayed jobs

Retry a failed job

Called when an application is started

Functions

delete(job)

Delete a failed job

enqueue(worker_module, arguments \\ [])

Enqueue job to be run in the background as soon as possible

enqueue_to(arguments, worker_module, options \\ [])

Enqueue for use in pipelines

Example:

params |> extract_data |> Toniq.enqueue_to(SendEmailWorker)

enqueue_with_delay(worker_module, arguments, options)

Enqueue job to be run in the background at a later time

failed_jobs()

List failed jobs

flush_delayed_jobs()

Flush all delayed jobs

retry(job)

Retry a failed job

start(type, args)

Called when an application is started.

This function is called when an application is started using Application.start/2 (and functions on top of that, such as Application.ensure_started/2). This function should start the top-level process of the application (which should be the top supervisor of the application’s supervision tree if the application follows the OTP design principles around supervision).

start_type defines how the application is started:

  • :normal - used if the startup is a normal startup or if the application is distributed and is started on the current node because of a failover from another node and the application specification key :start_phases is :undefined.
  • {:takeover, node} - used if the application is distributed and is started on the current node because of a failover on the node node.
  • {:failover, node} - used if the application is distributed and is started on the current node because of a failover on node node, and the application specification key :start_phases is not :undefined.

start_args are the arguments passed to the application in the :mod specification key (e.g., mod: {MyApp, [:my_args]}).

This function should either return {:ok, pid} or {:ok, pid, state} if startup is successful. pid should be the PID of the top supervisor. state can be an arbitrary term, and if omitted will default to []; if the application is later stopped, state is passed to the stop/1 callback (see the documentation for the c:stop/1 callback for more information).

use Application provides no default implementation for the start/2 callback.

Callback implementation for Application.start/2.