Object Overview

This object defines a named queue residing on an ORMQProvider. These queues may be written to (via a DispatcherSource? ?, InputConnector or any of the ProtocolListeners), or subscribed to (via an ORMQSubscription or ORMQInputConnector).

ORMQ queues support a variety of delivery and reliability options, allowing them to operate successfully in a variety of messaging scenarios. They can be utilized to broadcast messages to a group of subscribers, engage in point-to-point messaging with one or more subscribers, etc.

Example Object Definitions

... directly within an ORMQProvider or the top-level ServerConfiguration object:

Minimal Configuration:

<ORMQDestination name="ormqDest1" 
                 queue="public.queues.queue1"/>

Overview:

An ORMQ queue destination named "public.queues.queue1". All other options for this queue destination are set to their defaults.

Complex Configuration (all possible attributes shown):

<ORMQDestination name="ormqDest1" tags="ormq queue"
                 description="example p2p ormq message queue"
                 provider="ORMQProvider1"
                 queue="public.queues.queue1"
                 deliveryMode="p2p"/>

Overview:

An ORMQ queue destination named "public.queues.queue1". This queue will be created on the ORMQ Provider named "ORMQProvider1", using "Point-to-Point" message delivery.

Supported Attributes

General Attributes:

• name - (usage: required): Public name of the configuration object. This name must be globally-unique across the entire AlchemyPoint ServerConfiguration definition.

• description - (usage: optional): Textual description of the configuration object.

• tags - (usage: optional): Space-delimited list of one or more tags used to describe the configuration object.

Object Attributes:

• queue - (usage: required): The name of the ORMQ queue destination that should be created.

• provider - (usage: mixed): The published name of the ORMQ Provider instance that this Destination should be created on. This corresponds to the 'name' attribute of an ORMQProvider within the same AlchemyPoint system configuration.
  • This parameter cannot be utilized if this object resides within an ORMQProvider.
  • This parameter cannot be utilized if the object specifies the 'client' option.
  • This parameter is required if the object does not reside within an ORMQProvider, ORMQSocketConnection, ORMQMemConnection, or ORMQPipeConnection and does not specify a 'client' setting.

• client - (usage: mixed): The published name of the ORMQ Connection instance that this Destination should be created on. This corresponds to the 'name' attribute of an ORMQSocketConnection, ORMQMemConnection, or ORMQPipeConnection within the same AlchemyPoint system configuration.
  • This parameter cannot be utilized if this object resides within an ORMQConnection? .
  • This parameter cannot be utilized if the object specifies the 'provider' option.
  • This parameter is required if the object does not reside within an ORMQProvider, ORMQSocketConnection, ORMQMemConnection, or ORMQPipeConnection and does not specify a 'provider' setting.

• deliveryMode - (usage: optional, default: "p2p"): The manner in which messages posted to this ORMQ queue destination should be delivered to subscribers. The following 'deliveryMode' settings are supported:
  • p2p - Point-to-Point delivery. In this mode, an ORMQ message posted to a queue is only delivered to a single subscriber. The same message will not be sent to multiple subscribers.
  • broadcast - Broadcast delivery. In this mode, an ORMQ message posted to a queue will be broadcast to all queue subscribers.

Supported Child Configuration Elements

None.