Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/org.eclipse.net4j.jms.api/src/javax/jms/ConnectionConsumer.java')
-rw-r--r--plugins/org.eclipse.net4j.jms.api/src/javax/jms/ConnectionConsumer.java85
1 files changed, 85 insertions, 0 deletions
diff --git a/plugins/org.eclipse.net4j.jms.api/src/javax/jms/ConnectionConsumer.java b/plugins/org.eclipse.net4j.jms.api/src/javax/jms/ConnectionConsumer.java
new file mode 100644
index 0000000000..d6876fbaac
--- /dev/null
+++ b/plugins/org.eclipse.net4j.jms.api/src/javax/jms/ConnectionConsumer.java
@@ -0,0 +1,85 @@
+/*
+ * The contents of this file are subject to the terms
+ * of the Common Development and Distribution License
+ * (the License). You may not use this file except in
+ * compliance with the License.
+ *
+ * You can obtain a copy of the license at
+ * https://glassfish.dev.java.net/public/CDDLv1.0.html or
+ * glassfish/bootstrap/legal/CDDLv1.0.txt.
+ * See the License for the specific language governing
+ * permissions and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL
+ * Header Notice in each file and include the License file
+ * at glassfish/bootstrap/legal/CDDLv1.0.txt.
+ * If applicable, add the following below the CDDL Header,
+ * with the fields enclosed by brackets [] replaced by
+ * you own identifying information:
+ * "Portions Copyrighted [year] [name of copyright owner]"
+ *
+ * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
+ */
+
+
+package javax.jms;
+
+/** For application servers, <CODE>Connection</CODE> objects provide a special
+ * facility
+ * for creating a <CODE>ConnectionConsumer</CODE> (optional). The messages it
+ * is to consume are
+ * specified by a <CODE>Destination</CODE> and a message selector. In addition,
+ * a <CODE>ConnectionConsumer</CODE> must be given a
+ * <CODE>ServerSessionPool</CODE> to use for
+ * processing its messages.
+ *
+ * <P>Normally, when traffic is light, a <CODE>ConnectionConsumer</CODE> gets a
+ * <CODE>ServerSession</CODE> from its pool, loads it with a single message, and
+ * starts it. As traffic picks up, messages can back up. If this happens,
+ * a <CODE>ConnectionConsumer</CODE> can load each <CODE>ServerSession</CODE>
+ * 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.
+ *
+ * <P>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;
+}

Back to the top