TIBCO EMS .NET API 10.3
TIBCO EMS .NET API 10.3
TIBCO.EMS.UFO.QueueSession Class Reference

Session restricted to queues More...

Inheritance diagram for TIBCO.EMS.UFO.QueueSession:
TIBCO.EMS.UFO.Session

Public Member Functions

QueueReceiver CreateReceiver (Queue queue)
 Create a QueueReceiver object to receive messages from the specified queue More...
 
QueueReceiver CreateReceiver (Queue queue, string messageSelector)
 Create a QueueReceiver object to receive messages from the specified queue using a message selector More...
 
QueueSender CreateSender (Queue queue)
 Create a QueueSender object to send messages to the specified queue More...
 
- Public Member Functions inherited from TIBCO.EMS.UFO.Session
QueueBrowser CreateBrowser (Queue queue)
 Create a QueueBrowser object to peek at the messages on the specified queue. More...
 
QueueBrowser CreateBrowser (Queue queue, string messageSelector)
 Create a QueueBrowser object to peek at the messages on the specified queue using a message selector. More...
 
MessageConsumer CreateConsumer (Destination dest)
 Create a MessageConsumer for a specific destination. More...
 
MessageConsumer CreateConsumer (Destination dest, string messageSelector)
 Create a MessageConsumer for a specific destination, using a message selector. More...
 
MessageConsumer CreateConsumer (Destination dest, string messageSelector, bool noLocal)
 Create MessageConsumer for the specified destination, using a message selector. This method can specify whether messages published by its own connection should be delivered to it, if the destination is a topic More...
 
MessageConsumer CreateSharedConsumer (Topic topic, string sharedSubscriptionName)
 Create a shared non-durable subscription (with the specified name on the specified topic - if one does not already exist), and a consumer on that subscription. More...
 
MessageConsumer CreateSharedConsumer (Topic topic, string sharedSubscriptionName, string messageSelector)
 Create a shared non-durable subscription (with the specified name on the specified topic - if one does not already exist), and a consumer on that subscription, using the specified message selector. More...
 
MessageConsumer CreateSharedDurableConsumer (Topic topic, string name)
 Create a shared durable subscription (with the specified name on the specified topic - if one does not already exist), and a consumer on that subscription. More...
 
MessageConsumer CreateSharedDurableConsumer (Topic topic, string name, string messageSelector)
 Create a shared durable subscription (with the specified name on the specified topic - if one does not already exist), and a consumer on that subscription, using the specified message selector. More...
 
TemporaryTopic CreateTemporaryTopic ()
 Create a TemporaryTopic object More...
 
TemporaryQueue CreateTemporaryQueue ()
 Create a TemporaryQueue object More...
 
TopicSubscriber CreateDurableSubscriber (Topic topic, string name)
 Create a durable subscriber to the specified topic More...
 
TopicSubscriber CreateDurableSubscriber (Topic topic, string name, string messageSelector, bool noLocal)
 Create a durable subscriber to the specified topic, using a message selector and specifying whether messages published by its own connection should be delivered to it. More...
 
Topic CreateTopic (string topicName)
 Create a topic More...
 
Queue CreateQueue (string queueName)
 Create a queue More...
 
MessageProducer CreateProducer (Destination dest)
 Create a MessageProducer to send messages to the specified destination. More...
 
void Unsubscribe (string name)
 Unsubscribe a durable topic subscription More...
 
BytesMessage CreateBytesMessage ()
 Create a byte array message More...
 
MapMessage CreateMapMessage ()
 Create a MapMessage object. A MapMessage object is used to send a self-defining set of name-value pairs, where names are String objects and values are primitive values in the .NET programming language. More...
 
Message CreateMessage ()
 Create a Message object. The Message interface is the root interface of all TIBCO EMS messages. A Message object holds all the standard message header information. It can be sent when a message containing only header information is sufficient More...
 
ObjectMessage CreateObjectMessage ()
 Create an ObjectMessage object. An ObjectMessage object is used to send a message that contains a serializable .NET object. More...
 
ObjectMessage CreateObjectMessage (object obj)
 Create an ObjectMessage object. An ObjectMessage object is used to send a message that contains a serializable .NET object. More...
 
