You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by or...@apache.org on 2017/03/03 16:47:33 UTC
svn commit: r1785348 - in /qpid/java/trunk:
broker-plugins/management-http/src/main/java/resources/
broker-plugins/management-http/src/main/java/resources/js/qpid/management/
doc/java-broker/src/docbkx/ doc/java-broker/src/docbkx/concepts/
doc/java-bro...
Author: orudyy
Date: Fri Mar 3 16:47:33 2017
New Revision: 1785348
URL: http://svn.apache.org/viewvc?rev=1785348&view=rev
Log:
QPID-7618: Address review comments from Keith Wall
Added:
qpid/java/trunk/doc/java-broker/src/docbkx/Java-Broker-Appendix-Queue-Declaration-Arguments.xml
Modified:
qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/addQueue.html
qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/editQueue.html
qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/js/qpid/management/Queue.js
qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/showMessage.html
qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/showQueue.html
qpid/java/trunk/doc/java-broker/src/docbkx/AMQP-Messaging-Broker-Java-Book.xml
qpid/java/trunk/doc/java-broker/src/docbkx/Java-Broker-Appendix-Operational-Logging-Messages.xml
qpid/java/trunk/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Queues.xml
qpid/java/trunk/doc/java-broker/src/docbkx/management/managing/Java-Broker-Management-Managing-Queues.xml
Modified: qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/addQueue.html
URL: http://svn.apache.org/viewvc/qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/addQueue.html?rev=1785348&r1=1785347&r2=1785348&view=diff
==============================================================================
--- qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/addQueue.html (original)
+++ qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/addQueue.html Fri Mar 3 16:47:33 2017
@@ -173,15 +173,15 @@
</div>
</div>
<div class="clear">
- <div class="formLabel-labelCell">Maximum Queue Depth including headers (Bytes):</div>
+ <div class="formLabel-labelCell">Maximum Queue Depth (Bytes):</div>
<div class="formLabel-controlCell">
<input type="text" id="formAddQueue.maximumQueueDepthBytes"
data-dojo-type="dijit/form/ValidationTextBox"
data-dojo-props="
name: 'maximumQueueDepthBytes',
placeHolder: 'maximum number of bytes including headers',
- promptMessage: 'Maximum number of bytes (including header) in the queue',
- title: 'Enter the maximum number of bytes (including header) in the queue',
+ promptMessage: 'Maximum number of bytes (including headers) in the queue',
+ title: 'Enter the maximum number of bytes (including headers) in the queue',
trim: true"/>
</div>
</div>
@@ -189,6 +189,8 @@
<div class="clear"></div>
</div>
+ <div class="clear formBox">
+ <fieldset>
<div class="clear">
<div class="formLabel-labelCell">Maximum Ttl:</div>
<div class="formLabel-controlCell">
@@ -215,6 +217,9 @@
trim: true"/>
</div>
</div>
+ <div class="clear"></div>
+ </fieldset>
+ </div>
<div class="clear formBox">
<fieldset>
Modified: qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/editQueue.html
URL: http://svn.apache.org/viewvc/qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/editQueue.html?rev=1785348&r1=1785347&r2=1785348&view=diff
==============================================================================
--- qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/editQueue.html (original)
+++ qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/editQueue.html Fri Mar 3 16:47:33 2017
@@ -167,15 +167,15 @@
</div>
</div>
<div class="clear">
- <div class="formLabel-labelCell">Maximum Queue Depth including headers (Bytes):</div>
+ <div class="formLabel-labelCell">Maximum Queue Depth (Bytes):</div>
<div class="formLabel-controlCell">
<input type="text" id="formEditQueue.maximumQueueDepthBytes"
data-dojo-type="dijit/form/ValidationTextBox"
data-dojo-props="
name: 'maximumQueueDepthBytes',
placeHolder: 'maximum number of bytes',
- promptMessage: 'Maximum number of bytes (including header) in the queue',
- title: 'Enter the maximum number of bytes (including header) in the queue',
+ promptMessage: 'Maximum number of bytes (including headers) in the queue',
+ title: 'Enter the maximum number of bytes (including headers) in the queue',
trim: true"/>
</div>
</div>
@@ -183,6 +183,8 @@
<div class="clear"></div>
</div>
+ <div class="clear formBox">
+ <fieldset>
<div class="clear">
<div class="formLabel-labelCell">Maximum Ttl:</div>
<div class="formLabel-controlCell">
@@ -211,6 +213,8 @@
</div>
<div class="clear"></div>
+ </fieldset>
+ </div>
<div class="clear formBox">
<fieldset>
Modified: qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/js/qpid/management/Queue.js
URL: http://svn.apache.org/viewvc/qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/js/qpid/management/Queue.js?rev=1785348&r1=1785347&r2=1785348&view=diff
==============================================================================
--- qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/js/qpid/management/Queue.js (original)
+++ qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/js/qpid/management/Queue.js Fri Mar 3 16:47:33 2017
@@ -144,7 +144,7 @@ define(["dojo/_base/declare",
autoHeight: 10,
keepSelection: true,
structure: [{
- name: "Size",
+ name: "Payload Size",
field: "size",
width: "40%"
}, {
@@ -404,9 +404,6 @@ define(["dojo/_base/declare",
"messageGroups",
"messageGroupKey",
"messageGroupSharedGroups",
- "queueDepthMessages",
- "queueDepthBytes",
- "queueDepthBytesUnits",
"queueDepthMessagesIncludingHeader",
"queueDepthBytesIncludingHeader",
"queueDepthBytesUnitsIncludingHeader",
@@ -458,7 +455,7 @@ define(["dojo/_base/declare",
}
- function renderMaximumQueueDepth(value)
+ function renderMaximumQueueDepth(value, bytes)
{
if (util.isInteger(value))
{
@@ -466,7 +463,14 @@ define(["dojo/_base/declare",
{
return "<unlimited>";
}
- return new String(value);
+ if (bytes)
+ {
+ var formatted = formatter.formatBytes(value);
+
+ return formatted.value + " " + formatted.units;
+ }
+
+ return new String(value) + " msgs";
}
return "";
}
@@ -488,11 +492,6 @@ define(["dojo/_base/declare",
this.alternateExchange.innerHTML =
this.queueData["alternateExchange"] ? entities.encode(String(this.queueData["alternateExchange"])) : "";
- this.queueDepthMessages.innerHTML = entities.encode(String(this.queueData["queueDepthMessages"]));
- bytesDepth = formatter.formatBytes(this.queueData["queueDepthBytes"]);
- this.queueDepthBytes.innerHTML = "(" + bytesDepth.value;
- this.queueDepthBytesUnits.innerHTML = bytesDepth.units + ")";
-
this.queueDepthMessagesIncludingHeader.innerHTML = entities.encode(String(this.queueData["queueDepthMessages"]));
bytesDepth = formatter.formatBytes(this.queueData["queueDepthBytesIncludingHeader"]);
this.queueDepthBytesIncludingHeader.innerHTML = "(" + bytesDepth.value;
@@ -515,8 +514,8 @@ define(["dojo/_base/declare",
}
this["overflowPolicy"].innerHTML = entities.encode(this.queueData["overflowPolicy"]);
- this["maximumQueueDepthBytes"].innerHTML = renderMaximumQueueDepth(this.queueData.maximumQueueDepthBytes);
- this["maximumQueueDepthMessages"].innerHTML = renderMaximumQueueDepth(this.queueData.maximumQueueDepthMessages);
+ this["maximumQueueDepthBytes"].innerHTML = renderMaximumQueueDepth(this.queueData.maximumQueueDepthBytes, true);
+ this["maximumQueueDepthMessages"].innerHTML = renderMaximumQueueDepth(this.queueData.maximumQueueDepthMessages, false);
if (this.queueData["messageGroupKey"])
{
this.messageGroupKey.innerHTML = entities.encode(String(this.queueData["messageGroupKey"]));
Modified: qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/showMessage.html
URL: http://svn.apache.org/viewvc/qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/showMessage.html?rev=1785348&r1=1785347&r2=1785348&view=diff
==============================================================================
--- qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/showMessage.html (original)
+++ qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/showMessage.html Fri Mar 3 16:47:33 2017
@@ -31,7 +31,7 @@
<td><span class="message-id"></span></td>
</tr>
<tr style="margin-bottom: 4pt">
- <td style="width: 10em; vertical-align: top"><span style="font-weight: bold;">Size:</span></td>
+ <td style="width: 10em; vertical-align: top"><span style="font-weight: bold;">Payload Size:</span></td>
<td><span class="message-size"></span> bytes</td>
</tr>
<tr style="margin-bottom: 4pt">
Modified: qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/showQueue.html
URL: http://svn.apache.org/viewvc/qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/showQueue.html?rev=1785348&r1=1785347&r2=1785348&view=diff
==============================================================================
--- qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/showQueue.html (original)
+++ qpid/java/trunk/broker-plugins/management-http/src/main/java/resources/showQueue.html Fri Mar 3 16:47:33 2017
@@ -53,12 +53,11 @@
<div class="overflowPolicy formValue-valueCell"></div>
</div>
<div class="clear">
- <div class="formLabel-labelCell">Maximum Queue Depth (Messages):</div>
- <div class="maximumQueueDepthMessages formValue-valueCell"></div>
- </div>
- <div class="clear">
- <div class="formLabel-labelCell">Maximum Queue Depth including headers (Bytes):</div>
- <div class="maximumQueueDepthBytes formValue-valueCell"></div>
+ <div class="formLabel-labelCell">Maximum Queue Depth:</div>
+ <div class="formValue-valueCell">
+ <span class="maximumQueueDepthMessages"></span>
+ (<span class="maximumQueueDepthBytes"></span>)
+ </div>
</div>
</div>
<div class="alignRight">
@@ -81,16 +80,7 @@
</div>
</div>
<div class="clear">
- <div class="formLabel-labelCell">Size:</div>
- <div class="formValue-valueCell">
- <span class="queueDepthMessages"></span>
- <span> msgs</span>
- <span class="queueDepthBytes">(</span>
- <span class="queueDepthBytesUnits">)</span>
- </div>
- </div>
- <div class="clear">
- <div class="formLabel-labelCell">Size including header:</div>
+ <div class="formLabel-labelCell">Queue Depth:</div>
<div class="formValue-valueCell">
<span class="queueDepthMessagesIncludingHeader"></span>
<span> msgs</span>
Modified: qpid/java/trunk/doc/java-broker/src/docbkx/AMQP-Messaging-Broker-Java-Book.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/java-broker/src/docbkx/AMQP-Messaging-Broker-Java-Book.xml?rev=1785348&r1=1785347&r2=1785348&view=diff
==============================================================================
--- qpid/java/trunk/doc/java-broker/src/docbkx/AMQP-Messaging-Broker-Java-Book.xml (original)
+++ qpid/java/trunk/doc/java-broker/src/docbkx/AMQP-Messaging-Broker-Java-Book.xml Fri Mar 3 16:47:33 2017
@@ -39,4 +39,5 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-Operational-Logging-Messages.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-Queue-Alerts.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-Miscellaneous.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-Queue-Declaration-Arguments.xml"/>
</book>
Modified: qpid/java/trunk/doc/java-broker/src/docbkx/Java-Broker-Appendix-Operational-Logging-Messages.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/java-broker/src/docbkx/Java-Broker-Appendix-Operational-Logging-Messages.xml?rev=1785348&r1=1785347&r2=1785348&view=diff
==============================================================================
--- qpid/java/trunk/doc/java-broker/src/docbkx/Java-Broker-Appendix-Operational-Logging-Messages.xml (original)
+++ qpid/java/trunk/doc/java-broker/src/docbkx/Java-Broker-Appendix-Operational-Logging-Messages.xml Fri Mar 3 16:47:33 2017
@@ -604,22 +604,49 @@
</row>
<row xml:id="Java-Broker-Appendix-Operation-Logging-Message-QUE-1003">
<entry morerows="1">QUE-1003</entry>
- <entry>Overfull : Size : <replaceable>size</replaceable> bytes, Capacity :
- <replaceable>maximumsize</replaceable></entry>
+ <entry>
+ Overfull : Size : <replaceable>size in bytes</replaceable>, Capacity : <replaceable>resumesize in bytes</replaceable>,
+ Messages : <replaceable>size in messages</replaceable>, Message Capacity : <replaceable>resumesize in messages</replaceable>
+ </entry>
</row>
<row>
<entry>
- <para>Indicates that a queue has exceeded its permitted capacity. See <xref linkend="Qpid-Producer-Flow-Control"/> for details.</para>
+ <para>Indicates that a queue has exceeded its permitted capacity when
+ <emphasis>Producer Flow Control</emphasis> overflow policy is used.
+ See <xref linkend="Java-Broker-Concepts-Queue-OverflowPolicy"/> for details.</para>
</entry>
</row>
<row xml:id="Java-Broker-Appendix-Operation-Logging-Message-QUE-1004">
<entry morerows="1">QUE-1004</entry>
- <entry>Underfull : Size : <replaceable>size</replaceable> bytes, Resume Capacity :
- <replaceable>resumesize</replaceable></entry>
+ <entry>
+ Underfull : Size : <replaceable>size in bytes</replaceable>, Capacity : <replaceable>resumesize in bytes</replaceable>,
+ Messages : <replaceable>size in messages</replaceable>, Message Capacity : <replaceable>resumesize in messages</replaceable>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ Indicates that a queue has fallen to its resume capacity when
+ <emphasis>Producer Flow Control</emphasis> overflow policy is used.
+ See <xref linkend="Java-Broker-Concepts-Queue-OverflowPolicy"/> for details.
+ </para>
+ </entry>
+ </row>
+ <row xml:id="Java-Broker-Appendix-Operation-Logging-Message-QUE-1004">
+ <entry morerows="1">QUE-1005</entry>
+ <entry>
+ Dropped : <replaceable>number</replaceable> messages, Depth : <replaceable>size</replaceable> bytes,
+ <replaceable>size</replaceable> messages, Capacity : <replaceable>limit</replaceable> bytes,
+ <replaceable>limit</replaceable> messages
+ </entry>
</row>
<row>
<entry>
- <para>Indicates that a queue has fallen to its resume capacity. See <xref linkend="Qpid-Producer-Flow-Control"/> for details.</para>
+ <para>
+ Indicates that a given number of messages is deleted when <emphasis>Ring</emphasis> overflow policy is
+ used and any of queue capacity limits is breached .
+ See <xref linkend="Java-Broker-Concepts-Queue-OverflowPolicy"/> for details.
+ </para>
</entry>
</row>
<row xml:id="Java-Broker-Appendix-Operation-Logging-Message-QUE-1014">
@@ -873,7 +900,8 @@
<entry>
<para>Indicates that producer flow control has been imposed on a channel owning to
excessive queue depth in the indicated queue. Produces using the channel will be
- requested to pause the sending of messages. See <xref linkend="Qpid-Producer-Flow-Control"/> for more details.</para>
+ requested to pause the sending of messages.
+ See <xref linkend="Java-Broker-Concepts-Queue-OverflowPolicy"/> for more details.</para>
</entry>
</row>
<row xml:id="Java-Broker-Appendix-Operation-Logging-Message-CHN-1006">
@@ -882,7 +910,8 @@
</row>
<row>
<entry>
- <para>Indicates that producer flow control has been removed from a channel. See <xref linkend="Qpid-Producer-Flow-Control"/> for more details.</para>
+ <para>Indicates that producer flow control has been removed from a channel.
+ See <xref linkend="Java-Broker-Concepts-Queue-OverflowPolicy"/> for more details.</para>
</entry>
</row>
<row xml:id="Java-Broker-Appendix-Operation-Logging-Message-CHN-1007">
@@ -1100,7 +1129,8 @@
</row>
<row>
<entry>
- <para>The store has breached is maximum configured size. See <xref linkend="Qpid-Producer-Flow-Control"/> for details.</para>
+ <para>The store has breached is maximum configured size.
+ See <xref linkend="Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control"/> for details.</para>
</entry>
</row>
<row xml:id="Java-Broker-Appendix-Operation-Logging-Message-MST-1009">
@@ -1110,8 +1140,8 @@
<row>
<entry>
<para>The store size has fallen beneath its resume capacity and therefore flow control
- has been rescinded. See <xref linkend="Qpid-Producer-Flow-Control"/> for
- details.</para>
+ has been rescinded. See <xref linkend="Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control"/>
+ for details. </para>
</entry>
</row>
</tbody>
Added: qpid/java/trunk/doc/java-broker/src/docbkx/Java-Broker-Appendix-Queue-Declaration-Arguments.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/java-broker/src/docbkx/Java-Broker-Appendix-Queue-Declaration-Arguments.xml?rev=1785348&view=auto
==============================================================================
--- qpid/java/trunk/doc/java-broker/src/docbkx/Java-Broker-Appendix-Queue-Declaration-Arguments.xml (added)
+++ qpid/java/trunk/doc/java-broker/src/docbkx/Java-Broker-Appendix-Queue-Declaration-Arguments.xml Fri Mar 3 16:47:33 2017
@@ -0,0 +1,126 @@
+<?xml version="1.0"?>
+<!--
+ ~ 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.
+ -->
+
+<appendix xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Appendix-Queue-Declare-Arguments">
+ <title>Queue Declaration Arguments supported by the Broker</title>
+ <para>
+ <emphasis>Qpid Broker for Java</emphasis>
+ supports a number of custom arguments which can be specified as part of <emphasis>queue.declare</emphasis>
+ commands for AMQP 0.x protocols. This section provides an overview of the supported arguments.
+ </para>
+ <table pgwide="1" xml:id="Java-Broker-Appendix-Supported-Queue-Declare-Arguments">
+ <title>Queue declare arguments</title>
+ <tgroup cols="2">
+ <colspec colnum="1" colname="col1"/>
+ <colspec colnum="2" colname="col2"/>
+ <spanspec spanname="both" namest="col1" nameend="col2"/>
+ <thead>
+ <row>
+ <entry>Argument Name</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row xml:id="Java-Broker-Appendix-Queue-Declare-Arguments-Overflow-Policy">
+ <entry spanname="both">
+ <para>Declaration of overflow policy.
+ See
+ <xref linkend="Java-Broker-Concepts-Queue-OverflowPolicy"/>
+ for more details.
+ </para>
+ </entry>
+ </row>
+ <row xml:id="Java-Broker-Appendix-Queue-Declare-Arguments-Policy-Type">
+ <entry>
+ <para>qpid.policy_type</para>
+ </entry>
+ <entry>
+ <para>Defines queue overflow policy.</para>
+ </entry>
+ </row>
+ <row xml:id="Java-Broker-Appendix-Queue-Declare-Arguments-Max-Count">
+ <entry>
+ <para>qpid.max_count</para>
+ </entry>
+ <entry>
+ <para>Defines <emphasis>maximum number of messages</emphasis>.
+ </para>
+ </entry>
+ </row>
+ <row xml:id="Java-Broker-Appendix-Queue-Declare-Arguments-Max-Size">
+ <entry>
+ <para>qpid.max_size</para>
+ </entry>
+ <entry>
+ <para>Defines <emphasis>maximum number of bytes</emphasis>.
+ </para>
+ </entry>
+ </row>
+ <row>
+ <entry spanname="both">
+ <para>The <emphasis>Overflow Policy</emphasis> and the limits can be specified using
+ <emphasis>Address</emphasis>
+ based syntax as in the example below:
+ <screen><![CDATA[
+my-queue; {create: always, node: {x-declare: {arguments:{'qpid.max_count': 10000, 'qpid.max_size': 102400, 'qpid.policy_type: 'ring'}}}}
+]]></screen>
+ </para>
+ </entry>
+ </row>
+ <row xml:id="Java-Broker-Appendix-Queue-Declare-Arguments-Overflow-Policy-Producer-Flow-Control">
+ <entry spanname="both">
+ <para>Alternative declaration of <emphasis>Producer Flow Control</emphasis> overflow policy.
+ See
+ <xref linkend="Java-Broker-Concepts-Queue-OverflowPolicy"/>
+ for more details.
+ </para>
+ </entry>
+ </row>
+ <row xml:id="Java-Broker-Appendix-Queue-Declare-Arguments-Capacity">
+ <entry>
+ <para>x-qpid-capacity</para>
+ </entry>
+ <entry>
+ <para>Defines <emphasis>maximum number of bytes</emphasis>.
+ </para>
+ </entry>
+ </row>
+ <row xml:id="Java-Broker-Appendix-Queue-Declare-Arguments-Flow-Resume-Capacity">
+ <entry>
+ <para>x-qpid-flow-resume-capacity</para>
+ </entry>
+ <entry>
+ <para>Defines flow resume threshold in bytes</para>
+ </entry>
+ </row>
+ <row>
+ <entry spanname="both">
+ <para>The <emphasis>Producer Flow Control</emphasis> can be specified using
+ <emphasis>Address</emphasis> based syntax as in the example below:
+ <screen><![CDATA[
+my-queue; {create: always, node: {x-declare: {arguments:{'x-qpid-capacity': 102400, 'x-qpid-flow-resume-capacity': 8192000}}}}
+]]></screen>
+ </para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+</appendix>
Modified: qpid/java/trunk/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Queues.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Queues.xml?rev=1785348&r1=1785347&r2=1785348&view=diff
==============================================================================
--- qpid/java/trunk/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Queues.xml (original)
+++ qpid/java/trunk/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Queues.xml Fri Mar 3 16:47:33 2017
@@ -382,7 +382,7 @@ amqp://guest:guest@client1/development?m
<emphasis>Overflow Policy</emphasis>
can be configured on an individual <emphasis>Queue</emphasis> to limit the queue capacity.
The capacity limits can be specified as a <emphasis>maximum number of bytes</emphasis> or
- <emphasis>maximum number of messages</emphasis> on a <emphasis>Queue</emphasis>.
+ <emphasis>maximum number of messages</emphasis> or both.
The <emphasis>Overflow Policy</emphasis> defines the Queue behaviour when any of the limits is reached.
</para>
<para>
@@ -424,65 +424,14 @@ amqp://guest:guest@client1/development?m
<varname>maximumQueueDepthMessages</varname>.
<emphasis>Maximum number of bytes</emphasis> can be set using
queue attribute <varname>maximumQueueDepthBytes</varname>
- <note>
- <para>
- Negative values for <emphasis>maximum number of messages</emphasis> and
- <emphasis>maximum number of bytes</emphasis>
- can be used to remove the upper limit (simply making queue unbounded by the limit where it was set).
- </para>
- </note>
</para>
- <para>The <emphasis>Overflow Policy</emphasis> and the limits can be specified using
- <emphasis>Address</emphasis>
- based syntax as in the example below:
- <screen><![CDATA[
-my-queue; {create: always, node: {x-declare: {arguments:{'qpid.max_count': 10000, 'qpid.max_size': 102400, 'qpid.policy_type: 'ring'}}}}
-]]></screen>
- <itemizedlist>
- <listitem>
- <para>
- Argument <varname>qpid.max_count</varname> is used to define <emphasis>maximum number of
- messages</emphasis>.
- </para>
- </listitem>
- <listitem>
- <para>
- Argument <varname>qpid.max_size</varname> is used to define <emphasis>maximum number of
- bytes</emphasis>.
- </para>
- </listitem>
- <listitem>
- <para>
- Argument <varname>qpid.policy_type</varname> is used to define <emphasis>Overflow
- Policy</emphasis>.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- <para>
- Alternatively, <emphasis>Producer Flow Control</emphasis> can be specified with
- <emphasis>Address</emphasis> based syntax using arguments <varname>x-qpid-flow-resume-capacity</varname> and
- <varname>x-qpid-capacity</varname>, for example:
- <screen><![CDATA[
-my-queue; {create: always, node: {x-declare: {arguments:{'x-qpid-capacity': 102400, 'x-qpid-flow-resume-capacity': 8192000}}}}
-]]></screen>
- <para>This is a deprecated syntax. It is limited to specifying the capacity and resume threshold in bytes.</para>
- <itemizedlist>
- <listitem>
- <para>
- Argument <varname>x-qpid-capacity</varname> is used to define <emphasis>maximum number of
- bytes</emphasis>.
- </para>
- </listitem>
- <listitem>
- <para>
- Argument <varname>x-qpid-flow-resume-capacity</varname> is used to define flow resume threshold
- in bytes.
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
+ <note>
+ <para>
+ Negative values for <emphasis>maximum number of messages</emphasis> and
+ <emphasis>maximum number of bytes</emphasis>
+ can be used to remove the upper limit (simply making queue unbound by the limit where it was set).
+ </para>
+ </note>
<note>
<para>
The <emphasis>Producer Flow Control</emphasis> can be triggered when a configured disk
@@ -496,113 +445,17 @@ my-queue; {create: always, node: {x-decl
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="${qpidJmsClient08Book}/JMS-Client-0-8-Appendix-ProducerFlowControl-Impact.html">here</link>
</para>
</note>
- <section role="h4">
- <title>Overflow Policies Operational Log Messages</title>
- <para>
- When <emphasis>Ring</emphasis> overflow policy is configured and any of the limits is breached the
- following operational log message is issued
- <screen><![CDATA[
-QUE-1005 : Dropped : {0,number} messages, Depth : {1,number} bytes, {2,number} messages, Capacity : {3,number} bytes, {4,number} messages
-]]></screen>
- <itemizedlist>
- <listitem>
- <para>
- <varname>{0,number}</varname>
- a placeholder to provide the number of deleted messages.
- </para>
- </listitem>
- <listitem>
- <para>
- <varname>{1,number}</varname>
- a placeholder to provide the queue depth in bytes.
- </para>
- </listitem>
- <listitem>
- <para>
- <varname>{2,number}</varname>
- a placeholder to provide the queue depth in messages.
- </para>
- </listitem>
- <listitem>
- <para>
- <varname>{3,number}</varname>
- a placeholder to provide <emphasis>maximum number of bytes</emphasis>.
- </para>
- </listitem>
- <listitem>
- <para>
- <varname>{4,number}</varname>
- a placeholder to provide the <emphasis>maximum number of messages</emphasis>.
- </para>
- </listitem>
- </itemizedlist>
- </para>
+ <note>
<para>
- When <emphasis>Producer Flow Control</emphasis> overflow policy is configured and any of the capacity
- limits is breached the following operational log message is issued
- <screen><![CDATA[
-QUE-1003 : Overfull : Size : {0,number} bytes, Capacity : {1,number}, Messages : {2,number}, Message Capacity : {3,number}
-]]></screen>
- <itemizedlist>
- <listitem>
- <para>
- <varname>{0,number}</varname>
- a placeholder to provide the queue depth in bytes.
- </para>
- </listitem>
- <listitem>
- <para>
- <varname>{1,number}</varname>
- a placeholder to provide the <emphasis>maximum number of bytes</emphasis>.
- </para>
- </listitem>
- <listitem>
- <para>
- <varname>{2,number}</varname>
- a placeholder to provide the queue depth in messages.
- </para>
- </listitem>
- <listitem>
- <para>
- <varname>{3,number}</varname>
- a placeholder to provide <emphasis>maximum number of messages</emphasis>.
- </para>
- </listitem>
- </itemizedlist>
+ Operational logs issued on breaching of queue capacities for different overflow policies are documented
+ at <xref linkend="Java-Broker-Appendix-Operation-Logging-Message-List-Queue"/>.
</para>
+ </note>
+ <note>
<para>
- When <emphasis>Producer Flow Control</emphasis> overflow policy is configured and flow is blocked, the
- following operational log message is issued on reaching the resume threshold
- <screen><![CDATA[
-QUE-1004 : Underfull : Size : {0,number} bytes, Resume Capacity : {1,number}, Messages : {2,number}, Message Capacity : {3,number}
-]]></screen>
- <itemizedlist>
- <listitem>
- <para>
- <varname>{0,number}</varname>
- a placeholder to provide the queue depth in bytes.
- </para>
- </listitem>
- <listitem>
- <para>
- <varname>{1,number}</varname>
- a placeholder to provide the <emphasis>maximum number of bytes</emphasis>.
- </para>
- </listitem>
- <listitem>
- <para>
- <varname>{2,number}</varname>
- a placeholder to provide the queue depth in messages.
- </para>
- </listitem>
- <listitem>
- <para>
- <varname>{3,number}</varname>
- a placeholder to provide <emphasis>maximum number of messages</emphasis>.
- </para>
- </listitem>
- </itemizedlist>
+ Supported queue arguments for AMQP 0.x <emphasis>queue.declare</emphasis> are documented
+ at <xref linkend="Java-Broker-Appendix-Supported-Queue-Declare-Arguments"/>.
</para>
- </section>
+ </note>
</section>
</section>
Modified: qpid/java/trunk/doc/java-broker/src/docbkx/management/managing/Java-Broker-Management-Managing-Queues.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/java-broker/src/docbkx/management/managing/Java-Broker-Management-Managing-Queues.xml?rev=1785348&r1=1785347&r2=1785348&view=diff
==============================================================================
--- qpid/java/trunk/doc/java-broker/src/docbkx/management/managing/Java-Broker-Management-Managing-Queues.xml (original)
+++ qpid/java/trunk/doc/java-broker/src/docbkx/management/managing/Java-Broker-Management-Managing-Queues.xml Fri Mar 3 16:47:33 2017
@@ -73,9 +73,9 @@
existing messages on the queue are not affected. </para>
</listitem>
<listitem>
- <para><emphasis>Queue capacity</emphasis>. Queues have the ability to limit the of the
+ <para><emphasis>Overflow policy</emphasis>. Queues have the ability to limit the of the
cumulative size of all the messages contained within the store. This feature is
- described in detail <xref linkend="Java-Broker-Runtime-Disk-Space-Management"/>.</para>
+ described in detail <xref linkend="Java-Broker-Concepts-Queue-OverflowPolicy"/>.</para>
</listitem>
<listitem>
<para><emphasis>Alerting Thresholds</emphasis>. Queues have the ability to alert on a
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org