Honeydew.Queue behaviour (honeydew v1.5.0) View Source

Link to this section Summary

Types

args()

filter()

job()

name()

private()

Functions

ack(queue_process, job)

cancel(queue_process, job)

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

child_spec(name, args)

dispatch(state)

do_ack(job, state)

do_nack(job, state)

do_worker_not_ready(worker, state)

do_worker_ready(worker, state)

enqueue(queue_process, job)

filter(queue_process, filter)

job_monitor_crashed(job_monitor, reason, state)

job_monitor_stopped(job_monitor, state)

nack(queue_process, job)

node_down(node)

node_up(queue, node)

resume(queue_process)

start_link(opts)

status(queue_process, opts)

suspend(queue_process)

worker_crashed(worker, reason, state)

worker_not_ready(queue_process)

worker_ready(queue_process)

worker_stopped(worker, state)

Callbacks

ack(job, private)

cancel(job, private)

enqueue(job, private)

filter(private, filter)

handle_call(request, arg2, state)

handle_cast(request, state)

handle_info(msg, state)

init(name, args)

nack(job, private)

reserve(private)

rewrite_opts(args)

status(private)

validate_args!(args)

Link to this section Types

args()

Specs

args() :: list()

filter()

Specs

filter() :: Honeydew.filter()

job()

Specs

job() :: Honeydew.Job.t()

name()

Specs

name() :: Honeydew.queue_name()

private()

Specs

private() :: term()

Link to this section Functions

ack(queue_process, job)

cancel(queue_process, job)

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

child_spec(name, args)

Specs

child_spec(name(), [any()]) :: Supervisor.child_spec()

dispatch(state)

do_ack(job, state)

do_nack(job, state)

do_worker_not_ready(worker, state)

do_worker_ready(worker, state)

enqueue(queue_process, job)

filter(queue_process, filter)

job_monitor_crashed(job_monitor, reason, state)

job_monitor_stopped(job_monitor, state)

nack(queue_process, job)

node_down(node)

node_up(queue, node)

resume(queue_process)

start_link(opts)

status(queue_process, opts)

suspend(queue_process)

worker_crashed(worker, reason, state)

worker_not_ready(queue_process)

worker_ready(queue_process)

worker_stopped(worker, state)

Link to this section Callbacks

ack(job, private)

Specs

ack(job(), private()) :: private()

cancel(job, private)

Specs

cancel(job(), private()) ::
  {:ok | {:error, :in_progress | :not_found}, private()}

enqueue(job, private)

Specs

enqueue(job(), private()) :: {private(), job()}

filter(private, filter)

Specs

filter(private(), filter()) :: [job()]

handle_call(request, arg2, state)

(optional)

Specs

handle_call(request :: term(), GenServer.from(), state :: private()) ::
  {:reply, reply, new_state}
  | {:reply, reply, new_state, timeout() | :hibernate}
  | {:noreply, new_state}
  | {:noreply, new_state, timeout() | :hibernate}
  | {:stop, reason, reply, new_state}
  | {:stop, reason, new_state}
when reply: term(), new_state: private(), reason: term()

handle_cast(request, state)

(optional)

Specs

handle_cast(request :: term(), state :: private()) ::
  {:noreply, new_state}
  | {:noreply, new_state, timeout() | :hibernate}
  | {:stop, reason :: term(), new_state}
when new_state: private()

handle_info(msg, state)

(optional)

Specs

handle_info(msg :: :timeout | term(), state :: private()) ::
  {:noreply, new_state}
  | {:noreply, new_state, timeout() | :hibernate}
  | {:stop, reason :: term(), new_state}
when new_state: private()

init(name, args)

Specs

init(name(), args()) :: {:ok, private()}

nack(job, private)

Specs

nack(job(), private()) :: private()

reserve(private)

Specs

reserve(private()) :: {job(), private()}

rewrite_opts(args)

(optional)

Specs

rewrite_opts(args()) :: args()

status(private)

Specs

status(private()) :: %{
  :count => number(),
  :in_progress => number(),
  optional(atom()) => any()
}

validate_args!(args)

Specs

validate_args!(args()) :: :ok