StreamMessage CreateStreamMessage ()
 Create a StreamMessage object More...
 
TextMessage CreateTextMessage ()
 Create a TextMessage object More...
 
TextMessage CreateTextMessage (string text)
 Create a TextMessage object More...
 
virtual void Commit ()
 Commit the open transaction More...
 
virtual void Rollback ()
 Roll back messages in the current transaction More...
 
void Recover ()
 Recover from undetermined state during message processing More...
 
void Close ()
 Close a session and reclaim resources More...
 
void Run ()
 Obsolete: Not to be used by ordinary EMS Clients More...
 
override string ToString ()
 Returns a string representation of this Session object. More...
 

Additional Inherited Members

- Public Attributes inherited from TIBCO.EMS.UFO.Session
const int SESSION_TRANSACTED = TIBCO.EMS.Session.SESSION_TRANSACTED
 The session is transacted More...
 
const int AUTO_ACKNOWLEDGE = TIBCO.EMS.Session.AUTO_ACKNOWLEDGE
 Automatic acknowledgment More...
 
const int CLIENT_ACKNOWLEDGE = TIBCO.EMS.Session.CLIENT_ACKNOWLEDGE
 Client acknowledgment More...
 
const int DUPS_OK_ACKNOWLEDGE = TIBCO.EMS.Session.DUPS_OK_ACKNOWLEDGE
 Duplication ok acknowledgment More...
 
const int NO_ACKNOWLEDGE = TIBCO.EMS.Session.NO_ACKNOWLEDGE
 No acknowledge acknowledge mode More...
 
const int EXPLICIT_CLIENT_ACKNOWLEDGE = TIBCO.EMS.Session.EXPLICIT_CLIENT_ACKNOWLEDGE
 Explicit client acknowledge mode More...
 
const int EXPLICIT_CLIENT_DUPS_OK_ACKNOWLEDGE = TIBCO.EMS.Session.EXPLICIT_CLIENT_DUPS_OK_ACKNOWLEDGE
 Explicit client acknowledge mode with dups_ok More...
 
- Properties inherited from TIBCO.EMS.UFO.Session
int AcknowledgeMode [get]
 Get the acknowledge mode of the session as integer constants as defined in Session class. More...
 
Connection Connection [get]
 Get the connection the session belongs to More...
 
bool IsClosed [get]
 Get whether the session is closed. More...
 
long SessID [get]
 Gets the id of the session. More...
 
bool IsTransacted [get]
 Get whether the session is transacted More...
 
TIBCO.EMS.SessionMode SessionAcknowledgeMode [get]
 Get the acknowledge mode of the session as a SessionMode type More...
 
IMessageListener MessageListener [get, set]
 Get or set the message listener for the session. -Deprecated, use MessageConsumer.MessageListener instead. More...
 
bool Transacted [get]
 Get whether an open session is transacted More...
 

Detailed Description

Session restricted to queues

Note: The QueueSession class is for backwards compatibility to support older clients. New clients should use the Session class.

A QueueSession object provides methods for creating QueueReceiver, QueueSender, QueueBrowser, and TemporaryQueue objects.

If there are messages that have been received but not acknowledged when a QueueSession terminates, these messages will be retained and redelivered when a consumer next accesses the queue.

Member Function Documentation

QueueReceiver TIBCO.EMS.UFO.QueueSession.CreateReceiver ( Queue  queue)
inline

Create a QueueReceiver object to receive messages from the specified queue

The QueueReceiver object will be recreated during connection recovery process.

Parameters
queuethe Queue to access
QueueReceiver TIBCO.EMS.UFO.QueueSession.CreateReceiver ( Queue  queue,
string  messageSelector 
)
inline

Create a QueueReceiver object to receive messages from the specified queue using a message selector

The QueueReceiver object will be recreated during connection recovery process.

Parameters
queuethe Queue to access
messageSelectoronly messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.
QueueSender TIBCO.EMS.UFO.QueueSession.CreateSender ( Queue  queue)
inline

Create a QueueSender object to send messages to the specified queue

The QueueSender object will be recreated during connection recovery process.

Parameters
queuethe Queue to access, or null if this is an unidentified producer

Copyright © 1997-2024 Cloud Software Group, Inc. All Rights Reserved.