WebSphere Message Service Clients for C/C++ and .NET, Version 1.2 オペレーティング・システム: Linux, Windows

Destination

宛先は、アプリケーションが送信するメッセージの送信先であるか、アプリケーションが受け取るメッセージの送信元であるか、またはその両方です。

継承の階層:
xms::PropertyContext
|
+----xms::Destination

Destination オブジェクトの XMS 定義プロパティーのリストについては、Destination のプロパティーを参照してください。

関連概念
接続ファクトリーおよび接続
WebSphere サービス統合バスへの接続
宛先
トピック URI
キュー URI
一時宛先
関連タスク
管理対象オブジェクトの作成

コンストラクター

コンストラクターの要約:
コンストラクター 説明
Destination 指定された宛先タイプおよび名前を使用して、宛先を作成します。
Destination 指定された URI (Uniform Resource Identifier) を使用して、宛先を作成します。

Destination – 宛先の作成 (タイプおよび名前を指定)

インターフェース:
Destination(const xmsDESTINATION_TYPE destinationType,
const String & destinationName);

指定された宛先タイプおよび名前を使用して、宛先を作成します。

宛先がキューである場合、このコンストラクターは、メッセージング・サーバーにキューを作成しません。 アプリケーションがこのコンストラクターを呼び出すためには、その前にキューを作成する必要があります。

パラメーター:
destinationType (入力)
宛先のタイプ。以下の値のいずれかでなければなりません。
  • XMS_DESTINATION_TYPE_QUEUE
  • XMS_DESTINATION_TYPE_TOPIC
destinationName (入力)
宛先の名前をカプセル化している String オブジェクト。宛先の名前は、キューの名前またはトピックの名前になります。
宛先が WebSphere MQ キューである場合、以下のいずれかの方法で宛先の名前を指定することができます。
  • QName
  • QMgrName/QName
ここで、QNameWebSphere MQ キューの名前、QMgrNameWebSphere MQ キュー・マネージャーの名前です。 WebSphere MQ キュー名解決プロセスでは、QName および QMgrName の値を使用して、実際の宛先キューを判別します。キュー名解決プロセスについて詳しくは、「WebSphere MQ アプリケーション・プログラミング・ガイド」を参照してください。
例外:
  • XMS_X_GENERAL_EXCEPTION

Destination – 宛先の作成 (URI を使用)

インターフェース:
Destination(const String & URI);

指定された URI (Uniform Resource Identifier) を使用して、宛先を作成します。URI によって指定されなかった宛先のプロパティーは、デフォルト値を使用します。

宛先がキューである場合、このコンストラクターは、メッセージング・サーバーにキューを作成しません。アプリケーションがこのコンストラクターを呼び出すためには、その前にキューを作成する必要があります。

パラメーター:
URI (入力)
URI をカプセル化している String オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

メソッド

メソッドの要約:
メソッド 説明
~Destination 宛先を削除します。
getHandle C アプリケーションが宛先にアクセスするときに使用するハンドルを取得します。
getName 宛先名を取得します。
getTypeId 宛先のタイプを取得します。
isNull Destination オブジェクトがヌル・オブジェクトであるかどうかを判別します。
toString 宛先の名前を、URI (Uniform Resource Identifier) の形式で取得します。

~Destination – 宛先の削除

インターフェース:
virtual ~Destination();

宛先を削除します。

宛先がキューである場合、そのキューが XMS 一時キューとして作成されていない限り、このメソッドはメッセージング・サーバー内のキューを削除しません。

アプリケーションが、既に削除されている宛先を削除しようとした場合、呼び出しは無視されます。

パラメーター:
なし
例外:
  • XMS_X_GENERAL_EXCEPTION

getHandle – ハンドルの取得

インターフェース:
xmsHDest getHandle() const;

C アプリケーションが宛先にアクセスするときに使用するハンドルを取得します。

パラメーター:
なし
戻り値:
宛先のハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

getName – 宛先名の取得

インターフェース:
String getName() const;

宛先名を取得します。

パラメーター:
なし
戻り値:
宛先の名前をカプセル化している String オブジェクト。名前は、キューの名前またはトピックの名前のいずれかです。
例外:
  • XMS_X_GENERAL_EXCEPTION

getTypeId – 宛先タイプの取得

インターフェース:
xmsDESTINATION_TYPE getTypeId();

宛先のタイプを取得します。

パラメーター:
なし
戻り値:
宛先のタイプ。以下の値のいずれかです。
  • XMS_DESTINATION_TYPE_QUEUE
  • XMS_DESTINATION_TYPE_TOPIC
例外:
  • XMS_X_GENERAL_EXCEPTION

isNull – ヌルであるかどうかを検査

インターフェース:
xmsBOOL isNull() const;

Destination オブジェクトがヌル・オブジェクトであるかどうかを判別します。

パラメーター:
なし
戻り値:
  • Destination オブジェクトがヌル・オブジェクトの場合は、xmsTRUE
  • Destination オブジェクトがヌル・オブジェクトでない場合は、xmsFALSE
例外:
  • XMS_X_GENERAL_EXCEPTION

toString – 宛先名を URI として取得

インターフェース:
String toString() const;

宛先の名前を、URI (Uniform Resource Identifier) の形式で取得します。

パラメーター:
なし
戻り値:
URI をカプセル化している String オブジェクト。URI は、キュー URI またはトピック URI です。
例外:
  • XMS_X_GENERAL_EXCEPTION

継承されたメソッド


Reference topic

ご利用条件 | フィードバック (英語のみ)

Timestamp icon最終更新: 8 Jun 2006
(C) Copyright IBM Corporation 2005, 2006. All Rights Reserved.
このインフォメーション・センターでは Eclipse テクノロジーが採用されています。(http://www.eclipse.org)