javax.jms.ConnectionConsumer Maven / Gradle / Ivy
/*
* @(#)ConnectionConsumer.java 1.16 02/04/09
*
* Copyright 1997-2002 Sun Microsystems, Inc. All Rights Reserved.
*
* SUN PROPRIETARY/CONFIDENTIAL.
* This software is the proprietary information of Sun Microsystems, Inc.
* Use is subject to license terms.
*
*/
package javax.jms;
/** For application servers, Connection objects provide a special
* facility
* for creating a ConnectionConsumer (optional). The messages it
* is to consume are
* specified by a Destination and a message selector. In addition,
* a ConnectionConsumer must be given a
* ServerSessionPool to use for
* processing its messages.
*
* Normally, when traffic is light, a ConnectionConsumer gets a
* ServerSession from its pool, loads it with a single message, and
* starts it. As traffic picks up, messages can back up. If this happens,
* a ConnectionConsumer can load each ServerSession
* with more than one
* message. This reduces the thread context switches and minimizes resource
* use at the expense of some serialization of message processing.
*
* @version 1.1 February 8, 2002
* @author Mark Hapner
* @author Rich Burridge
*
* @see javax.jms.Connection#createConnectionConsumer
* @see javax.jms.Connection#createDurableConnectionConsumer
* @see javax.jms.QueueConnection#createConnectionConsumer
* @see javax.jms.TopicConnection#createConnectionConsumer
* @see javax.jms.TopicConnection#createDurableConnectionConsumer
*/
public interface ConnectionConsumer {
/** Gets the server session pool associated with this connection consumer.
*
* @return the server session pool used by this connection consumer
*
* @exception JMSException if the JMS provider fails to get the server
* session pool associated with this consumer due
* to some internal error.
*/
ServerSessionPool
getServerSessionPool() throws JMSException;
/** Closes the connection consumer.
*
*
Since a provider may allocate some resources on behalf of a
* connection consumer outside the Java virtual machine, clients should
* close these resources when
* they are not needed. Relying on garbage collection to eventually
* reclaim these resources may not be timely enough.
*
* @exception JMSException if the JMS provider fails to release resources
* on behalf of the connection consumer or fails
* to close the connection consumer.
*/
void
close() throws JMSException;
}