falood / queuex

Elixir Priority Queue

Queuex

Queuex is a Priority Queue.

These backends are supported:

1. List (Queuex.Backends.List)
2. Red-black tree (Queue.Backends.RedBlackTree)

Usage

1. Define your queue module.

defmodule MyQueue do
  use Queuex,
    max_num: 3,                 # (required, integer) max worker numbers
    worker: :my_worker,         # (required, atom) callback function
    backend:                    # (optional, Queuex.Backends.List(default) or Queuex.Backends.RedBlackTree) queue backend
    default_priority: 1,        # (optional, integer, default: 1) default priority for &MyQueue.push/1, smaller means high priority
    unique: false               # (optional, true or false(default) or :strictly) duplication term is allowned in queue. false => don't check, true => check with `backend.has_value?/2`, :strictly => check with `backend.has_priority_value?/3`

  def my_worker(term, _priority) do
    :timer.sleep(10000)
    term |> IO.inspect
  end
end

2. supervise your queue module

[ MyQueue.child_spec
  ... # your other supervisor or worker
] |> supervise strategy: :one_for_one

3. push term to queue

MyQueue.push(term, priority)
MyQueue.push(term) # push term with default priority

TODO

• Benchmark
• Document