Ant.Workers (Ant v1.0.0)

Reading and writing the jobs Ant stores.

The perform_async/2 that Ant.Worker defines on your worker module is the usual way to create a job; the functions here are for inspecting and managing the ones already created.

Summary

Functions

create_worker(worker)

delete_worker(worker)

get_worker(id)

list_enqueued_workers(clauses, date_time \\ DateTime.utc_now(), opts \\ [])

list_retrying_workers(clauses, date_time \\ DateTime.utc_now(), opts \\ [])

list_scheduled_workers(clauses, date_time \\ DateTime.utc_now(), opts \\ [])

list_worker_timestamps()

list_workers(clauses \\ %{}, opts \\ [])

update_worker(id, params)

Functions

create_worker(worker)

@spec create_worker(Ant.Worker.t()) :: {:ok, Ant.Worker.t()} | {:error, any()}

delete_worker(worker)

@spec delete_worker(Ant.Worker.t() | map()) :: :ok | {:error, any()}

get_worker(id)

@spec get_worker(integer()) :: {:ok, Ant.Worker.t()} | {:error, any()}

list_enqueued_workers(clauses, date_time \\ DateTime.utc_now(), opts \\ [])

@spec list_enqueued_workers(map(), DateTime.t(), keyword()) :: {:ok, [Ant.Worker.t()]}

list_retrying_workers(clauses, date_time \\ DateTime.utc_now(), opts \\ [])

@spec list_retrying_workers(map(), DateTime.t(), keyword()) :: {:ok, [Ant.Worker.t()]}

list_scheduled_workers(clauses, date_time \\ DateTime.utc_now(), opts \\ [])

@spec list_scheduled_workers(map(), DateTime.t(), keyword()) ::
  {:ok, [Ant.Worker.t()]}

list_worker_timestamps()

@spec list_worker_timestamps() :: {:ok, [map()]}

list_workers(clauses \\ %{}, opts \\ [])

@spec list_workers(
  map(),
  keyword()
) :: {:ok, [Ant.Worker.t()]}

update_worker(id, params)

@spec update_worker(integer(), map()) :: {:ok, Ant.Worker.t()} | {:error, any()}