WebSphere Message Service Clients for C/C++ and .NET, Version 1.2 作業系統: Linux, Windows

MessageProducer

應用程式會使用訊息生產者將訊息傳至目的地。

有關 XMS 所定義的 MessageProducer 物件內容清單, 請參閱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(輸入/輸出)
在輸入方面,為訊息生產者的控點。在輸出方面,函數會傳回空值控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • 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(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgProducerGetDestination – 取得目的地

介面:
xmsRC xmsMsgProducerGetDestination(xmsHMsgProducer producer,
                                   xmsHDest *destination,
                                   xmsHErrorBlock errorBlock);

取得訊息生產者的目的地。

參數:
producer(輸入)
訊息生產者的控點。
destination(輸出)
目的地的控點。如果訊息生產者沒有目的地,函數會傳回空值控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgProducerGetDisableMsgID – 取得停用訊息 ID 旗標

介面:
xmsRC xmsMsgProducerGetDisableMsgID(xmsHMsgProducer producer,
                                    xmsBOOL *msgIDDisabled,
                                    xmsHErrorBlock errorBlock);

取得接收端應用程式是否要求訊息生產者所送訊息中需包含訊息 ID 的指示。

參數:
producer(輸入)
訊息生產者的控點。
msgIDDisabled(輸出)
如果接收端應用程式不要求訊息生產者所送訊息中需包含訊息 ID, 則值為 xmsTRUE。如果接收端應用程式要求需包含訊息 ID,則值為 xmsFALSE
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgProducerGetDisableMsgTS – 取得停用時間戳記旗標

介面:
xmsRC xmsMsgProducerGetDisableMsgTS(xmsHMsgProducer producer,
                                    xmsBOOL *timeStampDisabled,
                                    xmsHErrorBlock errorBlock);

取得接收端應用程式是否要求訊息生產者所送訊息中需包含時間戳記的指示。

參數:
producer(輸入)
訊息生產者的控點。
timeStampDisabled(輸出)
如果接收端應用程式不要求訊息生產者所送訊息中需有時間戳記, 則值為 xmsTRUE。如果接收端應用程式要求需包含時間戳記,則值為 xmsFALSE
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgProducerGetPriority – 取得預設優先順序

介面:
xmsRC xmsMsgProducerGetPriority(xmsHMsgProducer producer,
                                xmsINT *priority,
                                xmsHErrorBlock errorBlock);

取得訊息生產者所送訊息的預設優先順序。

參數:
producer(輸入)
訊息生產者的控點。
priority(輸出)
預設的訊息優先順序。此值為一個 0(最低優先順序)到 9(最高優先順序)範圍間的整數。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgProducerGetTimeToLive – 取得預設存活時間

介面:
xmsRC xmsMsgProducerGetTimeToLive(xmsHMsgProducer producer,
                                  xmsLONG *timeToLive,
                                  xmsHErrorBlock errorBlock);

取得訊息的預設存在時間長度,一旦超過即算到期。 時間是從訊息生產者送出訊息開始計算。

參數:
producer(輸入)
訊息生產者的控點。
timeToLive(輸出)
預設的存活時間(毫秒)。值 0 表示訊息永不到期。若為和分配管理系統間的即時連線, 此值固定為 0。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgProducerSend – 傳送

介面:
xmsRC xmsMsgProducerSend(xmsHMsgProducer producer,
                         xmsHMsg message,
                         xmsHErrorBlock errorBlock);

傳送訊息給當初建立訊息生產者時所指定的目的地。這會在使用訊息生產者的預設遞送模式、優先順序和存活時間下傳送訊息。

參數:
producer(輸入)
訊息生產者的控點。
message(輸入)
訊息的控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • 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(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • 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(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • 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(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • 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(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgProducerSetDisableMsgID – 設定停用訊息 ID 旗標

介面:
xmsRC xmsMsgProducerSetDisableMsgID(xmsHMsgProducer producer,
                                    xmsBOOL msgIDDisabled,
                                    xmsHErrorBlock errorBlock);

指出接收端應用程式是否要求訊息生產者所送訊息中需包含訊息 ID。

若為和佇列管理程式間的連線, 或和分配管理系統間的即時連線,則會忽略此旗標。若為和服務整合匯流排間的連線,則會採用此旗標。

參數:
producer(輸入)
訊息生產者的控點。
msgIDDisabled(輸入)
xmsTRUE 表示接收端應用程式不要求訊息生產者所送訊息中需包含訊息 ID。值 xmsFALSE 表示接收端應用程式要求需包含訊息 ID。預設值為 xmsFALSE
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgProducerSetDisableMsgTS – 設定停用時間戳記旗標

介面:
xmsRC xmsMsgProducerSetDisableMsgTS(xmsHMsgProducer producer,
                                    xmsBOOL timeStampDisabled,
                                    xmsHErrorBlock errorBlock);

指出接收端應用程式是否要求訊息生產者所送訊息中需包含時間戳記。

若為和分配管理系統間的即時連線, 則會忽略此旗標。若為和佇列管理程式間的連線或是和服務整合匯流排間的連線,則會採用此旗標。

參數:
producer(輸入)
訊息生產者的控點。
timeStampDisabled(輸入)
xmsTRUE 表示接收端應用程式不要求訊息生產者所送訊息中需包含時間戳記。值 xmsFALSE 表示接收端應用程式要求需包含時間戳記。預設值為 xmsFALSE
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgProducerSetPriority – 設定預設優先順序

介面:
xmsRC xmsMsgProducerSetPriority(xmsHMsgProducer producer,
                                xmsINT priority,
                                xmsHErrorBlock errorBlock);

設定訊息生產者所送訊息的預設優先順序。

若為和分配管理系統間的即時連線, 則會忽略訊息的優先順序。

參數:
producer(輸入)
訊息生產者的控點。
priority(輸入)
預設的訊息優先順序。此值可以是一個 0(最低優先順序)到 9(最高優先順序)範圍間的整數。預設值是 4
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgProducerSetTimeToLive – 設定預設存活時間

介面:
xmsRC xmsMsgProducerSetTimeToLive(xmsHMsgProducer producer,
                                  xmsLONG timeToLive,
                                  xmsHErrorBlock errorBlock);

設定訊息的預設存在時間長度,一旦超過即算到期。 時間是從訊息生產者送出訊息開始計算。

參數:
producer(輸入)
訊息生產者的控點。
timeToLive(輸入)
預設的存活時間(毫秒)。預設值是 0,表示訊息永不到期。若為和分配管理系統間的即時連線, 此值必須是 0。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

Reference topic

使用條款 | 評比此網頁

時間戳記前次更新: 25 Apr 2006
(C) Copyright IBM Corporation 2005. All Rights Reserved.
本資訊中心採用 Eclipse 技術。(http://www.eclipse.org)