Quantum v1.9.1 Quantum

A cron-like job scheduler

Summary

Types

A cron expression

A function/0 to be called when cron expression matches

A job is defined by a cron expression and a task

A job options can be defined as list or map

Functions

Activates a job by name

Adds a new unnamed job

Adds a new named job

Deactivates a job by name

Deletes all jobs

Deletes a job by name

Resolves a job by name

Returns the list of currently defined jobs

Starts Quantum process

Types

expr()
expr() :: String.t | Atom

A cron expression

fun0()
fun0() :: (() -> Type)

A function/0 to be called when cron expression matches

job()
job() :: {atom, Quantum.Job.t}

A job is defined by a cron expression and a task

opts()
opts() :: list | map | fun0

A job options can be defined as list or map

Functions

activate_job(n)
activate_job(expr) :: :ok

Activates a job by name

add_job(job)
add_job(job) :: :ok

Adds a new unnamed job

add_job(expr, job)
add_job(expr, job) :: :ok | :error

Adds a new named job

deactivate_job(n)
deactivate_job(expr) :: :ok

Deactivates a job by name

delete_all_jobs()
delete_all_jobs() :: :ok

Deletes all jobs

delete_job(name)
delete_job(expr) :: job

Deletes a job by name

find_job(name)
find_job(expr) :: job

Resolves a job by name

jobs()
jobs() :: [job]

Returns the list of currently defined jobs

start_link(state)

Starts Quantum process