Cyclium.Runner behaviour (Cyclium v0.1.5)

Copy Markdown

Behaviour for episode execution backends. Default is Cyclium.Runner.OTP. Can be swapped for Oban-backed runner.

Summary

Callbacks

cancel(episode_id)
enqueue(episode_id, opts)
recover_incomplete()

Callbacks

cancel(episode_id)

@callback cancel(episode_id :: binary()) :: :ok | {:error, term()}

enqueue(episode_id, opts)

@callback enqueue(episode_id :: binary(), opts :: keyword()) ::
  {:ok, term()} | {:error, term()}

recover_incomplete()

@callback recover_incomplete() :: :ok