Oban.Pro.Workers.Batch behaviour (Oban Pro v1.5.0-rc.5)

This behaviour is deprecated. Use Oban.Pro.Batch instead.

A dedicated worker for grouping the execution of jobs.

This worker is deprecated in favor of Oban.Pro.Batch, which is more flexible and supports more options.

Summary

Callbacks

Link to this callback

all_batch_jobs(t, list)

@callback all_batch_jobs(Oban.Job.t(), [keyword()]) :: Enum.t()
@callback gen_id() :: String.t()
Link to this callback

handle_attempted(t)

(optional)
@callback handle_attempted(Oban.Job.t()) :: Oban.Worker.result()
Link to this callback

handle_cancelled(t)

(optional)
@callback handle_cancelled(Oban.Job.t()) :: Oban.Worker.result()
Link to this callback

handle_completed(t)

(optional)
@callback handle_completed(Oban.Job.t()) :: Oban.Worker.result()
Link to this callback

handle_discarded(t)

(optional)
@callback handle_discarded(Oban.Job.t()) :: Oban.Worker.result()
Link to this callback

handle_exhausted(t)

(optional)
@callback handle_exhausted(Oban.Job.t()) :: Oban.Worker.result()
Link to this callback

handle_retryable(t)

(optional)
@callback handle_retryable(Oban.Job.t()) :: Oban.Worker.result()
Link to this callback

new_batch(list, list)

@callback new_batch([Oban.Job.t() | Oban.Job.args()], [keyword()]) :: Oban.Pro.Batch.t()
Link to this callback

stream_batch_jobs(t, list)

@callback stream_batch_jobs(Oban.Job.t(), [keyword()]) :: Enum.t()