TaskBunny

v0.3.4

TaskBunny v0.3.4 TaskBunny.Queue View Source

Convenience functions for accessing TaskBunny queues.

It’s a semi private module normally wrapped by other modules.

Sub Queues

When TaskBunny creates(declares) a queue on RabbitMQ, it also creates the following sub queues.

  • [queue-name].scheduled: holds jobs to be executed in the future
  • [queue-name].retry: holds jobs to be retried
  • [queue-name].rejected: holds jobs that were rejected (failed more than max retry times or wrong message format)

Link to this section Summary

Functions

declare_with_subqueues(host, work_queue)

Declares a queue with sub queues

delete_with_subqueues(host, work_queue)

Deletes the queue and its subqueues

queue_with_subqueues(work_queue)

Returns a list that contains the queue and its subqueue

rejected_queue(work_queue)

Returns a name of rejected queue

retry_queue(work_queue)

Returns a name of retry queue

scheduled_queue(work_queue)

Returns a name of scheduled queue

state(host_or_conn \\ :default, queue)

Returns the message count and consumer count for the given queue

subqueues(work_queue)

Returns all subqueues for the work queue

Link to this section Functions

Link to this function declare_with_subqueues(host, work_queue) View Source 
declare_with_subqueues(%AMQP.Connection{pid: term()} | atom(), String.t()) ::
  {map(), map(), map(), map()}

Declares a queue with sub queues.

Queue.declare_with_subqueues(:default, "normal_jobs")

For this call, the function creates(declares) three queues:

  • normal_jobs: a queue that holds jobs to process
  • normal_jobs.scheduled: a queue that holds jobs to process in the future
  • normal_jobs.retry: a queue that holds jobs failed and waiting to retry
  • normal_jobs.rejected: a queue that holds jobs failed and won’t be retried
Link to this function delete_with_subqueues(host, work_queue) View Source 
delete_with_subqueues(%AMQP.Connection{pid: term()} | atom(), String.t()) :: :ok

Deletes the queue and its subqueues.

Link to this function queue_with_subqueues(work_queue) View Source 
queue_with_subqueues(String.t()) :: [String.t()]

Returns a list that contains the queue and its subqueue.

Link to this function rejected_queue(work_queue) View Source 
rejected_queue(String.t()) :: String.t()

Returns a name of rejected queue.

Link to this function retry_queue(work_queue) View Source 
retry_queue(String.t()) :: String.t()

Returns a name of retry queue.

Link to this function scheduled_queue(work_queue) View Source 
scheduled_queue(String.t()) :: String.t()

Returns a name of scheduled queue.

Link to this function state(host_or_conn \\ :default, queue) View Source 
state(%AMQP.Connection{pid: term()} | atom(), String.t()) :: map()

Returns the message count and consumer count for the given queue.

Link to this function subqueues(work_queue) View Source 
subqueues(String.t()) :: [String.t()]

Returns all subqueues for the work queue.