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

IMessageProducer

アプリケーションは、メッセージ・プロデューサーを使用して、メッセージを宛先へ送信します。

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

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

.NET プロパティー

.NET プロパティーの要約:
.NET プロパティー 説明
DeliveryMode メッセージ・プロデューサーによって送信されるメッセージのデフォルト送達モードを取得および設定します。
Destination メッセージ・プロデューサーの宛先を取得します。
DisableMsgID 受信側アプリケーションにとって、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれている必要があるかどうかの標識を取得し、受信側アプリケーションにとって、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれている必要があるかどうかを示します。
DisableMsgTS 受信側アプリケーションにとって、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれている必要があるかどうかの標識を取得し、受信側アプリケーションにとって、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれている必要があるかどうかを示します。
Priority メッセージ・プロデューサーによって送信されるメッセージのデフォルト優先順位を取得および設定します。
TimeToLive 有効期限が切れるまでの、メッセージが存続するデフォルトの時間長を取得および設定します。

DeliveryMode – デフォルト送達モードの取得および設定

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

メッセージ・プロデューサーによって送信されるメッセージのデフォルト送達モードを取得および設定します。

デフォルトの送達モードは、以下の値のいずれかです。

  • DeliveryMode.Persistent
  • DeliveryMode.NonPersistent

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

デフォルト値は DeliveryMode.Persistent です。ただし、デフォルト値が DeliveryMode.NonPersistent となるブローカーへのリアルタイム接続の場合を除きます。

例外:
  • XMSException

Destination – 宛先の取得

インターフェース:
IDestination Destination
{
get;
}

メッセージ・プロデューサーの宛先を取得します。

パラメーター:
なし
戻り値:
Destination オブジェクト。メッセージ・プロデューサーに宛先が存在しない場合、このメソッドはヌルの Destination オブジェクトを戻します。
例外:
  • XMSException

DisableMsgID – メッセージ ID の使用不可化フラグの取得および設定

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

受信側アプリケーションにとって、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれている必要があるかどうかの標識を取得し、受信側アプリケーションにとって、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれている必要があるかどうかを示します。

キュー・マネージャーへの接続またはブローカーへのリアルタイム接続では、このフラグは無視されます。サービス統合バスへの接続では、フラグが尊重されます。

DisabledMsgID の値は、以下のとおりです。

  • 受信側アプリケーションにとって、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれている必要がない場合は、True です。
  • 受信側アプリケーションにとって、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれている必要がある場合は、False です。
例外:
  • XMSException

DisableMsgTS – タイム・スタンプの使用不可化フラグの取得および設定

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

受信側アプリケーションにとって、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれている必要があるかどうかの標識を取得し、受信側アプリケーションにとって、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれている必要があるかどうかを示します。

ブローカーへのリアルタイム接続では、このフラグは無視されます。キュー・マネージャーへの接続またはサービス統合バスへの接続では、フラグは尊重されます。

DisableMsgTS の値は、以下のとおりです。

  • 受信側アプリケーションにとって、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれている必要がない場合は、True です。
  • 受信側アプリケーションにとって、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれている必要がある場合は、False です。
戻り値:
例外:
  • XMSException

Priority – デフォルト優先順位の取得および設定

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

メッセージ・プロデューサーによって送信されるメッセージのデフォルト優先順位を取得および設定します。

デフォルトのメッセージ優先順位の値は、0 (最低優先順位) から 9 (最高優先順位) までの整数です。

ブローカーへのリアルタイム接続では、メッセージの優先順位は無視されます。

例外:
  • XMSException

TimeToLive – デフォルト存続時間の取得および設定

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

有効期限が切れるまでの、メッセージが存続するデフォルトの時間長を取得および設定します。

時間は、メッセージ・プロデューサーがメッセージを送信した時刻とデフォルトの存続時間を基に、ミリ秒単位で測定します。 値 0 は、メッセージの有効期限がないことを意味します。

ブローカーへのリアルタイム接続の場合、この値は常に 0 です。

例外:
  • XMSException

メソッド

