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

MessageConsumer

アプリケーションは、メッセージ・コンシューマーを使用して、宛先に送信されたメッセージを受信します。

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

関数

関数の要約:
関数 説明
xmsMsgConsumerClose メッセージ・コンシューマーを閉じます。
xmsMsgConsumerGetMessageListener メッセージ・コンシューマーに登録されているメッセージ・リスナー関数およびコンテキスト・データへのポインターを取得します。
xmsMsgConsumerGetMessageSelector メッセージ・コンシューマーのメッセージ・セレクターを取得します。
xmsMsgConsumerReceive メッセージ・コンシューマーの次のメッセージを受け取ります。この呼び出しでは、無期限にメッセージを待機し続けるか、メッセージ・コンシューマーがクローズされるまで待機します。
xmsMsgConsumerReceiveNoWait メッセージ・コンシューマーの次のメッセージが即時に受信可能である場合に、そのメッセージを受け取ります。
xmsMsgConsumerReceiveWithWait メッセージ・コンシューマーの次のメッセージを受け取ります。この呼び出しでは、指定される期間だけメッセージを待機するか、メッセージ・コンシューマーがクローズされるまで待機します。
xmsMsgConsumerSetMessageListener メッセージ・コンシューマーに、メッセージ・リスナー関数およびコンテキスト・データを登録します。

xmsMsgConsumerClose – メッセージ・コンシューマーのクローズ

インターフェース:
xmsRC xmsMsgConsumerClose(xmsHMsgConsumer *consumer,
xmsHErrorBlock errorBlock);

メッセージ・コンシューマーを閉じます。

アプリケーションが、既に閉じているメッセージ・コンシューマーを閉じようとした場合、呼び出しは無視されます。

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

xmsMsgConsumerGetMessageListener – メッセージ・リスナーの取得

インターフェース:
xmsRC xmsMsgConsumerGetMessageListener(xmsHMsgConsumer consumer,
fpXMS_MESSAGE_CALLBACK *lsr,
xmsCONTEXT *context,
xmsHErrorBlock errorBlock);

メッセージ・コンシューマーに登録されているメッセージ・リスナー関数およびコンテキスト・データへのポインターを取得します。

メッセージ・リスナー関数の使用について詳しくは、C でのメッセージ・リスナー関数の使用法を参照してください。

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

xmsMsgConsumerGetMessageSelector – メッセージ・セレクターの取得

インターフェース:
xmsRC xmsMsgConsumerGetMessageSelector(xmsHMsgConsumer consumer,
xmsCHAR *messageSelector,
xmsINT length,
xmsINT *actualLength,
xmsHErrorBlock errorBlock);

メッセージ・コンシューマーのメッセージ・セレクターを取得します。

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

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

xmsMsgConsumerReceive – 受信

インターフェース:
xmsRC xmsMsgConsumerReceive(xmsHMsgConsumer consumer,
xmsHMsg *message,
xmsHErrorBlock errorBlock);

メッセージ・コンシューマーの次のメッセージを受け取ります。この呼び出しでは、無期限にメッセージを待機し続けるか、メッセージ・コンシューマーがクローズされるまで待機します。

パラメーター:
consumer (入力)
メッセージ・コンシューマーのハンドル。
message (出力)
メッセージのハンドル。この呼び出しがメッセージを待機している間にメッセージ・コンシューマーがクローズされた場合、関数は NULL ハンドルを戻します。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgConsumerReceiveNoWait – 待機なしの受信

インターフェース:
xmsRC xmsMsgConsumerReceiveNoWait(xmsHMsgConsumer consumer,
xmsHMsg *message,
xmsHErrorBlock errorBlock);

メッセージ・コンシューマーの次のメッセージが即時に受信可能である場合に、そのメッセージを受け取ります。

パラメーター:
consumer (入力)
メッセージ・コンシューマーのハンドル。
message (出力)
メッセージのハンドル。即時に受信可能なメッセージがない場合、関数は NULL ハンドルを戻します。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgConsumerReceiveWithWait – 受信 (待機間隔あり)

インターフェース:
xmsRC xmsMsgConsumerReceiveWithWait(xmsHMsgConsumer consumer,
xmsLONG waitInterval,
xmsHMsg *message,
xmsHErrorBlock errorBlock);

メッセージ・コンシューマーの次のメッセージを受け取ります。この呼び出しでは、指定される期間だけメッセージを待機するか、メッセージ・コンシューマーがクローズされるまで待機します。

パラメーター:
consumer (入力)
メッセージ・コンシューマーのハンドル。
waitInterval (入力)
呼び出しがメッセージを待機する時間 (ミリ秒単位)。待機間隔を 0 と指定した場合、呼び出しは無期限にメッセージを待機します。
message (出力)
メッセージのハンドル。待機間隔にメッセージが到着しなかった場合、または呼び出しがメッセージを待機している間にメッセージ・コンシューマーがクローズされた場合、関数は NULL ハンドルを戻しますが、エラーは戻しません。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgConsumerSetMessageListener – メッセージ・リスナーの設定

インターフェース:
xmsRC xmsMsgConsumerSetMessageListener(xmsHMsgConsumer consumer,
fpXMS_MESSAGE_CALLBACK lsr,
xmsCONTEXT context,
xmsHErrorBlock errorBlock);

メッセージ・コンシューマーに、メッセージ・リスナー関数およびコンテキスト・データを登録します。

メッセージ・リスナー関数の使用について詳しくは、C でのメッセージ・リスナー関数の使用法を参照してください。

パラメーター:
consumer (入力)
メッセージ・コンシューマーのハンドル。
lsr (入力)
メッセージ・リスナー関数へのポインター。メッセージ・コンシューマーにメッセージ・リスナー関数が既に登録されている場合、代わりに NULL ポインターを指定することによって、登録を取り消すことができます。
context (入力)
コンテキスト・データへのポインター。
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)