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

IMessageConsumer

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

継承の階層:
IBM.XMS.IPropertyContext
|
+----IBM.XMS.IMessageConsumer

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

.NET プロパティー

.NET プロパティーの要約:
.NET プロパティー 説明
MessageListener メッセージ・コンシューマーに登録されているメッセージ・リスナーを取得し、メッセージ・リスナーをメッセージ・コンシューマーに登録します。
MessageSelector メッセージ・コンシューマーのメッセージ・セレクターを取得します。

MessageListener – メッセージ・リスナーの取得および設定

インターフェース:
MessageListener MessageListener
{
get;
set;
}

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

メッセージ・コンシューマーにメッセージ・リスナーが登録されていない場合、MessageListener は NULL です。 メッセージ・コンシューマーにメッセージ・リスナーが既に登録されている場合、代わりに NULL を指定することによって、登録を取り消すことができます。

メッセージ・リスナーの使用について詳しくは、.NET でのメッセージ・リスナーおよび例外リスナーの使用法を参照してください。

例外:
  • XMSException

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

インターフェース:
String MessageSelector
{
get;
}

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

例外:
  • XMSException

メソッド

メソッドの要約:
メソッド 説明
Close メッセージ・コンシューマーを閉じます。
Receive メッセージ・コンシューマーの次のメッセージを受け取ります。この呼び出しでは、無期限にメッセージを待機し続けるか、メッセージ・コンシューマーがクローズされるまで待機します。
Receive メッセージ・コンシューマーの次のメッセージを受け取ります。この呼び出しでは、指定される期間だけメッセージを待機するか、メッセージ・コンシューマーがクローズされるまで待機します。
ReceiveNoWait メッセージ・コンシューマーの次のメッセージが即時に受信可能である場合に、そのメッセージを受け取ります。

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

インターフェース:
void Close();

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

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

パラメーター:
なし
戻り値:
void
例外:
  • XMSException

Receive – 受信

インターフェース:
IMessage Receive();

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

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

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

インターフェース:
IMessage Receive(Int64 delay);

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

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

ReceiveNoWait – 待機なしの受信

インターフェース:
IMessage ReceiveNoWait();

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

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

継承されたプロパティーおよびメソッド


Reference topic

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

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