View Source AntikytheraCore.AsyncJob.Queue (antikythera v0.5.1)

A queue-like data structure, replicated using RaftedValue, to store AntikytheraCore.AsyncJob structs.

Summary

Types

t()

Functions

abandoned_jobs(queue)

Type-aware getter for abandoned_jobs.

abandoned_jobs(s, field)

Type-aware setter for abandoned_jobs.

add_job(queue_name, job_id, job, start_time_millis, now_millis)
brokers_to_notify(queue)

Type-aware getter for brokers_to_notify.

brokers_to_notify(s, field)

Type-aware setter for brokers_to_notify.

brokers_waiting(queue)

Type-aware getter for brokers_waiting.

brokers_waiting(s, field)

Type-aware setter for brokers_waiting.

cancel(queue_name, job_id)
fetch_job(queue_name)
index_runnable(queue)

Type-aware getter for index_runnable.

index_runnable(s, field)

Type-aware setter for index_runnable.

index_running(queue)

Type-aware getter for index_running.

index_running(s, field)

Type-aware setter for index_running.

index_waiting(queue)

Type-aware getter for index_waiting.

index_waiting(s, field)

Type-aware setter for index_waiting.

jobs(queue)

Type-aware getter for jobs.

jobs(s, field)

Type-aware setter for jobs.

list(queue_name)
make_rv_config(opts \\ [leader_hook_module: AntikytheraCore.AsyncJob.Queue.Hook, heartbeat_timeout: 1000, election_timeout: 5000, election_timeout_clock_drift_margin: 500])
max_jobs()
new(dict)

Creates a new instance of AntikytheraCore.AsyncJob.Queue by using the given dict.

new!(dict)

A variant of new/1 which returns t or raise if validation fails.

remove_broker_from_waiting_list(queue_name)
remove_locked_job(queue_name, job_key)
start_jobs_and_get_metrics(pid)
status(queue_name, job_id)
unlock_job_for_retry(queue_name, job_key)
update(s, dict)

Updates an existing instance of AntikytheraCore.AsyncJob.Queue with the given dict. The values in the dict are validated by each field's valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}.

update!(s, dict)

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

valid?(value)

Checks if the given value belongs to t/0 or not.

Types

Link to this type

t()

View Source 
@type t() :: %AntikytheraCore.AsyncJob.Queue{
  abandoned_jobs:
    Croma.TypeGen.ListOf.AntikytheraCore.AsyncJob.Queue.IdJobPair.t(),
  brokers_to_notify: Croma.TypeGen.ListOf.Croma.Pid.t(),
  brokers_waiting: Croma.TypeGen.ListOf.Croma.Pid.t(),
  index_runnable: AntikytheraCore.AsyncJob.Queue.SecondaryIndex.t(),
  index_running: AntikytheraCore.AsyncJob.Queue.SecondaryIndex.t(),
  index_waiting: AntikytheraCore.AsyncJob.Queue.SecondaryIndex.t(),
  jobs: AntikytheraCore.AsyncJob.Queue.JobsMap.t()
}

Functions

Link to this function

abandoned_jobs(queue)

View Source 
@spec abandoned_jobs(t()) ::
  Croma.TypeGen.ListOf.AntikytheraCore.AsyncJob.Queue.IdJobPair.t()

Type-aware getter for abandoned_jobs.

Link to this function

abandoned_jobs(s, field)

View Source 
@spec abandoned_jobs(
  t(),
  Croma.TypeGen.ListOf.AntikytheraCore.AsyncJob.Queue.IdJobPair.t()
) :: t()

Type-aware setter for abandoned_jobs.

Link to this function

add_job(queue_name, job_id, job, start_time_millis, now_millis)

View Source 
@spec add_job(
  atom(),
  Antikythera.AsyncJob.Id.t(),
  AntikytheraCore.AsyncJob.t(),
  pos_integer(),
  pos_integer()
) :: :ok | {:error, :full | :existing_id | {:rate_limit_reached, pos_integer()}}
Link to this function

brokers_to_notify(queue)

View Source 
@spec brokers_to_notify(t()) :: Croma.TypeGen.ListOf.Croma.Pid.t()

Type-aware getter for brokers_to_notify.

Link to this function

brokers_to_notify(s, field)

View Source 
@spec brokers_to_notify(t(), Croma.TypeGen.ListOf.Croma.Pid.t()) :: t()

Type-aware setter for brokers_to_notify.

Link to this function

brokers_waiting(queue)

View Source 
@spec brokers_waiting(t()) :: Croma.TypeGen.ListOf.Croma.Pid.t()

Type-aware getter for brokers_waiting.

Link to this function

brokers_waiting(s, field)

View Source 
@spec brokers_waiting(t(), Croma.TypeGen.ListOf.Croma.Pid.t()) :: t()

