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

Connection

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

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

関数

関数の要約:
関数 説明
xmsConnClose 接続を閉じます。
xmsConnCreateSession セッションを作成します。
xmsConnGetClientID 接続のクライアント ID を取得します。
xmsConnGetExceptionListener 接続に登録されている例外リスナー関数およびコンテキスト・データへのポインターを取得します。
xmsConnGetMetaData 接続のメタデータを取得します。
xmsConnSetClientID 接続のクライアント ID を設定します。
xmsConnSetExceptionListener 接続に、例外リスナー関数およびコンテキスト・データを登録します。
xmsConnStart 接続の着信メッセージの配信を開始または再開します。
xmsConnStop 接続の着信メッセージの配信を停止します。

xmsConnClose – 接続のクローズ

インターフェース:
xmsRC xmsConnClose(xmsHConn *connection,
xmsHErrorBlock errorBlock);

接続を閉じます。

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

パラメーター:
connection (入出力)
入力では、接続のハンドル。出力で、関数は NULL ハンドルを戻します。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsConnCreateSession – セッションの作成

インターフェース:
xmsRC xmsConnCreateSession(xmsHConn connection,
xmsBOOL transacted,
xmsINT acknowledgeMode,
xmsHSess *session,
xmsHErrorBlock errorBlock);

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

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

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

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

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

session (出力)
セッションのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsConnGetClientID(xmsHConn connection,
xmsCHAR *clientID,
xmsINT length,
xmsINT *actualLength,
xmsHErrorBlock errorBlock);

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

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

この関数の使用方法について詳しくは、値によりストリングを戻す C 関数を参照してください。

パラメーター:
connection (入力)
接続のハンドル。
clientID (出力)
クライアント ID を含むバッファー。
length (入力)
バッファーの長さ (バイト単位)。その代わりに XMSC_QUERY_SIZE を指定すると、クライアント ID は戻されませんが、actualLength パラメーターでクライアント ID の長さが戻されます。
actualLength (出力)
クライアント ID の長さ (バイト単位)。データ変換が必要な場合、これは変換後のクライアント ID の長さです。入力に NULL ポインターを指定すると、長さが戻されません。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsConnGetExceptionListener – 例外リスナーの取得

インターフェース:
xmsRC xmsConnGetExceptionListener(xmsHConn connection,
fpXMS_EXCEPTION_CALLBACK *lsr,
xmsCONTEXT *context,
xmsHErrorBlock errorBlock);

接続に登録されている例外リスナー関数およびコンテキスト・データへのポインターを取得します。

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

パラメーター:
connection (入力)
接続のハンドル。
lsr (出力)
例外リスナー関数へのポインター。接続に例外リスナー関数が登録されていない場合、この呼び出しでは NULL ポインターが戻されます。
context (出力)
コンテキスト・データへのポインター。接続に例外リスナー関数が登録されていない場合、この呼び出しでは NULL ポインターが戻されます。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsConnGetMetaData – メタデータの取得

インターフェース:
xmsRC xmsConnGetMetaData(xmsHConn connection,
xmsHConnMetaData *connectionMetaData,
xmsHErrorBlock errorBlock);

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

パラメーター:
connection (入力)
接続のハンドル。
connectionMetaData (出力)
接続メタデータのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsConnSetClientID(xmsHConn connection,
xmsCHAR *clientID,
xmsINT length,
xmsHErrorBlock errorBlock)

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

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

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

パラメーター:
connection (入力)
接続のハンドル。
clientID (入力)
文字配列としてのクライアント ID。
length (入力)
クライアント ID の長さ (バイト単位)。クライアント ID がヌルで、終了文字としてヌル文字が埋め込まれていない場合、代わりに XMSC_CALCULATE_STRING_SIZE を指定して、XMS がクライアント ID の長さを計算できるようにすることも可能です。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_ILLEGAL_STATE_EXCEPTION
  • XMS_X_INVALID_CLIENTID_EXCEPTION

xmsConnSetExceptionListener – 例外リスナーの設定

インターフェース:
xmsRC xmsConnSetExceptionListener(xmsHConn connection,
fpXMS_EXCEPTION_CALLBACK lsr,
xmsCONTEXT context,
xmsHErrorBlock errorBlock);

接続に、例外リスナー関数およびコンテキスト・データを登録します。

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

パラメーター:
connection (入力)
接続のハンドル。
lsr (入力)
例外リスナー関数へのポインター。接続に例外リスナー関数が既に登録されている場合、代わりに NULL ポインターを指定することによって、登録を取り消すことができます。
context (入力)
コンテキスト・データへのポインター。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsConnStart – 接続の開始

インターフェース:
xmsRC xmsConnStart(xmsHConn connection,
xmsHErrorBlock errorBlock);

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

パラメーター:
connection (入力)
接続のハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsConnStop – 接続の停止

インターフェース:
xmsRC xmsConnStop(xmsHConn connection,
xmsHErrorBlock errorBlock);

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

パラメーター:
connection (入力)
接続のハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • 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)