Packages

epqueue

1.2.1
1.2.7 1.2.6 1.2.5 1.2.4 1.2.3 1.2.2 1.2.1 1.2.0

Erlang Priority Queue

HexDocs

Current section

Files

Jump to
Readme
8 Versions
0 Dependencies
Dependants
Files
Activity
epqueue src epqueue.erl
Raw

src/epqueue.erl 

-module(epqueue).



-export([

    new/0,

    new/1,

    size/1,

    insert/3,

    remove/2,

    pop/1,

    peek/1

]).



-type error() :: badarg | {error, binary()}.

-type queue_option() :: {global_lock, boolean()}.

-type priority() :: non_neg_integer().

-type data() :: any().

-type queue_ref() :: reference().

-type data_ref() :: reference().



-spec new() ->

    {ok, queue_ref()} | error().



new() ->

    epqueue_nif:new([]).



-spec new([queue_option()]) ->

    {ok, queue_ref()} | error().



new(Options) ->

    epqueue_nif:new(Options).



-spec size(queue_ref()) ->

    non_neg_integer() | badarg.



size(QueueRef) ->

    epqueue_nif:size(QueueRef).



-spec insert(queue_ref(), data(), priority()) ->

    {ok, data_ref()} | error().



insert(QueueRef, Data, Priority) ->

    epqueue_nif:insert(QueueRef, Data, Priority).



-spec remove(queue_ref(), data_ref()) ->

    boolean() | error().



remove(QueueRef, Ref) ->

    epqueue_nif:remove(QueueRef, Ref).



-spec pop(queue_ref()) ->

    {ok, data(), priority()} | error().



pop(QueueRef) ->

    epqueue_nif:pop(QueueRef).



-spec peek(queue_ref()) ->

    {ok, data(), priority()} | error().



peek(QueueRef) ->

    epqueue_nif:peek(QueueRef).