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

MessageProducer

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

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

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

メソッド

メソッドの要約:
メソッド 説明
close メッセージ・プロデューサーを閉じます。
getDeliveryMode メッセージ・プロデューサーによって送信されるメッセージのデフォルト送達モードを取得します。
getDestination メッセージ・プロデューサーの宛先を取得します。
getDisableMsgID 受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれていることを要求するかどうかの標識を取得します。
getDisableMsgTS 受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれていることを要求するかどうかの標識を取得します。
getHandle C アプリケーションがメッセージ・プロデューサーにアクセスするときに使用するハンドルを取得します。
getPriority メッセージ・プロデューサーによって送信されるメッセージのデフォルト優先順位を取得します。
getTimeToLive 有効期限が切れるまでの、メッセージが存続するデフォルトの時間長を取得します。
isNull MessageProducer オブジェクトがヌル・オブジェクトであるかどうかを判別します。
send メッセージ・プロデューサーが作成されたときに指定された宛先に、メッセージを送信します。メッセージ・プロデューサーのデフォルト送達モード、優先順位、および存続時間を使用してメッセージを送信します。
send メッセージ・プロデューサーが作成されたときに指定された宛先に、メッセージを送信します。指定された送達モード、優先順位、および存続時間を使用してメッセージを送信します。
send メッセージ・プロデューサーの作成時に宛先が指定されなかったメッセージ・プロデューサーを使用する場合に、指定した宛先にメッセージを送信します。メッセージ・プロデューサーのデフォルト送達モード、優先順位、および存続時間を使用してメッセージを送信します。
send メッセージ・プロデューサーの作成時に宛先が指定されなかったメッセージ・プロデューサーを使用する場合に、指定した宛先にメッセージを送信します。指定された送達モード、優先順位、および存続時間を使用してメッセージを送信します。
setDeliveryMode メッセージ・プロデューサーによって送信されるメッセージのデフォルト送達モードを設定します。
setDisableMsgID 受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれることを要求するかどうかを示します。
setDisableMsgTS 受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれることを要求するかどうかを示します。
setPriority メッセージ・プロデューサーによって送信されるメッセージのデフォルト優先順位を設定します。
setTimeToLive 有効期限が切れるまでの、メッセージが存続するデフォルトの時間長を設定します。

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

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

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

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

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

getDeliveryMode – デフォルト送達モードの取得

インターフェース:
xmsINT getDeliveryMode() const;

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

パラメーター:
なし
戻り値:
デフォルトの送達モード。以下の値のいずれかです。
  • XMSC_DELIVERY_PERSISTENT
  • XMSC_DELIVERY_NON_PERSISTENT

ブローカーへのリアルタイム接続の場合、メソッドは常に XMSC_DELIVERY_NON_PERSISTENT を戻します。

例外:
  • XMS_X_GENERAL_EXCEPTION

getDestination – 宛先の取得

インターフェース:
Destination getDestination() const;

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

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

getDisableMsgID – メッセージ ID の使用不可化フラグの取得

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

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

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

getDisableMsgTS – タイム・スタンプの使用不可化フラグの取得

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

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

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

getHandle – ハンドルの取得

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

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

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

getPriority – デフォルト優先順位の取得

インターフェース:
xmsINT getPriority() const;

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

パラメーター:
なし
戻り値:
デフォルトのメッセージ優先順位。値は 0 (最低優先順位) から 9 (最高優先順位) までの整数です。
例外:
  • XMS_X_GENERAL_EXCEPTION

getTimeToLive – デフォルト存続時間の取得

インターフェース:
xmsLONG getTimeToLive() const;

有効期限が切れるまでの、メッセージが存続するデフォルトの時間長を取得します。時間は、メッセージ・プロデューサーがメッセージを送信した時点からの時間です。

パラメーター:
なし
戻り値:
デフォルト存続時間 (ミリ秒単位)。値 0 は、メッセージの有効期限がないことを意味します。

ブローカーへのリアルタイム接続の場合、常にメソッドは 0 を戻します。

例外:
  • XMS_X_GENERAL_EXCEPTION

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

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

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

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

send – 送信

インターフェース:
xmsVOID send(const Message & message) const;

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

パラメーター:
message (入力)
Message オブジェクト。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_FORMAT_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION

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

インターフェース:
xmsVOID send(const Message & message,
const xmsINT deliveryMode,
const xmsINT priority,
const xmsLONG timeToLive) const;

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

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

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

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

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

インターフェース:
xmsVOID send(const Destination & destination,
const Message & message) const;

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

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

パラメーター:
destination (入力)
Destination オブジェクト。
message (入力)
Message オブジェクト。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_FORMAT_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION

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

インターフェース:
xmsVOID send(const Destination & destination,
const Message & message,
const xmsINT deliveryMode,
const xmsINT priority,
const xmsLONG timeToLive) const;

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

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

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

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

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

setDeliveryMode – デフォルト送達モードの設定

インターフェース:
xmsVOID setDeliveryMode(const xmsINT deliveryMode);

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

パラメーター:
deliveryMode (入力)
デフォルトの送達モード。以下の値のいずれかでなければなりません。
  • XMSC_DELIVERY_PERSISTENT
  • XMSC_DELIVERY_NON_PERSISTENT

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

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

戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setDisableMsgID – メッセージ ID の使用不可化フラグの設定

インターフェース:
xmsVOID setDisableMsgID(const xmsBOOL msgIDDisabled);

受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれることを要求するかどうかを示します。

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

パラメーター:
msgIDDisabled (入力)
xmsTRUE は、受信側アプリケーションにとって、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれている必要がないことを意味します。値 xmsFALSEは、受信側アプリケーションがメッセージ ID を必要とすることを意味します。デフォルト値は xmsFALSE です。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setDisableMsgTS – タイム・スタンプの使用不可化フラグ

インターフェース:
xmsVOID setDisableMsgTS(const xmsBOOL timeStampDisabled);

受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれることを要求するかどうかを示します。

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

パラメーター:
timeStampDisabled (入力)
xmsTRUE は、受信側アプリケーションにとって、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれている必要がないことを意味します。 値 xmsFALSEは、受信側アプリケーションがタイム・スタンプを必要とすることを意味します。デフォルト値は xmsFALSE です。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setPriority – デフォルト優先順位の設定

インターフェース:
xmsVOID setPriority(const xmsINT priority);

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

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

パラメーター:
priority (入力)
デフォルトのメッセージ優先順位。値は 0 (最低優先順位) から 9 (最高優先順位) までの整数です。デフォルト値は 4 です。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setTimeToLive – デフォルト存続時間の設定

インターフェース:
xmsVOID setTimeToLive(const xmsLONG timeToLive);

有効期限が切れるまでの、メッセージが存続するデフォルトの時間長を設定します。時間は、メッセージ・プロデューサーがメッセージを送信した時点からの時間です。

パラメーター:
timeToLive (入力)
デフォルト存続時間 (ミリ秒単位)。デフォルト値は 0 です。これはメッセージの有効期限がないことを意味します。ブローカーへのリアルタイム接続の場合、値は 0 である必要があります。
戻り値:
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)