ISession

接口：

AcknowledgeMode AcknowledgeMode
    {
      get;
    }

获取会话的确认方式。

在创建会话时指定确认方式。

如果会话不是事务性会话，确认方式将为以下值之一：

• AcknowledgeMode.AutoAcknowledge
• AcknowledgeMode.ClientAcknowledge
• AcknowledgeMode.DupsOkAcknowledge

有关应答方式的更多信息，请参阅 消息应答。

事务性会话没有确认方式。 如果会话是事务性的，那么该方法将返回AcknowledgeMode.SessionTransacted。

异常：

• XMSException

接口：

Boolean Transacted
    {
      get;
    }

确定会话是否为事务性会话。

Transacted 可为：

• 如果会话是事务性的，那么为 True。
• 如果未处理会话，那么为 false。

对于与代理程序的实时连接，该方法始终返回 False。

异常：

• XMSException

接口：

void Close();

关闭会话。 如果会话是事务性会话，那么将回滚执行中的任何事务。

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

参数：

None

返回：

Void

线程上下文：

任意

异常：

• XMSException

接口：

void Commit();

落实当前事务中处理的所有消息。

会话必须是事务性会话。

参数：

None

返回：

Void

异常：

• XMSException
• IllegalStateException
• TransactionRolledBackException

接口：

IQueueBrowser CreateBrowser(IDestination queue) ;

为指定的队列创建队列浏览器。

参数：

queue（输入）

表示队列的 Destination 对象。

返回：

QueueBrowser 对象。

异常：

• XMSException
• InvalidDestinationException

接口：

IQueueBrowser CreateBrowser(IDestination queue, String selector) ;

使用消息选择器为指定的队列创建队列浏览器。

参数：

queue（输入）

表示队列的 Destination 对象。

selector（输入）

用于封装消息选择器表达式的 String 对象。 只会将其属性与消息选择器表达式相匹配的消息传递到队列浏览器。

空的 String 对象表示该队列浏览器没有消息选择器。

返回：

QueueBrowser 对象。

异常：

• XMSException
• InvalidDestinationException
• InvalidSelectorException

接口：

IBytesMessage CreateBytesMessage();

创建字节消息。

参数：

None

返回：

BytesMessage 对象。

异常：

• XMSException
• IllegalStateException（已关闭会话）

接口：

IMessageConsumer CreateConsumer(IDestination dest) ;

为指定的目标创建消息使用者。

参数：

dest（输入）

Destination 对象。

返回：

MessageConsumer 对象。

异常：

• XMSException
• InvalidDestinationException

接口：

IMessageConsumer CreateConsumer(IDestination dest, 
                                String selector) ;

使用消息选择器为指定的目标创建消息使用者。

参数：

dest（输入）

Destination 对象。

selector（输入）

用于封装消息选择器表达式的 String 对象。 只会将其属性与消息选择器表达式相匹配的消息传递到消息使用者。

空的 String 对象表示该消息使用者没有消息选择器。

返回：

MessageConsumer 对象。

异常：

• XMSException
• InvalidDestinationException
• InvalidSelectorException

接口：

IMessageConsumer CreateConsumer(IDestination dest, 
                                String selector, 
                                Boolean noLocal) ;

使用消息选择器为指定的目标创建消息使用者，并在目标为主题时指定消息使用者是否接收由其自己的连接发布的消息。

参数：

dest（输入）

Destination 对象。

selector（输入）

用于封装消息选择器表达式的 String 对象。 只会将其属性与消息选择器表达式相匹配的消息传递到消息使用者。

空的 String 对象表示该消息使用者没有消息选择器。

noLocal（输入）

值 True 表示消息使用者不接收由其自己的连接发布的消息。 值 False 表示消息使用者接收由其自己的连接发布的消息。 缺省值为 False。

返回：

MessageConsumer 对象。

异常：

• XMSException
• InvalidDestinationException
• InvalidSelectorException

接口：

IMessageConsumer CreateDurableSubscriber(IDestination dest, 
                                         String subscription) ;

为指定的主题创建持久订户。

对于与代理程序的实时连接，此方法无效。

有关持久订户的更多信息，请参阅 持久订户。

参数：

dest（输入）

表示主题的 Destination 对象。 主题不能是临时主题。

subscription（输入）

用于封装可标识持久预订的名称的 String 对象。 在连接的客户机标识内，此名称必须是唯一的。

返回：

表示持久订户的 MessageConsumer 对象。

异常：

• XMSException
• InvalidDestinationException

接口：

IMessageConsumer CreateDurableSubscriber(IDestination dest, 
                                         String subscription, 
                                         String selector, 
                                         Boolean noLocal) ;

使用消息选择器为指定的主题创建持久订户，并指定持久订户是否接收由其自己的连接发布的消息。

对于与代理程序的实时连接，此方法无效。

有关持久订户的更多信息，请参阅 持久订户。

