backy v0.0.16 Backy
Link to this section Summary
Functions
Enqueue a job to be run immediately. The job will be persisted and then queued to be run immediately on the current node
Called when an application is started
Touch a job to avoid it to timeout
Link to this section Functions
Enqueue a job to be run immediately. The job will be persisted and then queued to be run immediately on the current node.
This function returns only after the job has been persisted.
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 nodenode
.{:failover, node}
- used if the application is distributed and is started on the current node because of a failover on nodenode
, 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
.
Touch a job to avoid it to timeout.
This is intended to be called from within worker if your job is long.
For example, you might have an encoding job that take any time to finish
depending on the lenght of the video. You will set the max_runtime
or the
worker to a couple of minutes, and in your perform
function inside
the worker, you will call this function to extend your job lifetime.