Menu Search

Appendix G. Queue Declaration Arguments supported by the Broker

Qpid Broker-J supports a number of custom arguments which can be specified as part of queue.declare commands for AMQP 0-x protocols. This section provides an overview of the supported arguments.

Table G.1. Queue declare arguments

Argument NameDescription

Declaration of overflow policy. See Section 4.7.5, “Controlling Queue Size” for more details.

 

qpid.policy_type

Defines queue overflow policy.

qpid.max_count

Defines maximum number of messages.

qpid.max_size

Defines maximum number of bytes.

The Overflow Policy and the limits can be specified using Address based syntax as in the example below:

my-queue; {create: always, node:
{x-declare: {arguments:
{'qpid.max_count': 10000,
'qpid.max_size': 102400,
'qpid.policy_type: 'ring'}}}}

 

Alternative declaration of Producer Flow Control overflow policy. See Section 4.7.5, “Controlling Queue Size” for more details.

 

x-qpid-capacity

Defines maximum number of bytes.

x-qpid-flow-resume-capacity

Defines flow resume threshold in bytes

The Producer Flow Control can be specified using Address based syntax as in the example below:

my-queue; {create: always, node:
{x-declare: {arguments:
{'x-qpid-capacity': 102400,
'x-qpid-flow-resume-capacity': 8192000}}}}

 

x-qpid-priorities

Specifies a priority queue with given number priorities

qpid.queue_sort_key

Specifies sorted queue with given message property used to sort the entries

qpid.last_value_queue_key

Specifies lvq queue with given message property used to conflate the entries

qpid.ensure_nondestructive_consumers

Set to true if the queue should make all consumers attached to it behave non-destructively. (Default is false).

x-qpid-maximum-delivery-count

Specifies this queue's maximum delivery count.

x-single-active-consumer

If set true, then of all consumers attached to a queue, only one will be designated as active, 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.