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

MessageConsumer

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

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

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

メソッド

メソッドの要約:
メソッド 説明
close メッセージ・コンシューマーを閉じます。
getHandle C アプリケーションがメッセージ・コンシューマーにアクセスするときに使用するハンドルを取得します。
getMessageListener メッセージ・コンシューマーに登録されているメッセージ・リスナーへのポインターを取得します。
getMessageSelector メッセージ・コンシューマーのメッセージ・セレクターを取得します。
isNull MessageConsumer オブジェクトがヌル・オブジェクトであるかどうかを判別します。
receive メッセージ・コンシューマーの次のメッセージを受け取ります。この呼び出しでは、無期限にメッセージを待機し続けるか、メッセージ・コンシューマーがクローズされるまで待機します。
receive メッセージ・コンシューマーの次のメッセージを受け取ります。この呼び出しでは、指定される期間だけメッセージを待機するか、メッセージ・コンシューマーがクローズされるまで待機します。
receiveNoWait メッセージ・コンシューマーの次のメッセージが即時に受信可能である場合に、そのメッセージを受け取ります。
setMessageListener メッセージ・コンシューマーに、メッセージ・リスナーを登録します。

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

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

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

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

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

getHandle – ハンドルの取得

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

C アプリケーションがメッセージ・コンシューマーにアクセスするときに使用するハンドルを取得します。

パラメーター:
なし
戻り値:
メッセージ・コンシューマーのハンドル。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
MessageListener * getMessageListener() const;

メッセージ・コンシューマーに登録されているメッセージ・リスナーへのポインターを取得します。

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

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

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

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

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

パラメーター:
なし
戻り値:
メッセージ・セレクター式をカプセル化している String オブジェクト。データ変換が必要な場合、これは変換後のメッセージ・セレクター式です。 メッセージ・コンシューマーにメッセージ・セレクターが存在しない場合、このメソッドはヌルの String オブジェクトを戻します。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

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

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

パラメーター:
なし
戻り値:
  • MessageConsumer オブジェクトがヌル・オブジェクトの場合は、xmsTRUE
  • MessageConsumer オブジェクトがヌル・オブジェクトでない場合は、xmsFALSE
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

receive – 受信

インターフェース:
Message * receive() const;

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

パラメーター:
なし
戻り値:
Message オブジェクトへのポインター。呼び出しがメッセージを待機している間にメッセージ・コンシューマーを閉じると、メソッドは、ヌルの Message オブジェクトを指すポインターを戻します。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
Message * receive(const xmsLONG waitInterval) const;

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

パラメーター:
waitInterval (入力)
呼び出しがメッセージを待機する時間 (ミリ秒単位)。待機間隔を 0 と指定した場合、呼び出しは無期限にメッセージを待機します。
戻り値:
Message オブジェクトへのポインター。待機間隔の間にメッセージが到着しなかった場合や、呼び出しがメッセージを待機している間にメッセージ・コンシューマーを閉じると、メソッドは、ヌルの Message オブジェクトを指すポインターを戻しますが、例外はスローしません。
例外:
  • XMS_X_GENERAL_EXCEPTION

receiveNoWait – 待機なしの受信

インターフェース:
Message * receiveNoWait() const;

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

パラメーター:
なし
戻り値:
Message オブジェクトへのポインター。即時に有効なメッセージがない場合、メソッドは、ヌルの Message オブジェクトを指すポインターを戻します。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsVOID setMessageListener(const MessageListener *lsr);

メッセージ・コンシューマーに、メッセージ・リスナーを登録します。

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

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