From: Matt Mullins <mmullins@mmlx.us>
Date: Sun, 28 Aug 2011 20:00:30 +0000 (-0500)
Subject: Updated documentation on AMQP listener function.
X-Git-Tag: v5~19
X-Git-Url: http://git.mmlx.us/?a=commitdiff_plain;h=2114c08ae3a03bcb02fe9ba4ee1b6a09929ba445;p=erlbot.git

Updated documentation on AMQP listener function.
---

diff --git a/amqp/amqp_bot_listener.erl b/amqp/amqp_bot_listener.erl
index 8d24d8f..3fde833 100644
--- a/amqp/amqp_bot_listener.erl
+++ b/amqp/amqp_bot_listener.erl
@@ -14,6 +14,9 @@
 %% Currently, this creates the channel to use for this -- eventually, I would
 %% like to be able to support allowing the client to undo this action, but
 %% since we're throwing away the channel reference.
+%%
+%% Note this calls basic.consume with no_ack=true, so messages are
+%% automatically removed from the queue when they occur
 listen_for_events(RoutingKeyString) ->
     {ok, Channel} = amqp_bot_connection:open_channel(),
     RoutingKeyBinary = list_to_binary(RoutingKeyString),