The interface for the core Citrine scheduler. To use the scheduler, define a module that uses Citrine.Scheduler.

Citrine uses Erlang's :mnesia module for state management. Tables are stored in-memory as RAM copies, thus they are not persisted to disk.

Usage

Define a scheduler based on Citrine.Scheduler:

defmodule MyApp.Scheduler do
  use Citrine.Scheduler, otp_app: :myapp
  def initialize_jobs() do
    # Initialize your jobs here
    put_job(%Citrine.Job{
      id: "hourly",
      schedule: "0 * * * *",
      task: fn -> nil end
    })
  end
end

Citrine should be added to your application's supervisor tree:

defmodule MyApp.Application do
  use Application
  def start(_type, _args) do
    children = [
      # Start the Citrine scheduler
      MyApp.Scheduler
    ]
    opts = [strategy: :one_for_one, name: MyApp.Supervisor]
    Supervisor.start_link(children, opts)
  end
end

Additionally, it's recommended that you provide an init_task to perform initialization at startup. You should also specify a sufficient init_task_delay to allow everything to settle before running the init task. The init task will be ran after mnesia has initialized.

For example, you could specify the following in config.exs:

config :myapp, MyApp.Scheduler,
  init_task_delay: 30_000,
  init_task: {MyApp.Scheduler, :initialize_jobs, []}

Example

iex(1)> defmodule MyApp.Scheduler do
...(1)>   use Citrine.Scheduler, otp_app: :myapp
...(1)> end
iex(2)> MyApp.Scheduler.start_link()
iex(3)> MyApp.Scheduler.put_job(
...(3)>   %Citrine.Job{
...(3)>    id: "job",
...(3)>    schedule: "* * * * *",
...(3)>    task: fn -> nil end
...(3)>  })