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

Connection

Connection オブジェクトは、アプリケーションによるブローカーへのアクティブな接続を表します。

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

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

メソッド

メソッドの要約:
メソッド 説明
close 接続を閉じます。
createSession セッションを作成します。
getClientID 接続のクライアント ID を取得します。
getExceptionListener 接続に登録されている例外リスナーへのポインターを取得します。
getHandle C アプリケーションが接続にアクセスするときに使用するハンドルを取得します。
getMetaData 接続のメタデータを取得します。
isNull Connection オブジェクトがヌル・オブジェクトであるかどうかを判別します。
setClientID 接続のクライアント ID を設定します。
setExceptionListener 接続に、例外リスナーを登録します。
start 接続の着信メッセージの配信を開始または再開します。
stop 接続の着信メッセージの配信を停止します。

close – 接続のクローズ

インターフェース:
xmsVOID close();

接続を閉じます。

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

パラメーター:
なし
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

createSession – セッションの作成

インターフェース:
Session createSession(const xmsBOOL transacted,
const xmsINT acknowledgeMode);

セッションを作成します。

パラメーター:
transacted (入力)
xmsTRUE は、セッションが処理済みであることを意味します。値 xmsFALSE は、セッションが処理されていないことを意味します。

ブローカーへのリアルタイム接続の場合、値は xmsFALSE である必要があります。

acknowledgeMode (入力)
アプリケーションが受信するメッセージが応答される方法を示します。値は、以下の肯定応答モードのいずれかでなければなりません。
  • XMSC_AUTO_ACKNOWLEDGE
  • XMSC_CLIENT_ACKNOWLEDGE
  • XMSC_DUPS_OK_ACKNOWLEDGE
ブローカーへのリアルタイム接続の場合、値は XMSC_AUTO_ACKNOWLEDGE または XMSC_DUPS_OK_ACKNOWLEDGE である必要があります。

セッションが処理済みの場合、このパラメーターは無視されます。肯定応答モードについて詳しくは、セッションでのメッセージの受信の確認を参照してください。

戻り値:
Session オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

getClientID – クライアント ID の取得

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

接続のクライアント ID を取得します。

ブローカーへのリアルタイム接続の場合、このメソッドは無効です。

パラメーター:
なし
戻り値:
クライアント ID をカプセル化している String オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

getExceptionListener – 例外リスナーの取得

インターフェース:
ExceptionListener * getExceptionListener() const;

接続に登録されている例外リスナーへのポインターを取得します。

例外リスナーの使用について詳しくは、C++ での例外リスナーの使用法を参照してください。

パラメーター:
なし
戻り値:
例外リスナーへのポインター。接続に例外リスナーが登録されていない場合、このメソッドでは NULL ポインターが戻されます。
例外:
  • XMS_X_GENERAL_EXCEPTION

getHandle – ハンドルの取得

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

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

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

getMetaData – メタデータの取得

インターフェース:
ConnectionMetaData getMetaData() const;

接続のメタデータを取得します。

パラメーター:
なし
戻り値:
ConnectionMetaData オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

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

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

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

setClientID – クライアント ID の設定

インターフェース:
xmsVOID setClientID(const String & clientID);

接続のクライアント ID を設定します。クライアント ID は、パブリッシュ/サブスクライブ・ドメイン内の永続サブスクリプションをサポートするためだけに使用され、Point-to-Point ドメインでは無視されます。

アプリケーションがこのメソッドを呼び出して接続のクライアント ID を設定する場合、アプリケーションは、接続の作成の直後に、接続で他の操作を実行する前にこの設定を行う必要があります。アプリケーションが、この時点よりも後に、このメソッドの呼び出しを試行すると、呼び出しは例外 XMS_X_ILLEGAL_STATE_EXCEPTION をスローします。

ブローカーへのリアルタイム接続の場合、このメソッドは無効です。

パラメーター:
clientID (入力)
クライアント ID をカプセル化している String オブジェクト。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_ILLEGAL_STATE_EXCEPTION
  • XMS_X_INVALID_CLIENTID_EXCEPTION

setExceptionListener – 例外リスナーの設定

インターフェース:
xmsVOID setExceptionListener(const ExceptionListener *lsr);

接続に、例外リスナーを登録します。

例外リスナーの使用について詳しくは、C++ での例外リスナーの使用法を参照してください。

パラメーター:
lsr (入力)
例外リスナーへのポインター。

接続に例外リスナーが既に登録されている場合、代わりに NULL ポインターを指定することによって、登録を取り消すことができます。

戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

start – 接続の開始

インターフェース:
xmsVOID start() const;

接続の着信メッセージの配信を開始または再開します。接続が既に開始されている場合、呼び出しは無視されます。

パラメーター:
なし
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

stop – 接続の停止

インターフェース:
xmsVOID stop() const;

接続の着信メッセージの配信を停止します。接続が既に停止されている場合、呼び出しは無視されます。

パラメーター:
なし
戻り値:
Void
例外:
  • 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)