| <!DOCTYPE html> |
| <!-- |
| - |
| - 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. |
| - |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> |
| <head> |
| <title>Appendix G. Queue Declaration Arguments supported by the Broker - Apache Qpid™</title> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"/> |
| <link rel="stylesheet" href="/site.css" type="text/css" async="async"/> |
| <link rel="stylesheet" href="/deferred.css" type="text/css" defer="defer"/> |
| <script type="text/javascript">var _deferredFunctions = [];</script> |
| <script type="text/javascript" src="/deferred.js" defer="defer"></script> |
| <!--[if lte IE 8]> |
| <link rel="stylesheet" href="/ie.css" type="text/css"/> |
| <script type="text/javascript" src="/html5shiv.js"></script> |
| <![endif]--> |
| |
| <!-- Redirects for `go get` and godoc.org --> |
| <meta name="go-import" |
| content="qpid.apache.org git https://gitbox.apache.org/repos/asf/qpid-proton.git"/> |
| <meta name="go-source" |
| content="qpid.apache.org |
| https://github.com/apache/qpid-proton/blob/go1/README.md |
| https://github.com/apache/qpid-proton/tree/go1{/dir} |
| https://github.com/apache/qpid-proton/blob/go1{/dir}/{file}#L{line}"/> |
| </head> |
| <body> |
| <div id="-content"> |
| <div id="-top" class="panel"> |
| <a id="-menu-link"><img width="16" height="16" src="" alt="Menu"/></a> |
| |
| <a id="-search-link"><img width="22" height="16" src="" alt="Search"/></a> |
| |
| <ul id="-global-navigation"> |
| <li><a id="-logotype" href="/index.html">Apache Qpid<sup>™</sup></a></li> |
| <li><a href="/documentation.html">Documentation</a></li> |
| <li><a href="/download.html">Download</a></li> |
| <li><a href="/discussion.html">Discussion</a></li> |
| </ul> |
| </div> |
| |
| <div id="-menu" class="panel" style="display: none;"> |
| <div class="flex"> |
| <section> |
| <h3>Project</h3> |
| |
| <ul> |
| <li><a href="/overview.html">Overview</a></li> |
| <li><a href="/components/index.html">Components</a></li> |
| <li><a href="/releases/index.html">Releases</a></li> |
| </ul> |
| </section> |
| |
| <section> |
| <h3>Messaging APIs</h3> |
| |
| <ul> |
| <li><a href="/proton/index.html">Qpid Proton</a></li> |
| <li><a href="/components/jms/index.html">Qpid JMS</a></li> |
| <li><a href="/components/messaging-api/index.html">Qpid Messaging API</a></li> |
| </ul> |
| </section> |
| |
| <section> |
| <h3>Servers and tools</h3> |
| |
| <ul> |
| <li><a href="/components/broker-j/index.html">Broker-J</a></li> |
| <li><a href="/components/cpp-broker/index.html">C++ broker</a></li> |
| <li><a href="/components/dispatch-router/index.html">Dispatch router</a></li> |
| </ul> |
| </section> |
| |
| <section> |
| <h3>Resources</h3> |
| |
| <ul> |
| <li><a href="/dashboard.html">Dashboard</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/qpid/Index">Wiki</a></li> |
| <li><a href="/resources.html">More resources</a></li> |
| </ul> |
| </section> |
| </div> |
| </div> |
| |
| <div id="-search" class="panel" style="display: none;"> |
| <form action="http://www.google.com/search" method="get"> |
| <input type="hidden" name="sitesearch" value="qpid.apache.org"/> |
| <input type="text" name="q" maxlength="255" autofocus="autofocus" tabindex="1"/> |
| <button type="submit">Search</button> |
| <a href="/search.html">More ways to search</a> |
| </form> |
| </div> |
| |
| <div id="-middle" class="panel"> |
| <ul id="-path-navigation"><li><a href="/index.html">Home</a></li><li><a href="/releases/index.html">Releases</a></li><li><a href="/releases/qpid-broker-j-9.2.0/index.html">Qpid Broker-J 9.2.0</a></li><li><a href="/releases/qpid-broker-j-9.2.0/book/index.html">Apache Qpid Broker-J</a></li><li>Appendix G. Queue Declaration Arguments supported by the Broker</li></ul> |
| |
| <div id="-middle-content"> |
| <div class="docbook"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix G. Queue Declaration Arguments supported by the Broker</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="Java-Broker-Miscellaneous-Installing-External-JDBC-Driver.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="Java-Broker-Appendix-BDB-HA-initial-configuration.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="Java-Broker-Appendix-Queue-Declare-Arguments"></a>Appendix G. Queue Declaration Arguments supported by the Broker</h1></div></div></div><p> |
| <span class="emphasis"><em>Qpid Broker-J</em></span> |
| supports a number of custom arguments which can be specified as part of <span class="emphasis"><em>queue.declare</em></span> |
| commands for AMQP 0-x protocols. This section provides an overview of the supported arguments. |
| </p><div class="table"><a id="Java-Broker-Appendix-Supported-Queue-Declare-Arguments"></a><p class="title"><strong>Table G.1. Queue declare arguments</strong></p><div class="table-contents"><table summary="Queue declare arguments" border="1"><colgroup><col class="argname" /><col class="description" /></colgroup><thead><tr><th>Argument Name</th><th>Description</th></tr></thead><tbody><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Overflow-Policy"></a> |
| <p>Declaration of overflow policy. |
| See |
| <a class="xref" href="Java-Broker-Concepts-Queues.html#Java-Broker-Concepts-Queue-OverflowPolicy" title="4.7.5. Controlling Queue Size">Section 4.7.5, “Controlling Queue Size”</a> |
| for more details. |
| </p> |
| </td><td class="auto-generated"> </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Policy-Type"></a> |
| <p>qpid.policy_type</p> |
| </td><td> |
| <p>Defines queue overflow policy.</p> |
| </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Max-Count"></a> |
| <p>qpid.max_count</p> |
| </td><td> |
| <p>Defines <span class="emphasis"><em>maximum number of messages</em></span>. |
| </p> |
| </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Max-Size"></a> |
| <p>qpid.max_size</p> |
| </td><td> |
| <p>Defines <span class="emphasis"><em>maximum number of bytes</em></span>. |
| </p> |
| </td></tr><tr><td> |
| <p>The <span class="emphasis"><em>Overflow Policy</em></span> and the limits can be specified using |
| <span class="emphasis"><em>Address</em></span> |
| based syntax as in the example below: |
| </p><pre class="screen"> |
| my-queue; {create: always, node: |
| {x-declare: {arguments: |
| {'qpid.max_count': 10000, |
| 'qpid.max_size': 102400, |
| 'qpid.policy_type: 'ring'}}}} |
| </pre><p> |
| </p> |
| </td><td class="auto-generated"> </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Overflow-Policy-Producer-Flow-Control"></a> |
| <p>Alternative declaration of <span class="emphasis"><em>Producer Flow Control</em></span> overflow policy. |
| See |
| <a class="xref" href="Java-Broker-Concepts-Queues.html#Java-Broker-Concepts-Queue-OverflowPolicy" title="4.7.5. Controlling Queue Size">Section 4.7.5, “Controlling Queue Size”</a> |
| for more details. |
| </p> |
| </td><td class="auto-generated"> </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Capacity"></a> |
| <p>x-qpid-capacity</p> |
| </td><td> |
| <p>Defines <span class="emphasis"><em>maximum number of bytes</em></span>. |
| </p> |
| </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Flow-Resume-Capacity"></a> |
| <p>x-qpid-flow-resume-capacity</p> |
| </td><td> |
| <p>Defines flow resume threshold in bytes</p> |
| </td></tr><tr><td> |
| <p>The <span class="emphasis"><em>Producer Flow Control</em></span> can be specified using |
| <span class="emphasis"><em>Address</em></span> based syntax as in the example below: |
| </p><pre class="screen"> |
| my-queue; {create: always, node: |
| {x-declare: {arguments: |
| {'x-qpid-capacity': 102400, |
| 'x-qpid-flow-resume-capacity': 8192000}}}} |
| </pre><p> |
| </p> |
| </td><td class="auto-generated"> </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-X-Qpid-Priorities"></a> |
| <p>x-qpid-priorities</p> |
| </td><td> |
| <p>Specifies a priority queue with given number priorities</p> |
| </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Qpid-Sort-Key"></a> |
| <p>qpid.queue_sort_key</p> |
| </td><td> |
| <p>Specifies sorted queue with given message property used to sort the entries</p> |
| </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Qpid-Last-Value-Key"></a> |
| <p>qpid.last_value_queue_key</p> |
| </td><td> |
| <p>Specifies lvq queue with given message property used to conflate the entries</p> |
| </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Qpid-Ensure-Nondestructive-Consumers"></a> |
| <p>qpid.ensure_nondestructive_consumers</p> |
| </td><td> |
| <p>Set to true if the queue should make all consumers attached to it behave |
| non-destructively. (Default is false).</p> |
| </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-X-Qpid-Maximum-Delivery-Count"></a> |
| <p>x-qpid-maximum-delivery-count</p> |
| </td><td> |
| <p>Specifies this queue's maximum delivery count.</p> |
| </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-X-Single-Active-Consumer"></a> |
| <p>x-single-active-consumer</p> |
| </td><td> |
| <p>If set <code class="literal">true</code>, then of all consumers attached to a queue, only one will |
| be designated as <span class="emphasis"><em>active</em></span>, and eligible to receive messages. If the active |
| consumer is detached, and other consumers are attached, one of these other consumers is selected |
| to become the single active consumer.</p> |
| </td></tr></tbody></table></div></div><br class="table-break" /></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="Java-Broker-Miscellaneous-Installing-External-JDBC-Driver.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="Java-Broker-Appendix-BDB-HA-initial-configuration.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">F.2. Installing External JDBC Driver </td><td width="20%" align="center"><a accesskey="h" href="Apache-Qpid-Broker-J-Book.html">Home</a></td><td width="40%" align="right" valign="top"> Appendix H. BDB HA initial configuration</td></tr></table></div></div> |
| |
| <hr/> |
| |
| <ul id="-apache-navigation"> |
| <li><a href="http://www.apache.org/">Apache</a></li> |
| <li><a href="http://www.apache.org/licenses/">License</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="http://www.apache.org/foundation/thanks.html">Thanks!</a></li> |
| <li><a href="/security.html">Security</a></li> |
| <li><a href="http://www.apache.org/"><img id="-apache-feather" width="48" height="14" src="" alt="Apache"/></a></li> |
| </ul> |
| |
| <p id="-legal"> |
| Apache Qpid, Messaging built on AMQP; Copyright © 2015 |
| The Apache Software Foundation; Licensed under |
| the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache |
| License, Version 2.0</a>; Apache Qpid, Qpid, Qpid Proton, |
| Proton, Apache, the Apache feather logo, and the Apache Qpid |
| project logo are trademarks of The Apache Software |
| Foundation; All other marks mentioned may be trademarks or |
| registered trademarks of their respective owners |
| </p> |
| </div> |
| </div> |
| </div> |
| </body> |
| </html> |