TOptionsConsumer Class Reference
[HabariActiveMQExpress component]

OptionsConsumer. More...

List of all members.

Public Attributes
Boolean	DispatchAsync
	Should messages be dispatched synchronously or asynchronously from the producer thread for non-durable topics in the broker? For fast consumers set this to false.
Boolean	Exclusive
	I would like to be an Exclusive Consumer on the queue.
Integer	MaximumPendingMessageLimit
	For Slow Consumer Handling on non-durable topics by dropping old messages - we can set a maximum-pending limit, such that once a slow consumer backs up to this high water mark we begin to discard old messages.
string	MessageSelector
	Only messages with properties matching the message selector expression are delivered.
Boolean	NoLocal
	If true, and the destination is a topic, inhibits the delivery of messages published by its own connection.
Integer	PrefetchSize
	Specifies the maximum number of pending messages that will be dispatched to the client.
Byte	Priority
	Sets the priority of the consumer so that dispatching can be weighted in priority order.
Boolean	Retroactive
	For non-durable topics make this subscription retroactive.

---

Detailed Description

OptionsConsumer.

---

Member Data Documentation

Boolean TOptionsConsumer::DispatchAsync

Should messages be dispatched synchronously or asynchronously from the producer thread for non-durable topics in the broker? For fast consumers set this to false.

For slow consumers set it to true so that dispatching will not block fast consumers.

Since:

1.0.2

See also:

FDispatchAsync For reading

SetDispatchAsync For writing

Boolean TOptionsConsumer::Exclusive

I would like to be an Exclusive Consumer on the queue.

See also:

FExclusive For reading

SetExclusive For writing

Integer TOptionsConsumer::MaximumPendingMessageLimit

For Slow Consumer Handling on non-durable topics by dropping old messages - we can set a maximum-pending limit, such that once a slow consumer backs up to this high water mark we begin to discard old messages.

See also:

http://activemq.apache.org/slow-consumer-handling.html

Since:

1.0.2

See also:

FMaximumPendingMessageLimit For reading

SetMaximumPendingMessageLimit For writing

string TOptionsConsumer::MessageSelector

Only messages with properties matching the message selector expression are delivered.

An empty string indicates that there is no message selector for the message consumer.

See also:

FMessageSelector For reading

SetMessageSelector For writing

Boolean TOptionsConsumer::NoLocal

If true, and the destination is a topic, inhibits the delivery of messages published by its own connection.

The behavior for NoLocal is not specified if the destination is a queue.

See also:

FNoLocal For reading

SetNoLocal For writing

Integer TOptionsConsumer::PrefetchSize

Specifies the maximum number of pending messages that will be dispatched to the client.

Once this maximum is reached no more messages are dispatched until the client acknowledges a message. Set to 1 for very fair distribution of messages across consumers where processing messages can be slow.

Since:

1.0.2

See also:

FPrefetchSize For reading

SetPrefetchSize For writing

Byte TOptionsConsumer::Priority

Sets the priority of the consumer so that dispatching can be weighted in priority order.

Since:

1.0.2

See also:

FPriority For reading

SetPriority For writing

Boolean TOptionsConsumer::Retroactive

For non-durable topics make this subscription retroactive.

See also:

http://activemq.apache.org/retroactive-consumer.html

Since:

1.0.2

See also:

FRetroactive For reading

SetRetroactive For writing