IMessageProducer

应用程序使用消息生产者向目标发送消息。

继承层次结构：
IBM.XMS.IPropertyContext
   |
   +----IBM.XMS.IMessageProducer

有关 XMS 定义的 MessageProducer 对象属性的列表，请参阅 MessageProducer。

.NET 个属性

.NET 属性的摘要:
.NET 个属性 描述
DeliveryMode 获取和设置由消息生产者发送的消息的缺省传递方式。
Destination 获取消息生产者的目标。
DisableMsgID 获取接收应用程序是否要求在由消息生产者发送的消息中包含消息标识的指示，并指示接收应用程序是否要求在由消息生产者发送的消息中包含消息标识。
DisableMsgTS 获取接收应用程序是否要求在由消息生产者发送的消息中包含时间戳记的指示，并指示接收应用程序是否要求在由消息生产者发送的消息中包含时间戳记。
优先权 获取和设置由消息生产者发送的消息的缺省优先级。
TimeToLive 获取和设置消息在到期前的缺省存在时间。

DeliveryMode - 获取和设置缺省传递方式

接口：
DeliveryMode DeliveryMode
{
  get;
  set;
}

获取和设置由消息生产者发送的消息的缺省传递方式。

缺省传递方式可为以下值之一：

  • DeliveryMode.Persistent
  • DeliveryMode.NonPersistent

对于与代理程序的实时连接，该值必须为 DeliveryMode.NonPersistent。

缺省值为 DeliveryMode.Persistent，但与代理程序的实时连接除外，其缺省值为 DeliveryMode.NonPersistent。

异常：
  • XMSException

Destination - 获取目标

接口：
IDestination Destination
{
  get;
}

获取消息生产者的目标。

参数：
None
返回：
Destination 对象。 如果消息生产者没有目标，那么此方法将返回空的 Destination 对象。
异常：
  • XMSException

DisableMsgID - 获取和设置“禁用消息标识”标志

接口：
Boolean DisableMessageID
{
  get;
  set;
}

获取接收应用程序是否要求在由消息生产者发送的消息中包含消息标识的指示，并指示接收应用程序是否要求在由消息生产者发送的消息中包含消息标识。

在与队列管理器的连接上或者与代理程序的实时连接上，将忽略此标志。 在与服务集成总线的连接上，支持此标志。

DisabledMsgID 可为以下值：

  • True（如果接收应用程序不要求在由消息生产者发送的消息中包含消息标识）。
  • 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 - 关闭消息生产者

接口：
void  Close();

关闭消息生产者。

如果应用程序尝试关闭已关闭的消息生产者，那么将忽略此调用。

参数：
None
返回：
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