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

IMessageProducer

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

繼承階層:
IBM.XMS.IPropertyContext
   |
   +----IBM.XMS.IMessageProducer

有關 XMS 所定義的 MessageProducer 物件內容清單, 請參閱MessageProducer 內容

.NET 內容

.NET 內容摘要:
.NET 內容 說明
DeliveryMode 取得和設定訊息生產者所送訊息的預設遞送模式。
Destination 取得訊息生產者的目的地。
DisableMsgID 取得接收端應用程式是否要求訊息生產者所送訊息中需包含訊息 ID 的指示, 以及指出接收端應用程式是否要求訊息生產者所送訊息中需包含訊息 ID。
DisableMsgTS 取得接收端應用程式是否要求訊息生產者所送訊息中需包含時間戳記的指示, 以及指出接收端應用程式是否要求訊息生產者所送訊息中需包含時間戳記。
Priority 取得和設定訊息生產者所送訊息的預設優先順序。
TimeToLive 取得和設定訊息的預設存在時間長度,一旦超過即算到期。

DeliveryMode – 取得和設定預設遞送模式

介面:
DeliveryMode DeliveryMode
{
  get;
  set;
}

取得和設定訊息生產者所送訊息的預設遞送模式。

預設遞送模式,其值為下列之一:

  • DeliveryMode.Persistent
  • DeliveryMode.NonPersistent

若為和分配管理系統間的即時連線, 此值必須是 DeliveryMode.NonPersistent

預設值為 DeliveryMode.Persistent,但如果是和分配管理系統間的即時連線, 則預設值會是 DeliveryMode.NonPersistent

異常狀況:
  • XMSException

Destination – 取得目的地

介面:
IDestination Destination
{
  get;
}

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

參數:
傳回:
Destination 物件。如果訊息生產者沒有目的地,方法會傳回空值 Destination 物件。
異常狀況:
  • XMSException

DisableMsgID – 取得和設定停用訊息 ID 旗標

介面:
Boolean DisableMessageID
{
  get;
  set;
}

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

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

DisabledMsgID 的值可為:

  • 如果接收端應用程式不要求訊息生產者所送訊息中需包含訊息 ID, 則為 True
  • 如果接收端應用程式要求訊息生產者所送訊息中需包含訊息 ID, 則為 False
異常狀況:
  • XMSException

DisableMsgTS – 取得和設定停用時間戳記旗標

介面:
Boolean DisableMessageTimestamp
{
  get;
  set;
}

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

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

DisableMsgTS 的值可為:

  • 如果接收端應用程式不要求訊息生產者所送訊息中需包含時間戳記, 則為 True
  • 如果接收端應用程式要求訊息生產者所送訊息中需包含時間戳記, 則為 False
傳回:
異常狀況:
  • XMSException

Priority – 取得和設定預設優先順序

介面:
Int32 Priority
{
  get;
  set;
}

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

預設訊息優先順序的值為一個 0(最低優先順序)到 9(最高優先順序)範圍間的整數。

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

異常狀況:
  • XMSException

TimeToLive – 取得和設定預設存活時間

介面:
Int64 TimeToLive
{
  get;
  set;
}

取得和設定訊息的預設存在時間長度,一旦超過即算到期。

時間是從訊息生產者送出訊息開始計算, 並且是預設存活時間(毫秒)。值 0 表示訊息永不到期。

若為和分配管理系統間的即時連線, 此值固定為 0。

異常狀況:
  • XMSException

方法

方法摘要:
方法 說明
Close 關閉訊息生產者。
Send 傳送訊息給當初建立訊息生產者時所指定的目的地。這會在使用訊息生產者的預設遞送模式、優先順序和存活時間下傳送訊息。
Send 傳送訊息給當初建立訊息生產者時所指定的目的地。這會在使用指定的遞送模式、優先順序和存活時間下傳送訊息。
Send 如果您所用的訊息生產者在當初建立時並未指定目的地, 則會將訊息傳給指定的目的地。這會在使用訊息生產者的預設遞送模式、優先順序和存活時間下傳送訊息。
Send 如果您所用的訊息生產者在當初建立時並未指定目的地, 則會將訊息傳給指定的目的地。這會在使用指定的遞送模式、優先順序和存活時間下傳送訊息。

