summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Klishin <michael@rabbitmq.com>2015-02-03 16:25:26 +0300
committerMichael Klishin <michael@rabbitmq.com>2015-02-03 16:25:26 +0300
commit2accfbf8d0a1b58cda4002f362ee5df950833cc7 (patch)
treed306ab5da1c4767036d3b14ef8efebcb410404cb
parent7195b27b40ed7f206e936eaf1730b035e8f4dcca (diff)
downloadrabbitmq-server-git-2accfbf8d0a1b58cda4002f362ee5df950833cc7.tar.gz
Documentation overview of lqueue
-rw-r--r--src/lqueue.erl4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/lqueue.erl b/src/lqueue.erl
index 62f60d5ffb..b727467fb9 100644
--- a/src/lqueue.erl
+++ b/src/lqueue.erl
@@ -16,6 +16,10 @@
-module(lqueue).
+%% lqueue implements a subset of Erlang's queue module. lqueues
+%% maintain their own length and thus can avoid queue:len/1
+%% calls which can be very expensive.
+
-export([new/0, is_empty/1, len/1, in/2, in_r/2, out/1, out_r/1, join/2,
foldl/3, foldr/3, from_list/1, to_list/1, peek/1, peek_r/1]).