Kathikon.Scheduler.Quantum.Scheduler behaviour (Kathikon v0.2.0)

Copy Markdown View Source

Behaviour for the user-configured Quantum scheduler module.

Implement this behaviour in your app scheduler, or use a test double.

Summary

Callbacks

add_job(term, keyword)
delete_job(term)
fetch_job(term)
jobs()
update_job(term, keyword)

Callbacks

add_job(term, keyword)

@callback add_job(
  term(),
  keyword()
) :: term()

delete_job(term)

@callback delete_job(term()) :: :ok | {:error, term()}

fetch_job(term)

@callback fetch_job(term()) :: {:ok, map()} | {:error, term()}

jobs()

@callback jobs() :: [map()]

update_job(term, keyword)

@callback update_job(
  term(),
  keyword()
) :: {:ok, map()} | {:error, term()}