参数：

dest（输入）

表示主题的 Destination 对象。 主题不能是临时主题。

subscription（输入）

用于封装可标识持久预订的名称的 String 对象。 在连接的客户机标识内，此名称必须是唯一的。

selector（输入）

用于封装消息选择器表达式的 String 对象。 只会将其属性与消息选择器表达式相匹配的消息传递到持久订户。

空的 String 对象表示该持久订户没有消息选择器。

noLocal（输入）

值 True 表示持久订户不会接收由其自己的连接发布的消息。 值 False 表示持久订户接收由其自己的连接发布的消息。 缺省值为 False。

返回：

表示持久订户的 MessageConsumer 对象。

异常：

• XMSException
• InvalidDestinationException
• InvalidSelectorException

接口：

IMapMessage CreateMapMessage();

创建映射消息。

参数：

None

返回：

MapMessage 对象。

异常：

• XMSException
• IllegalStateException（已关闭会话）

接口：

IMessage CreateMessage();

创建不含主体的消息。

参数：

None

返回：

Message 对象。

异常：

• XMSException
• IllegalStateException（已关闭会话）

接口：

IObjectMessage CreateObjectMessage();

创建对象消息。

参数：

None

返回：

ObjectMessage 对象。

异常：

• XMSException
• IllegalStateException（已关闭会话）

接口：

IMessageProducer CreateProducer(IDestination dest) ;

创建要将消息发送到指定目标的消息生产者。

参数：

dest（输入）

Destination 对象。

如果指定了空的 Destination 对象，那么将创建不含目标的消息生产者。 在这种情况下，应用程序在每次使用消息生产者发送消息时都必须指定目标。

返回：

MessageProducer 对象。

异常：

• XMSException
• InvalidDestinationException

接口：

IDestination CreateQueue(String queue) ;

创建表示消息传递服务器中的队列的 Destination 对象。

此方法不会在消息传递服务器中创建队列。 您必须在应用程序调用此方法之前创建队列。

参数：

queue（输入）

用于封装队列名称的 String 对象，或用于封装可标识队列的统一资源标识 (URI) 的 String 对象。

返回：

表示队列的 Destination 对象。

异常：

• XMSException

接口：

IStreamMessage CreateStreamMessage();

创建流消息。

参数：

None

返回：

StreamMessage 对象。

异常：

• XMSException
• XMS_ILLEGAL_STATE_EXCEPTION

接口：

IDestination CreateTemporaryQueue() ;

创建临时队列。

临时队列的作用域是连接。 只有通过连接创建的会话才可以使用临时队列。

临时队列会一直保留，直至将其显式删除或连接中断（以两者中较早的一个为准）。

有关临时队列的更多信息，请参阅 临时目标。

参数：

None

返回：

表示临时队列的 Destination 对象。

异常：

• XMSException

接口：

IDestination CreateTemporaryTopic() ;

创建临时主题。

临时主题的作用域是连接。 只有通过连接创建的会话才可以使用临时主题。

临时主题会一直保留，直至将其显式删除或连接中断（以两者中较早的一个为准）。

有关临时主题的更多信息，请参阅 临时目标。

参数：

None

返回：

表示临时主题的 Destination 对象。

异常：

• XMSException

接口：

ITextMessage CreateTextMessage();

创建包含空主体的文本消息。

参数：

None

返回：

TextMessage 对象。

异常：

• XMSException

接口：

ITextMessage CreateTextMessage(String initialValue);

创建已使用指定文本初始化消息主体的文本消息。

参数：

initialValue（输入）

用于封装可用来初始化文本消息主体的文本的 String 对象。

None

返回：

TextMessage 对象。

异常：

• XMSException

接口：

IDestination CreateTopic(String topic) ;

创建表示主题的 Destination 对象。

参数：

topic（输入）

用于封装主题名称的 String 对象，或用于封装可标识主题的统一资源标识 (URI) 的 String 对象。

返回：

表示主题的 Destination 对象。

异常：

• XMSException

接口：

void Recover();

恢复会话。 消息传递已停止，然后通过最早的未确认消息来重新启动。

会话不能是事务性会话。

有关恢复会话的更多信息，请参阅 消息应答。

参数：

None

返回：

Void

异常：

• XMSException
• IllegalStateException

接口：

void Rollback();

回滚当前事务中处理的所有消息。

会话必须是事务性会话。

参数：

None

返回：

Void

异常：

• XMSException
• IllegalStateException

接口：

void Unsubscribe(String subscription);

删除持久预订。 消息传递服务器将删除其维护的持久预订记录，并且不会向持久订户再发送任何消息。

对于与代理程序的实时连接，此方法无效。

参数：

subscription（输入）

用于封装可标识持久预订的名称的 String 对象。

返回：

Void

异常：

• XMSException
• InvalidDestinationException
• IllegalStateException