svn commit: r958921 - /activemq/trunk/activemq-pool/src/main/java/org/apache/activemq/pool/PooledConnectionFactory.java

[gt...@apache.org]

Author: gtully
Date: Tue Jun 29 10:45:06 2010
New Revision: 958921

URL: http://svn.apache.org/viewvc?rev=958921&view=rev
Log:
tidy up doc comment re pooling: resolve https://issues.apache.org/activemq/browse/AMQ-2806

Modified:
    activemq/trunk/activemq-pool/src/main/java/org/apache/activemq/pool/PooledConnectionFactory.java

Modified: activemq/trunk/activemq-pool/src/main/java/org/apache/activemq/pool/PooledConnectionFactory.java
URL: http://svn.apache.org/viewvc/activemq/trunk/activemq-pool/src/main/java/org/apache/activemq/pool/PooledConnectionFactory.java?rev=958921&r1=958920&r2=958921&view=diff
==============================================================================
--- activemq/trunk/activemq-pool/src/main/java/org/apache/activemq/pool/PooledConnectionFactory.java (original)
+++ activemq/trunk/activemq-pool/src/main/java/org/apache/activemq/pool/PooledConnectionFactory.java Tue Jun 29 10:45:06 2010
@@ -35,13 +35,16 @@ import org.apache.commons.pool.impl.Gene
 
 /**
  * A JMS provider which pools Connection, Session and MessageProducer instances
- * so it can be used with tools like Spring's <a
- * href="http://activemq.org/Spring+Support">JmsTemplate</a>.
+ * so it can be used with tools like <a href="http://camel.apache.org/activemq.html">Camel</a> and Spring's <a
+ * href="http://activemq.apache.org/spring-support.html">JmsTemplate and MessagListenerContainer</a>.
  * 
- * <b>NOTE</b> this implementation is only intended for use when sending
- * messages. It does not deal with pooling of consumers; for that look at a
- * library like <a href="http://jencks.org/">Jencks</a> such as in <a
- * href="http://jencks.org/Message+Driven+POJOs">this example</a>
+ * <b>NOTE</b> this implementation does not pool consumers. Pooling makes sense for seldom used
+ * resources that are expensive to create and can remain idle a minimal cost. like sessions and producers.
+ * Consumers on the other hand, will consume messages even when idle due to <a 
+ * href="http://activemq.apache.org/what-is-the-prefetch-limit-for.html">prefetch</a>.
+ * If you want to consider a consumer pool, configure an appropriate prefetch and a pool
+ * allocation strategy that is inclusive. Also note that message order guarantees will be
+ * lost across the consumer pool. 
  * 
  * @org.apache.xbean.XBean element="pooledConnectionFactory"
  *