KMQueue Class Reference
Inherits from | KMDestination : KCObject : NSObject |
Declared in | KMQueue.h |
Overview
A Queue object encapsulates a provider-specific queue name. It is the way a client specifies the identity of a queue to JMS API methods. For those methods that use a Destination as a parameter, a Queue object used as an argument. For example, a queue can be used to create a MessageConsumer and a MessageProducer by calling:
The actual length of time messages are held by a queue and the consequences of resource overflow are not defined by the JMS API.
Warning: Queue names should be prefixed with /queue/
regardless of the
message broker in use.
KMQueue *queue = [session createQueue:@"/queue/destination"]
For example, /queue/destination
can be passed
to [KMSession createQueue:].
See the Gateway configuration for details on how queue names are mapped to specific JMS Brokers.
Tasks
-
– queueName
Gets the name of this queue.
-
– toString
Returns a string representation of this object.
Instance Methods
queueName
Gets the name of this queue.
- (NSString *)queueName
Return Value
the queue name
Discussion
Clients that depend upon the name are not portable.
Exceptions
- KMJMSException
if the JMS provider implementation of Queue fails to return the queue name due to some internal error.
Declared In
KMQueue.h