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

MessageProducer

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

繼承階層:
xms::PropertyContext
   |
   +----xms::MessageProducer

有關 XMS 所定義的 MessageProducer 物件內容清單, 請參閱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

使用條款 | 評比此網頁

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