WebSphere WebSphere Business Integration Message Service Clients for C/C++ Version 1.2.7 and .NET Version 1.2.6 Operating Systems: AIX, Linux, Solaris, Windows

Destination

A destination is where an application sends messages, or it is a source from which an application receives messages, or both.

Inheritance hierarchy:
xms::PropertyContext
   |
   +----xms::Destination

For a list of the XMS defined properties of a Destination object, see Properties of Destination.

Related concepts
ConnectionFactories and Connection objects
Connection to a WebSphere service integration bus
Destinations
Destination wildcards
Topic uniform resource identifiers
Queue uniform resource identifiers
Temporary destinations
Property mapping for administered objects
Related tasks
Creating administered objects
Related reference
Required properties for administered Destination objects

Constructors

Summary of constructors:
Constructor Description
Destination Create a destination using the specified destination type and name.
Destination Create a destination using the specified uniform resource identifier (URI).

Destination – Create Destination (specifying a type and name)

Interface:
Destination(const xmsDESTINATION_TYPE destinationType,
            const String & destinationName);

Create a destination using the specified destination type and name.

For a destination that is a queue, this constructor does not create the queue in the messaging server. You must create the queue before an application can call this constructor.

Parameters:
destinationType (input)
The type of the destination, which must be one of the following values:
  • XMS_DESTINATION_TYPE_QUEUE
  • XMS_DESTINATION_TYPE_TOPIC
destinationName (input)
A String object encapsulating the name of the destination, which can be the name of a queue or the name of a topic.
If the destination is a WebSphere MQ queue, you can specify the name of the destination in either of the following ways:
  • QName
  • QMgrName/QName
where QName is the name of a WebSphere MQ queue, and QMgrName is the name of a WebSphere MQ queue manager. The WebSphere MQ queue name resolution process uses the values of QName and QMgrName to determine the actual destination queue. For more information about the queue name resolution process, see the WebSphere MQ Application Programming Guide.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

Destination – Create Destination (using a URI)

Interface:
Destination(const String & URI);

Create a destination using the specified uniform resource identifier (URI). Properties of the destination that are not specified by the URI take the default values.

For a destination that is a queue, this constructor does not create the queue in the messaging server. You must create the queue before an application can call this constructor.

Parameters:
URI (input)
A String object encapsulating the URI.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

Methods

Summary of methods:
Method Description
~Destination Delete the destination.
getHandle Get the handle that a C application would use to access the destination.
getName Get the name of the destination.
getTypeId Get the type of the destination.
isNull Determine whether the Destination object is a null object.
toString Get the name of the destination in the format of a uniform resource identifier (URI).

~Destination – Delete Destination

Interface:
virtual ~Destination();

Delete the destination.

For a destination that is a queue, this method does not delete the queue in the messaging server unless the queue was created for an XMS temporary queue.

If an application tries to delete a destination that is already deleted, the call is ignored.

Parameters:
None
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getHandle – Get Handle

Interface:
xmsHDest getHandle() const;

Get the handle that a C application would use to access the destination.

Parameters:
None
Returns:
The handle for the destination.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getName – Get Destination Name

Interface:
String getName() const;

Get the name of the destination.

Parameters:
None
Returns:
A String object encapsulating the name of the destination. The name is either the name of a queue or the name of a topic.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

getTypeId – Get Destination Type

Interface:
xmsDESTINATION_TYPE getTypeId();

Get the type of the destination.

Parameters:
None
Returns:
The type of the destination, which is one of the following values:
  • XMS_DESTINATION_TYPE_QUEUE
  • XMS_DESTINATION_TYPE_TOPIC
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

isNull – Check Whether Null

Interface:
xmsBOOL isNull() const;

Determine whether the Destination object is a null object.

Parameters:
None
Returns:
  • xmsTRUE, if the Destination object is a null object.
  • xmsFALSE, if the Destination object is not a null object.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

toString – Get Destination Name as URI

Interface:
String toString() const;

Get the name of the destination in the format of a uniform resource identifier (URI).

Parameters:
None
Returns:
A String object encapsulating the URI. The URI is either a queue URI or a topic URI.
Exceptions:
  • XMS_X_GENERAL_EXCEPTION

Inherited methods


Reference topic

Terms of Use | Rate this page

Last updated: 18 Jun 2008

© Copyright IBM Corporation 2005, 2008. All Rights Reserved.