Author: kwall
Date: Mon Jun 8 10:10:41 2015
New Revision: 1684141
URL: http://svn.apache.org/r1684141
Log:
QPID-6575 : [Java Broker Documentation] Document
consumer.suspendNotificationPeriod context var
Added:
qpid/java/trunk/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Consumers.xml
Modified:
qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Management-Managing-Entities.xml
Modified:
qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
URL:
http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml?rev=1684141&r1=1684140&r2=1684141&view=diff
==============================================================================
---
qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
(original)
+++
qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
Mon Jun 8 10:10:41 2015
@@ -931,13 +931,16 @@
</row>
<row id="Java-Broker-Appendix-Operation-Logging-Message-SUB-1003">
<entry morerows="1">SUB-1003</entry>
- <entry>State : <replaceable>boolean</replaceable></entry>
+ <entry>SUB-1003 : Suspended for <replaceable>time</replaceable>
ms</entry>
</row>
<row>
<entry>
- <para>Indicates that a subscription has changed state. This occurs
when the consumer is
- ready to receive more messages. As this happens frequently in
normal operation, this
- log messages is disabled by default.</para>
+ <para>Indicates that a subscription has been in a suspened state
for an unusual length
+ of time. This may be indicative of an consuming application
that has stopped taking
+ messages from the consumer (i.e. a JMS application is not
calling receive() or its
+ asynchronous message listener onMessage() is block in
application code). It may also
+ indicate a generally overloaded system.
+ </para>
</entry>
</row>
Modified:
qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Management-Managing-Entities.xml
URL:
http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Management-Managing-Entities.xml?rev=1684141&r1=1684140&r2=1684141&view=diff
==============================================================================
---
qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Management-Managing-Entities.xml
(original)
+++
qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Management-Managing-Entities.xml
Mon Jun 8 10:10:41 2015
@@ -101,6 +101,8 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="management/managing/Java-Broker-Management-Managing-Queues.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
+ href="management/managing/Java-Broker-Management-Managing-Consumers.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="management/managing/Java-Broker-Management-Managing-Ports.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="management/managing/Java-Broker-Management-Managing-Authentication-Providers.xml"/>
Added:
qpid/java/trunk/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Consumers.xml
URL:
http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Consumers.xml?rev=1684141&view=auto
==============================================================================
---
qpid/java/trunk/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Consumers.xml
(added)
+++
qpid/java/trunk/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Consumers.xml
Mon Jun 8 10:10:41 2015
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+<section id="Java-Broker-Management-Managing-Consumers">
+ <title>Consumers</title>
+ <para>A Consumer represents an application's live
<emphasis>subcription</emphasis> to a queue. Its presence
+ in the model indicates that an application is currently connected to the
queue <emphasis>at this moment</emphasis>.
+ </para>
+ <section id="Java-Broker-Management-Managing-Consumers-Context">
+ <title>Context</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis>consumer.suspendNotificationPeriod</emphasis>
Governs the length of
+ time that a consumer may remain suspended before the the Broker
begins to
+ produce <link
linkend="Java-Broker-Appendix-Operation-Logging-Message-SUB-1003">SUB-1003</link>
+ operational log messages.</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
