Contents
class solace.QueueProperties
Represents a queue properties object. May be passed in to solace.Session#createMessageConsumer when creating a solace.MessageConsumer object, or to solace.Session#provisionEndpoint . Upon creation of a queue or TE, undefined properties are set to default values chosen by the router.
Constructor Top
| QueueProperties ( ) |
Properties Top
| solace.QueueAccessType |
accessType
= undefined
| ||
| solace.QueueDiscardBehavior |
discardBehavior
= {solace.QueueDiscardBehavior.NOTIFY_SENDER_OFF}
| ||
| Number |
maxMessageRedelivery
= undefined
| ||
| Number |
maxMessageSize
= undefined
| ||
| solace.QueuePermissions |
permissions
= undefined
| ||
| Number |
quotaMB
= undefined
| ||
| Boolean |
respectsTTL
= false
|
Constructor details
Top
QueueProperties
( )
Represents a queue properties object. May be passed in to
solace.Session#createMessageConsumer when creating a
solace.MessageConsumer object, or to solace.Session#provisionEndpoint .
Upon creation of a queue or TE, undefined
properties are set to default values chosen by the router.
Represents a queue properties object. May be passed in to solace.Session#createMessageConsumer when creating a solace.MessageConsumer object, or to solace.Session#provisionEndpoint . Upon creation of a queue or TE, undefined properties are set to default values chosen by the router.
Properties Detail Top
Gets/sets the access type for this queue.
This parameter must NOT be set when creating a temporary queue via solace.Session#createMessageConsumer. Such a queue has its access type determined by the remote message router.
public
solace.QueueDiscardBehavior
discardBehavior
= {solace.QueueDiscardBehavior.NOTIFY_SENDER_OFF}
{solace.QueueDiscardBehavior.NOTIFY_SENDER_OFF}
Gets/sets the discard behavior for this queue.
public
Number
maxMessageRedelivery
= undefined
undefined
Gets/sets the maximum number of times to attempt message redelivery for this queue.
- The valid range is 0 <= maxMessageRedelivery <= 255
- A value of 0 means retry forever.
public
Number
maxMessageSize
= undefined
undefined
Gets/sets the maximum message size, in bytes, for any single message spooled on this queue.
Gets/sets permissions for this queue.
When creating a temporary queue, these are the permissions that apply to all other users; the user creating the temporary queue is always granted DELETE permissions.
public
Number
quotaMB
= undefined
undefined
Gets/sets the quota, in megabytes, for this queue.
- The allowed values are (0 <= quotaMB) || undefined.
- A value of 0 configures the queue to act as a Last-Value-Queue (LVQ), where the router enforces a Queue depth of one, and only the most current message is spooled by the queue. When a new message is received, the current queued message is first automatically deleted from the queue, then the new message is spooled.
public
Boolean
respectsTTL
= false
false
Gets/sets whether this queue respects Time To Live on messages.