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

MessageProducer

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

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

関数

関数の要約:
関数 説明
xmsMsgProducerClose メッセージ・プロデューサーを閉じます。
xmsMsgProducerGetDeliveryMode メッセージ・プロデューサーによって送信されるメッセージのデフォルト送達モードを取得します。
xmsMsgProducerGetDestination メッセージ・プロデューサーの宛先を取得します。
xmsMsgProducerGetDisableMsgID 受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれていることを要求するかどうかの標識を取得します。
xmsMsgProducerGetDisableMsgTS 受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれていることを要求するかどうかの標識を取得します。
xmsMsgProducerGetPriority メッセージ・プロデューサーによって送信されるメッセージのデフォルト優先順位を取得します。
xmsMsgProducerGetTimeToLive 有効期限が切れるまでの、メッセージが存続するデフォルトの時間長を取得します。
xmsMsgProducerSend メッセージ・プロデューサーが作成されたときに指定された宛先に、メッセージを送信します。メッセージ・プロデューサーのデフォルト送達モード、優先順位、および存続時間を使用してメッセージを送信します。
xmsMsgProducerSendDest メッセージ・プロデューサーの作成時に宛先が指定されなかったメッセージ・プロデューサーを使用する場合に、指定した宛先にメッセージを送信します。メッセージ・プロデューサーのデフォルト送達モード、優先順位、および存続時間を使用してメッセージを送信します。
xmsMsgProducerSendDestWithAttr メッセージ・プロデューサーの作成時に宛先が指定されなかったメッセージ・プロデューサーを使用する場合に、指定した宛先にメッセージを送信します。指定された送達モード、優先順位、および存続時間を使用してメッセージを送信します。
xmsMsgProducerSendWithAttr メッセージ・プロデューサーが作成されたときに指定された宛先に、メッセージを送信します。指定された送達モード、優先順位、および存続時間を使用してメッセージを送信します。
xmsMsgProducerSetDeliveryMode メッセージ・プロデューサーによって送信されるメッセージのデフォルト送達モードを設定します。
xmsMsgProducerSetDisableMsgID 受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれることを要求するかどうかを示します。
xmsMsgProducerSetDisableMsgTS 受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれることを要求するかどうかを示します。
xmsMsgProducerSetPriority メッセージ・プロデューサーによって送信されるメッセージのデフォルト優先順位を設定します。
xmsMsgProducerSetTimeToLive 有効期限が切れるまでの、メッセージが存続するデフォルトの時間長を設定します。

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

インターフェース:
xmsRC xmsMsgProducerClose(xmsHMsgProducer *producer,
xmsHErrorBlock errorBlock);

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

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

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

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

インターフェース:
xmsRC xmsMsgProducerGetDeliveryMode(xmsHMsgProducer producer,
xmsINT *deliveryMode,
xmsHErrorBlock errorBlock);

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

パラメーター:
producer (入力)
メッセージ・プロデューサーのハンドル。
deliveryMode (出力)
デフォルトの送達モード。以下の値のいずれかです。
  • XMSC_DELIVERY_PERSISTENT
  • XMSC_DELIVERY_NON_PERSISTENT

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

errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgProducerGetDestination – 宛先の取得

インターフェース:
xmsRC xmsMsgProducerGetDestination(xmsHMsgProducer producer,
xmsHDest *destination,
xmsHErrorBlock errorBlock);

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

パラメーター:
producer (入力)
メッセージ・プロデューサーのハンドル。
destination (出力)
宛先のハンドル。メッセージ・プロデューサーに宛先がない場合、関数は NULL ハンドルを戻します。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsMsgProducerGetDisableMsgID(xmsHMsgProducer producer,
xmsBOOL *msgIDDisabled,
xmsHErrorBlock errorBlock);

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

パラメーター:
producer (入力)
メッセージ・プロデューサーのハンドル。
msgIDDisabled (出力)
受信側アプリケーションにとって、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれている必要がない場合、値は xmsTRUE です。受信側アプリケーションがメッセージ ID を必要とする場合、値は xmsFALSE です。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsMsgProducerGetDisableMsgTS(xmsHMsgProducer producer,
xmsBOOL *timeStampDisabled,
xmsHErrorBlock errorBlock);

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

パラメーター:
producer (入力)
メッセージ・プロデューサーのハンドル。
timeStampDisabled (出力)
受信側アプリケーションにとって、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれている必要がない場合、値は xmsTRUE です。受信側アプリケーションがタイム・スタンプを必要とする場合、値は xmsFALSE です。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsMsgProducerGetPriority(xmsHMsgProducer producer,
xmsINT *priority,
xmsHErrorBlock errorBlock);

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

