アプリケーションは、メッセージ・プロデューサーを使用して、メッセージを宛先へ送信します。
MessageProducer オブジェクトの XMS 定義プロパティーのリストについては、MessageProducer のプロパティーを参照してください。
関数 | 説明 |
---|---|
xmsMsgProducerClose | メッセージ・プロデューサーを閉じます。 |
xmsMsgProducerGetDeliveryMode | メッセージ・プロデューサーによって送信されるメッセージのデフォルト送達モードを取得します。 |
xmsMsgProducerGetDestination | メッセージ・プロデューサーの宛先を取得します。 |
xmsMsgProducerGetDisableMsgID | 受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれていることを要求するかどうかの標識を取得します。 |
xmsMsgProducerGetDisableMsgTS | 受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれていることを要求するかどうかの標識を取得します。 |
xmsMsgProducerGetPriority | メッセージ・プロデューサーによって送信されるメッセージのデフォルト優先順位を取得します。 |
xmsMsgProducerGetTimeToLive | 有効期限が切れるまでの、メッセージが存続するデフォルトの時間長を取得します。 |
xmsMsgProducerSend | メッセージ・プロデューサーが作成されたときに指定された宛先に、メッセージを送信します。メッセージ・プロデューサーのデフォルト送達モード、優先順位、および存続時間を使用してメッセージを送信します。 |
xmsMsgProducerSendDest | メッセージ・プロデューサーの作成時に宛先が指定されなかったメッセージ・プロデューサーを使用する場合に、指定した宛先にメッセージを送信します。メッセージ・プロデューサーのデフォルト送達モード、優先順位、および存続時間を使用してメッセージを送信します。 |
xmsMsgProducerSendDestWithAttr | メッセージ・プロデューサーの作成時に宛先が指定されなかったメッセージ・プロデューサーを使用する場合に、指定した宛先にメッセージを送信します。指定された送達モード、優先順位、および存続時間を使用してメッセージを送信します。 |
xmsMsgProducerSendWithAttr | メッセージ・プロデューサーが作成されたときに指定された宛先に、メッセージを送信します。指定された送達モード、優先順位、および存続時間を使用してメッセージを送信します。 |
xmsMsgProducerSetDeliveryMode | メッセージ・プロデューサーによって送信されるメッセージのデフォルト送達モードを設定します。 |
xmsMsgProducerSetDisableMsgID | 受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれることを要求するかどうかを示します。 |
xmsMsgProducerSetDisableMsgTS | 受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれることを要求するかどうかを示します。 |
xmsMsgProducerSetPriority | メッセージ・プロデューサーによって送信されるメッセージのデフォルト優先順位を設定します。 |
xmsMsgProducerSetTimeToLive | 有効期限が切れるまでの、メッセージが存続するデフォルトの時間長を設定します。 |
xmsRC xmsMsgProducerClose(xmsHMsgProducer *producer, xmsHErrorBlock errorBlock);
アプリケーションが、既に閉じているメッセージ・プロデューサーを閉じようとした場合、呼び出しは無視されます。
xmsRC xmsMsgProducerGetDeliveryMode(xmsHMsgProducer producer, xmsINT *deliveryMode, xmsHErrorBlock errorBlock);
メッセージ・プロデューサーによって送信されるメッセージのデフォルト送達モードを取得します。
ブローカーへのリアルタイム接続の場合、常に値は XMSC_DELIVERY_NON_PERSISTENT です。
xmsRC xmsMsgProducerGetDestination(xmsHMsgProducer producer, xmsHDest *destination, xmsHErrorBlock errorBlock);
xmsRC xmsMsgProducerGetDisableMsgID(xmsHMsgProducer producer, xmsBOOL *msgIDDisabled, xmsHErrorBlock errorBlock);
受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれていることを要求するかどうかの標識を取得します。
xmsRC xmsMsgProducerGetDisableMsgTS(xmsHMsgProducer producer, xmsBOOL *timeStampDisabled, xmsHErrorBlock errorBlock);
受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれていることを要求するかどうかの標識を取得します。
xmsRC xmsMsgProducerGetPriority(xmsHMsgProducer producer, xmsINT *priority, xmsHErrorBlock errorBlock);
メッセージ・プロデューサーによって送信されるメッセージのデフォルト優先順位を取得します。
xmsRC xmsMsgProducerGetTimeToLive(xmsHMsgProducer producer, xmsLONG *timeToLive, xmsHErrorBlock errorBlock);
有効期限が切れるまでの、メッセージが存続するデフォルトの時間長を取得します。時間は、メッセージ・プロデューサーがメッセージを送信した時点からの時間です。
xmsRC xmsMsgProducerSend(xmsHMsgProducer producer, xmsHMsg message, xmsHErrorBlock errorBlock);
メッセージ・プロデューサーが作成されたときに指定された宛先に、メッセージを送信します。メッセージ・プロデューサーのデフォルト送達モード、優先順位、および存続時間を使用してメッセージを送信します。
xmsRC xmsMsgProducerSendDest(xmsHMsgProducer producer, xmsHDest destination, xmsHMsg message, xmsHErrorBlock errorBlock);
メッセージ・プロデューサーの作成時に宛先が指定されなかったメッセージ・プロデューサーを使用する場合に、指定した宛先にメッセージを送信します。メッセージ・プロデューサーのデフォルト送達モード、優先順位、および存続時間を使用してメッセージを送信します。
通常、メッセージ・プロデューサーの作成時には宛先を指定しますが、宛先を指定しない場合、メッセージの送信ごとに宛先を指定する必要があります。
xmsRC xmsMsgProducerSendDestWithAttr(xmsHMsgProducer producer, xmsHDest destination, xmsHMsg message, xmsINT deliveryMode, xmsINT priority, xmsLONG timeToLive, xmsHErrorBlock errorBlock);
メッセージ・プロデューサーの作成時に宛先が指定されなかったメッセージ・プロデューサーを使用する場合に、指定した宛先にメッセージを送信します。指定された送達モード、優先順位、および存続時間を使用してメッセージを送信します。
通常、メッセージ・プロデューサーの作成時には宛先を指定しますが、宛先を指定しない場合、メッセージの送信ごとに宛先を指定する必要があります。
ブローカーへのリアルタイム接続の場合、値は XMSC_DELIVERY_NON_PERSISTENT である必要があります。
xmsRC xmsMsgProducerSendWithAttr(xmsHMsgProducer producer, xmsHMsg message, xmsINT deliveryMode, xmsINT priority, xmsLONG timeToLive, xmsHErrorBlock errorBlock);
メッセージ・プロデューサーが作成されたときに指定された宛先に、メッセージを送信します。指定された送達モード、優先順位、および存続時間を使用してメッセージを送信します。
ブローカーへのリアルタイム接続の場合、値は XMSC_DELIVERY_NON_PERSISTENT である必要があります。
xmsRC xmsMsgProducerSetDeliveryMode(xmsHMsgProducer producer, xmsINT deliveryMode, xmsHErrorBlock errorBlock);
メッセージ・プロデューサーによって送信されるメッセージのデフォルト送達モードを設定します。
ブローカーへのリアルタイム接続の場合、値は XMSC_DELIVERY_NON_PERSISTENT である必要があります。
デフォルト値は XMSC_DELIVERY_PERSISTENT です。ただし、デフォルト値が XMSC_DELIVERY_NON_PERSISTENT となるブローカーへのリアルタイム接続の場合を除きます。
xmsRC xmsMsgProducerSetDisableMsgID(xmsHMsgProducer producer, xmsBOOL msgIDDisabled, xmsHErrorBlock errorBlock);
受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにメッセージ ID が含まれることを要求するかどうかを示します。
キュー・マネージャーへの接続またはブローカーへのリアルタイム接続では、このフラグは無視されます。サービス統合バスへの接続では、フラグが尊重されます。
xmsRC xmsMsgProducerSetDisableMsgTS(xmsHMsgProducer producer, xmsBOOL timeStampDisabled, xmsHErrorBlock errorBlock);
受信側アプリケーションが、メッセージ・プロデューサーにより送信されるメッセージにタイム・スタンプが含まれることを要求するかどうかを示します。
ブローカーへのリアルタイム接続では、このフラグは無視されます。キュー・マネージャーへの接続またはサービス統合バスへの接続では、フラグは尊重されます。
xmsRC xmsMsgProducerSetPriority(xmsHMsgProducer producer, xmsINT priority, xmsHErrorBlock errorBlock);
メッセージ・プロデューサーによって送信されるメッセージのデフォルト優先順位を設定します。
ブローカーへのリアルタイム接続では、メッセージの優先順位は無視されます。
xmsRC xmsMsgProducerSetTimeToLive(xmsHMsgProducer producer, xmsLONG timeToLive, xmsHErrorBlock errorBlock);
有効期限が切れるまでの、メッセージが存続するデフォルトの時間長を設定します。時間は、メッセージ・プロデューサーがメッセージを送信した時点からの時間です。