メソッドの要約:
メソッド 説明
Close メッセージ・プロデューサーを閉じます。
Send メッセージ・プロデューサーが作成されたときに指定された宛先に、メッセージを送信します。メッセージ・プロデューサーのデフォルト送達モード、優先順位、および存続時間を使用してメッセージを送信します。
Send メッセージ・プロデューサーが作成されたときに指定された宛先に、メッセージを送信します。指定された送達モード、優先順位、および存続時間を使用してメッセージを送信します。
Send メッセージ・プロデューサーの作成時に宛先が指定されなかったメッセージ・プロデューサーを使用する場合に、指定した宛先にメッセージを送信します。メッセージ・プロデューサーのデフォルト送達モード、優先順位、および存続時間を使用してメッセージを送信します。
Send メッセージ・プロデューサーの作成時に宛先が指定されなかったメッセージ・プロデューサーを使用する場合に、指定した宛先にメッセージを送信します。指定された送達モード、優先順位、および存続時間を使用してメッセージを送信します。

Close – メッセージ・プロデューサーのクローズ

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

メッセージ・プロデューサーを閉じます。

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

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

Send – 送信

インターフェース:
void Send(IMessage msg) ;

メッセージ・プロデューサーが作成されたときに指定された宛先に、メッセージを送信します。メッセージ・プロデューサーのデフォルト送達モード、優先順位、および存続時間を使用してメッセージを送信します。

パラメーター:
msg (入力)
Message オブジェクト。
戻り値:
void
例外:
  • XMSException
  • MessageFormatException
  • InvalidDestinationException

Send – 送信 (送達モード、優先順位、および存続時間を指定)

インターフェース:
void Send(IMessage msg,
DeliveryMode deliveryMode,
Int32 priority,
Int64 timeToLive);

メッセージ・プロデューサーが作成されたときに指定された宛先に、メッセージを送信します。指定された送達モード、優先順位、および存続時間を使用してメッセージを送信します。

パラメーター:
msg (入力)
Message オブジェクト。
deliveryMode (入力)
メッセージの送達モード。以下の値のいずれかでなければなりません。
  • DeliveryMode.Persistent
  • DeliveryMode.NonPersistent

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

priority (入力)
メッセージの優先順位。値は 0 (最低優先順位) から 9 (最高優先順位) までの整数です。ブローカーへのリアルタイム接続では、値は無視されます。
timeToLive (入力)
メッセージの存続時間 (ミリ秒単位)。値 0 は、メッセージの有効期限がないことを意味します。ブローカーへのリアルタイム接続の場合、値は 0 である必要があります。
戻り値:
void
例外:
  • XMSException
  • MessageFormatException
  • InvalidDestinationException
  • IllegalStateException

Send – 送信 (指定された宛先へ)

インターフェース:
void Send(IDestination dest, IMessage msg) ;

メッセージ・プロデューサーの作成時に宛先が指定されなかったメッセージ・プロデューサーを使用する場合に、指定した宛先にメッセージを送信します。メッセージ・プロデューサーのデフォルト送達モード、優先順位、および存続時間を使用してメッセージを送信します。

通常、メッセージ・プロデューサーの作成時には宛先を指定しますが、宛先を指定しない場合、メッセージの送信ごとに宛先を指定する必要があります。

パラメーター:
dest (入力)
Destination オブジェクト。
msg (入力)
Message オブジェクト。
戻り値:
void
例外:
  • XMSException
  • MessageFormatException
  • InvalidDestinationException

Send – 送信 (送達モード、優先順位、および存続時間を指定して、指定された宛先へ)

インターフェース:
void Send(IDestination dest,
IMessage msg,
DeliveryMode deliveryMode,
Int32 priority,
Int64 timeToLive) ;

メッセージ・プロデューサーの作成時に宛先が指定されなかったメッセージ・プロデューサーを使用する場合に、指定した宛先にメッセージを送信します。指定された送達モード、優先順位、および存続時間を使用してメッセージを送信します。

通常、メッセージ・プロデューサーの作成時には宛先を指定しますが、宛先を指定しない場合、メッセージの送信ごとに宛先を指定する必要があります。

パラメーター:
dest (入力)
Destination オブジェクト。
msg (入力)
Message オブジェクト。
deliveryMode (入力)
メッセージの送達モード。以下の値のいずれかでなければなりません。
  • DeliveryMode.Persistent
  • DeliveryMode.NonPersistent

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

priority (入力)
メッセージの優先順位。値は 0 (最低優先順位) から 9 (最高優先順位) までの整数です。ブローカーへのリアルタイム接続では、値は無視されます。
timeToLive (入力)
メッセージの存続時間 (ミリ秒単位)。値 0 は、メッセージの有効期限がないことを意味します。ブローカーへのリアルタイム接続の場合、値は 0 である必要があります。
戻り値:
void
例外:
  • XMSException
  • MessageFormatException
  • InvalidDestinationException
  • IllegalStateException

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


Reference topic

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

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