パラメーター:
producer (入力)
メッセージ・プロデューサーのハンドル。
priority (出力)
デフォルトのメッセージ優先順位。値は 0 (最低優先順位) から 9 (最高優先順位) までの整数です。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsMsgProducerGetTimeToLive(xmsHMsgProducer producer,
xmsLONG *timeToLive,
xmsHErrorBlock errorBlock);

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

パラメーター:
producer (入力)
メッセージ・プロデューサーのハンドル。
timeToLive (出力)
デフォルト存続時間 (ミリ秒単位)。値 0 は、メッセージの有効期限がないことを意味します。ブローカーへのリアルタイム接続の場合、値は常に 0 です。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgProducerSend – 送信

インターフェース:
xmsRC xmsMsgProducerSend(xmsHMsgProducer producer,
xmsHMsg message,
xmsHErrorBlock errorBlock);

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

パラメーター:
producer (入力)
メッセージ・プロデューサーのハンドル。
message (入力)
メッセージのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_FORMAT_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION

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

インターフェース:
xmsRC xmsMsgProducerSendDest(xmsHMsgProducer producer,
xmsHDest destination,
xmsHMsg message,
xmsHErrorBlock errorBlock);

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

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

パラメーター:
producer (入力)
メッセージ・プロデューサーのハンドル。
destination (入力)
宛先のハンドル。
message (入力)
メッセージのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_FORMAT_EXCEPTION
  • XMS_X_INVALID_DESTINATION_EXCEPTION

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

インターフェース:
xmsRC xmsMsgProducerSendDestWithAttr(xmsHMsgProducer producer,
xmsHDest destination,
xmsHMsg message,
xmsINT deliveryMode,
xmsINT priority,
xmsLONG timeToLive,
xmsHErrorBlock errorBlock);

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

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

パラメーター:
producer (入力)
メッセージ・プロデューサーのハンドル。
destination (入力)
宛先のハンドル。
message (入力)
メッセージのハンドル。
deliveryMode (入力)
メッセージの送達モード。以下の値のいずれかでなければなりません。
  • XMSC_DELIVERY_PERSISTENT
  • XMSC_DELIVERY_NON_PERSISTENT

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

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

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

インターフェース:
xmsRC xmsMsgProducerSendWithAttr(xmsHMsgProducer producer,
xmsHMsg message,
xmsINT deliveryMode,
xmsINT priority,
xmsLONG timeToLive,
xmsHErrorBlock errorBlock);

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

パラメーター:
producer (入力)
メッセージ・プロデューサーのハンドル。
message (入力)
メッセージのハンドル。
deliveryMode (入力)
メッセージの送達モード。以下の値のいずれかでなければなりません。
  • XMSC_DELIVERY_PERSISTENT
  • XMSC_DELIVERY_NON_PERSISTENT

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

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

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

インターフェース:
xmsRC xmsMsgProducerSetDeliveryMode(xmsHMsgProducer producer,
xmsINT deliveryMode,
xmsHErrorBlock errorBlock);

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

パラメーター:
producer (入力)
メッセージ・プロデューサーのハンドル。
deliveryMode (入力)
デフォルトの送達モード。以下の値のいずれかでなければなりません。
  • XMSC_DELIVERY_PERSISTENT
  • XMSC_DELIVERY_NON_PERSISTENT

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

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

errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsMsgProducerSetDisableMsgID(xmsHMsgProducer producer,
xmsBOOL msgIDDisabled,
xmsHErrorBlock errorBlock);

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

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

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

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

インターフェース:
xmsRC xmsMsgProducerSetDisableMsgTS(xmsHMsgProducer producer,
xmsBOOL timeStampDisabled,
xmsHErrorBlock errorBlock);

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

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

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

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

インターフェース:
xmsRC xmsMsgProducerSetPriority(xmsHMsgProducer producer,
xmsINT priority,
xmsHErrorBlock errorBlock);

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

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

パラメーター:
producer (入力)
メッセージ・プロデューサーのハンドル。
priority (入力)
デフォルトのメッセージ優先順位。値は 0 (最低優先順位) から 9 (最高優先順位) までの整数です。デフォルト値は 4 です。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

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

インターフェース:
xmsRC xmsMsgProducerSetTimeToLive(xmsHMsgProducer producer,
xmsLONG timeToLive,
xmsHErrorBlock errorBlock);

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

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