summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatthias Radestock <matthias@lshift.net>2010-02-02 15:35:59 +0000
committerMatthias Radestock <matthias@lshift.net>2010-02-02 15:35:59 +0000
commitb2b6200f753c96c79e2ae53b2ce1a9d42f6bbdd9 (patch)
treef4d1dbdcac44f92f1306d699af6cc4e8854dc76a /docs
parent3dec42150daa769a118eba7358b5eca73b3d6554 (diff)
parentff5f2a0169cc98414a2509b11088bcf0b496b66f (diff)
downloadrabbitmq-server-git-b2b6200f753c96c79e2ae53b2ce1a9d42f6bbdd9.tar.gz
drag in code from bug21966
since we need the ability to find all channels
Diffstat (limited to 'docs')
-rw-r--r--docs/rabbitmqctl.1.pod55
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/rabbitmqctl.1.pod b/docs/rabbitmqctl.1.pod
index 47c4d16860..b82d5b87f4 100644
--- a/docs/rabbitmqctl.1.pod
+++ b/docs/rabbitmqctl.1.pod
@@ -367,6 +367,61 @@ send queue size
=back
+=over
+
+=item list_channels [I<channelinfoitem> ...]
+
+List channel information. Each line printed describes a channel, with
+the requested I<channelinfoitem> values separated by tab characters.
+If no I<channelinfoitem>s are specified then I<pid>, I<user>,
+I<transactional>, I<consumer_count>, and I<messages_unacknowledged>
+are assumed.
+
+The list includes channels which are part of ordinary AMQP connections
+(as listed by list_connections) and channels created by various
+plug-ins and other extensions.
+
+=back
+
+=head3 Channel information items
+
+=over
+
+=item pid
+
+id of the Erlang process associated with the channel
+
+=item connection
+
+id of the Erlang process associated with the connection to which the
+channel belongs
+
+=item user
+
+username associated with the channel
+
+=item vhost
+
+virtual host in which the channel operates
+
+=item transactional
+
+true if the channel is in transactional mode, false otherwise
+
+=item consumer_count
+
+number of logical AMQP consumers retrieving messages via the channel
+
+=item messages_unacknowledged
+
+number of messages delivered via this channel but not yet acknowledged
+
+=item prefetch_count
+
+QoS prefetch count limit in force, 0 if unlimited
+
+=back
+
The list_queues, list_exchanges and list_bindings commands accept an
optional virtual host parameter for which to display results,
defaulting to I<"/">. The default can be overridden with the B<-p>