[libanyevent-rabbitmq-perl] 70/151: Some more docs

[Damyan Ivanov]

This is an automated email from the git hooks/post-receive script.

dmn pushed a commit to annotated tag debian/1.12-1
in repository libanyevent-rabbitmq-perl.

commit 65ca04752dad3a2353f83a1a9159e44765b33ca2
Author: Tomas Doran <bobtfish at bobtfish.net>
Date:   Wed Feb 2 10:00:52 2011 +0000

    Some more docs
---
 lib/AnyEvent/RabbitMQ/Channel.pm | 46 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)

diff --git a/lib/AnyEvent/RabbitMQ/Channel.pm b/lib/AnyEvent/RabbitMQ/Channel.pm
index 70079e1..adb7f36 100644
--- a/lib/AnyEvent/RabbitMQ/Channel.pm
+++ b/lib/AnyEvent/RabbitMQ/Channel.pm
@@ -733,8 +733,54 @@ The name of the exchange
 
 =head2 consume
 
+Subscribe to consume messages from a queue.
+
+Arguments:
+
+=over
+
+=item on_consume
+
+Callback called with an argument of the message which has been consumed.
+
+=item consumer_tag
+
+Identifies this consumer, will be auto-generated if you do not provide it, but you must
+supply a value if you want to be able to later cancel the subscription.
+
+=item on_success
+
+Callback called if the subscription was successfull (before the first message is consumed).
+
+=item on_failure
+
+Callback called if the subscription fails for any reason.
+
+=back
+
 =head2 cancel
 
+Cancel a queue subscription.
+
+Note that the cancellation B<will not> take place at once, and further messages may be
+consumed before the subscription is cancelled. No further messages will be
+consumed after the on_success callback has been called.
+
+Arguments:
+
+=item consumer_tag
+
+Identifies this consumer, needs to be the value supplied when the queue is initially
+consumed from.
+
+=item on_success
+
+Callback called if the subscription was successfully cancelled.
+
+=item on_failure
+
+Callback called if the subscription could not be cancelled for any reason.
+
 =head2 get
 
 Try to get a single message from a queue.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libanyevent-rabbitmq-perl.git