IConnection

Connection 对象表示应用程序到消息传递服务器的活动连接。

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

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

.NET 个属性

.NET 属性的摘要:
.NET 属性 描述
ClientID 获取和设置连接的客户机标识。
ExceptionListener 获取向连接注册的异常侦听器，并向连接注册异常侦听器。
MetaData 获取连接的元数据。

ClientID - 获取和设置客户机标识

接口：
String ClientID
      {
        get;
        set;
      }

获取和设置连接的客户机标识。

客户机标识可由管理员在 ConnectionFactory 中预配置或者通过设置 ClientID 来指定。

客户机标识仅用于在发布/预订域中支持持久预订，而在点到点域中会忽略此标识。

如果应用程序要为连接设置客户机标识，那么该应用程序必须在创建连接后且在对连接执行任何其他操作之前立即设置此标识。 如果该应用程序尝试在这个时间点后设置客户机标识，那么调用将抛出异常 IllegalStateException。

对于与代理程序的实时连接，该属性无效。

异常：
  • XMSException
  • IllegalStateException
  • InvalidClientIDException

ExceptionListener - 获取和设置异常侦听器

接口：
	ExceptionListener ExceptionListener
        {
          get;
          set;
        }

获取向连接注册的异常侦听器，并向连接注册异常侦听器。

如果未向连接注册异常侦听器，那么此方法将返回空值。 如果已向连接注册异常侦听器，可以通过指定空值（代替异常侦听器）来取消注册。

有关使用异常侦听器的更多信息，请参阅 在 .NET中使用消息和异常侦听器。

异常：
  • XMSException

Metadata - 获取元数据

接口：
IConnectionMetaData MetaData
    {
      get;
    }

获取连接的元数据。

异常：
  • XMSException

方法

方法汇总：
方法 描述
关闭 关闭连接。
CreateSession 创建会话。
开始 对连接启动或重新启动入局消息传递。
停止 对连接停止入局消息传递。

Close - 关闭连接

接口：
void  Close();

关闭连接。

如果应用程序尝试关闭已关闭的连接，那么将忽略此调用。

参数：
None
返回：
Void
异常：
  • XMSException

CreateSession - 创建会话

接口：
	ISession CreateSession(Boolean transacted, 
                         AcknowledgeMode acknowledgeMode);

创建会话。

参数：
transacted（输入）
值 True 表示此会话是事务性会话。 值 False 表示此会话不是事务性会话。

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

acknowledgeMode（输入）
指示如何确认应用程序接收的消息。 该值必须是来自 AcknowledgeMode 枚举符的以下值之一：
  • AcknowledgeMode.AutoAcknowledge
  • AcknowledgeMode.ClientAcknowledge
  • AcknowledgeMode.DupsOkAcknowledge
对于与代理程序的实时连接，该值必须为 AcknowledgeMode.AutoAcknowledge 或 AcknowledgeMode.DupsOkAcknowledge

如果会话是事务性会话，那么将忽略此参数。 有关应答方式的更多信息，请参阅 消息应答。

返回：
Session 对象
异常：
  • XMSException

Start - 启动连接

接口：
void  Start();

对连接启动或重新启动入局消息传递。 如果连接已启动，那么将忽略此调用。

参数：
None
返回：
Void
异常：
  • XMSException

Stop - 停止连接

接口：
void  Stop();

对连接停止入局消息传递。 如果连接已停止，那么将忽略此调用。

参数：
None
返回：
Void
异常：
  • XMSException