Type-aware setter for brokers_waiting.

Link to this function

cancel(queue_name, job_id)

View Source 
@spec cancel(atom(), Antikythera.AsyncJob.Id.t()) ::
  :ok | {:error, :not_found | {:rate_limit_reached, pos_integer()}}
Link to this function

fetch_job(queue_name)

View Source 
@spec fetch_job(atom()) ::
  nil
  | {AntikytheraCore.AsyncJob.Queue.JobKey.t(), AntikytheraCore.AsyncJob.t()}
Link to this function

index_runnable(queue)

View Source 
@spec index_runnable(t()) :: AntikytheraCore.AsyncJob.Queue.SecondaryIndex.t()

Type-aware getter for index_runnable.

Link to this function

index_runnable(s, field)

View Source 
@spec index_runnable(t(), AntikytheraCore.AsyncJob.Queue.SecondaryIndex.t()) :: t()

Type-aware setter for index_runnable.

Link to this function

index_running(queue)

View Source 
@spec index_running(t()) :: AntikytheraCore.AsyncJob.Queue.SecondaryIndex.t()

Type-aware getter for index_running.

Link to this function

index_running(s, field)

View Source 
@spec index_running(t(), AntikytheraCore.AsyncJob.Queue.SecondaryIndex.t()) :: t()

Type-aware setter for index_running.

Link to this function

index_waiting(queue)

View Source 
@spec index_waiting(t()) :: AntikytheraCore.AsyncJob.Queue.SecondaryIndex.t()

Type-aware getter for index_waiting.

Link to this function

index_waiting(s, field)

View Source 
@spec index_waiting(t(), AntikytheraCore.AsyncJob.Queue.SecondaryIndex.t()) :: t()

Type-aware setter for index_waiting.

Link to this function

jobs(queue)

View Source 
@spec jobs(t()) :: AntikytheraCore.AsyncJob.Queue.JobsMap.t()

Type-aware getter for jobs.

Link to this function

jobs(s, field)

View Source 
@spec jobs(t(), AntikytheraCore.AsyncJob.Queue.JobsMap.t()) :: t()

Type-aware setter for jobs.

Link to this function

list(queue_name)

View Source 
@spec list(atom()) :: [
  {Antikythera.Time.t(), Antikythera.AsyncJob.Id.t(),
   Antikythera.AsyncJob.StateLabel.t()}
]
Link to this function

make_rv_config(opts \\ [leader_hook_module: AntikytheraCore.AsyncJob.Queue.Hook, heartbeat_timeout: 1000, election_timeout: 5000, election_timeout_clock_drift_margin: 500])

View Source 
@spec make_rv_config(Keyword.t()) :: RaftedValue.Config.t()
Link to this function

max_jobs()

View Source
Link to this function

new(dict)

View Source 
@spec new(term()) :: Croma.Result.t(t())

Creates a new instance of AntikytheraCore.AsyncJob.Queue by using the given dict.

Returns {:ok, valid_struct} or {:error, reason}.

The values in the dict are validated by each field's valid?/1 function. If the value was invalid, it will be passed to new/1 of the field

For missing fields, followings will be tried:

  • default/0 of each field type
  • new/1 of each field type, with empty map as input
Link to this function

new!(dict)

View Source 
@spec new!(term()) :: t()

A variant of new/1 which returns t or raise if validation fails.

In other words, new/1 followed by Croma.Result.get!/1.

Link to this function

remove_broker_from_waiting_list(queue_name)

View Source 
@spec remove_broker_from_waiting_list(atom()) :: :ok
Link to this function

remove_locked_job(queue_name, job_key)

View Source 
@spec remove_locked_job(atom(), AntikytheraCore.AsyncJob.Queue.JobKey.t()) :: :ok
Link to this function

start_jobs_and_get_metrics(pid)

View Source 
@spec start_jobs_and_get_metrics(pid()) :: nil | tuple()
Link to this function

status(queue_name, job_id)

View Source 
@spec status(atom(), Antikythera.AsyncJob.Id.t()) ::
  Croma.Result.t(Antikythera.AsyncJob.Status.t())
Link to this function

unlock_job_for_retry(queue_name, job_key)

View Source 
@spec unlock_job_for_retry(atom(), AntikytheraCore.AsyncJob.Queue.JobKey.t()) :: :ok
Link to this function

update(s, dict)

View Source 
@spec update(t(), Dict.t()) :: Croma.Result.t(t())

Updates an existing instance of AntikytheraCore.AsyncJob.Queue with the given dict. The values in the dict are validated by each field's valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}.

Link to this function

update!(s, dict)

View Source 
@spec update!(t(), Dict.t()) :: t()

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

Link to this function

valid?(value)

View Source 
@spec valid?(term()) :: boolean()

Checks if the given value belongs to t/0 or not.