The IQueueConnection type exposes the following members.

Methods

  NameDescription
Public methodClose
Closes the connection.

Since a provider typically allocates significant resources outside the JVM on behalf of a connection, clients should close these resources when they are not needed. Relying on garbage collection to eventually reclaim these resources may not be timely enough.

There is no need to close the sessions, producers, and consumers of a closed connection.

Closing a connection causes all temporary destinations to be deleted.

When this method is invoked, it should not return until message processing has been shut down in an orderly fashion. This means that all message listeners that may have been running have returned, and that all pending receives have returned. A close terminates all pending message receives on the connection's sessions' consumers. The receives may return with a message or with null, depending on whether there was a message available at the time of the close. If one or more of the connection's sessions' message listeners is processing a message at the time when connection close is invoked, all the facilities of the connection and its sessions must remain available to those listeners until they return control to the JMS provider.

Closing a connection causes any of its sessions' transactions in progress to be rolled back. In the case where a session's work is coordinated by an external transaction manager, a session's commit and rollback methods are not used and the result of a closed session's work is determined later by the transaction manager.

Closing a connection does NOT force an acknowledgment of client-acknowledged sessions.

Invoking the acknowledge method of a received message from a closed connection's session must throw an IllegalStateException. Closing a closed connection must NOT throw an exception.

(Inherited from IConnection.)
Public methodCreateConnectionConsumer(IDestination, String, IServerSessionPool, Int32)
Creates a connection consumer for this connection (optional operation). This is an expert facility not used by regular JMS clients.
(Inherited from IConnection.)
Public methodCreateConnectionConsumer(IQueue, String, IServerSessionPool, Int32)
Creates a connection consumer for this connection (optional operation). This is an expert facility not used by regular JMS clients.
Public methodCreateDurableConnectionConsumer
Create a durable connection consumer for this connection (optional operation). This is an expert facility not used by regular JMS clients.
(Inherited from IConnection.)
Public methodCreateQueueSession
Creates a QueueSession object.
Public methodCreateSession
Creates a Session object.
(Inherited from IConnection.)
Public methodStart
Starts (or restarts) a connection's delivery of incoming messages. A call to start on a connection that has already been started is ignored.
(Inherited from IConnection.)
Public methodStop
Temporarily stops a connection's delivery of incoming messages. Delivery can be restarted using the connection's start method. When the connection is stopped, delivery to all the connection's message consumers is inhibited: synchronous receives block, and messages are not delivered to message listeners.

This call blocks until receives and/or message listeners in progress have completed.

Stopping a connection has no effect on its ability to send messages. A call to stop on a connection that has already been stopped is ignored.

A call to stop must not return until delivery of messages has paused. This means that a client can rely on the fact that none of its message listeners will be called and that all threads of control waiting for receive calls to return will not return with a message until the connection is restarted. The receive timers for a stopped connection continue to advance, so receives may time out while the connection is stopped.

If message listeners are running when stop is invoked, the stop call must wait until all of them have returned before it may return. While these message listeners are completing, they must have the full services of the connection available to them.

(Inherited from IConnection.)

Properties

  NameDescription
Public propertyClientID
Gets the client identifier for this connection.
(Inherited from IConnection.)
Public propertyExceptionListener
Gets the ExceptionListener object for this connection. Not every Connection has an ExceptionListener associated with it.
(Inherited from IConnection.)
Public propertyMetaData
Gets the metadata for this connection.
(Inherited from IConnection.)

See Also