Close – 關閉訊息生產者

介面:
void  Close(); 

關閉訊息生產者。

如果應用程式試著關閉已關閉的訊息生產者, 則會忽略該呼叫。

參數:
傳回:
Void
異常狀況:
  • XMSException

Send – 傳送

介面:
void Send(IMessage msg) ;

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

參數:
msg(輸入)
Message 物件。
傳回:
Void
異常狀況:
  • XMSException
  • MessageFormatException
  • InvalidDestinationException

Send – 傳送(指定遞送模式、優先順序和存活時間)

介面:
void Send(IMessage msg, 
          DeliveryMode deliveryMode, 
          Int32 priority, 
          Int64 timeToLive);

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

參數:
msg(輸入)
Message 物件。
deliveryMode(輸入)
訊息的遞送模式,其值必須是下列之一:
  • DeliveryMode.Persistent
  • DeliveryMode.NonPersistent

若為和分配管理系統間的即時連線, 此值必須是 DeliveryMode.NonPersistent

priority(輸入)
訊息的優先順序。此值可以是一個 0(最低優先順序)到 9(最高優先順序)範圍間的整數。若為和分配管理系統間的即時連線, 則會忽略此值。
timeToLive(輸入)
訊息的存活時間(毫秒)。值 0 表示訊息永不到期。若為和分配管理系統間的即時連線, 此值必須是 0。
傳回:
Void
異常狀況:
  • XMSException
  • MessageFormatException
  • InvalidDestinationException
  • IllegalStateException

Send – 傳送(至指定的目的地)

介面:
void Send(IDestination dest, IMessage msg) ;

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

一般而言, 您會在建立訊息生產者時指定一個目的地, 如果您沒有指定,則每當傳送訊息時您都必須指定一個目的地。

參數:
dest(輸入)
Destination 物件。
msg(輸入)
Message 物件。
傳回:
Void
異常狀況:
  • XMSException
  • MessageFormatException
  • InvalidDestinationException

Send – 傳送(至指定的目的地,並指定遞送模式、優先順序和存活時間)

介面:
void Send(IDestination dest, 
          IMessage msg, 
          DeliveryMode deliveryMode, 
          Int32 priority, 
          Int64 timeToLive) ;

如果您所用的訊息生產者在當初建立時並未指定目的地, 則會將訊息傳給指定的目的地。這會在使用指定的遞送模式、優先順序和存活時間下傳送訊息。

一般而言, 您會在建立訊息生產者時指定一個目的地, 如果您沒有指定,則每當傳送訊息時您都必須指定一個目的地。

參數:
dest(輸入)
Destination 物件。
msg(輸入)
Message 物件。
deliveryMode(輸入)
訊息的遞送模式,其值必須是下列之一:
  • DeliveryMode.Persistent
  • DeliveryMode.NonPersistent

若為和分配管理系統間的即時連線, 此值必須是 DeliveryMode.NonPersistent

priority(輸入)
訊息的優先順序。此值可以是一個 0(最低優先順序)到 9(最高優先順序)範圍間的整數。若為和分配管理系統間的即時連線, 則會忽略此值。
timeToLive(輸入)
訊息的存活時間(毫秒)。值 0 表示訊息永不到期。若為和分配管理系統間的即時連線, 此值必須是 0。
傳回:
Void
異常狀況:
  • XMSException
  • MessageFormatException
  • InvalidDestinationException
  • IllegalStateException

繼承的內容和方法


Reference topic

使用條款 | 評比此網頁

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