hc-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject svn commit: r1406304 - /httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/pool/PoolStats.java
Date Tue, 06 Nov 2012 20:19:04 GMT
Author: ggregory
Date: Tue Nov  6 20:19:03 2012
New Revision: 1406304

URL: http://svn.apache.org/viewvc?rev=1406304&view=rev
Log:
Javadoc.

Modified:
    httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/pool/PoolStats.java

Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/pool/PoolStats.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/pool/PoolStats.java?rev=1406304&r1=1406303&r2=1406304&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/pool/PoolStats.java
(original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/pool/PoolStats.java
Tue Nov  6 20:19:03 2012
@@ -30,9 +30,11 @@ import org.apache.http.annotation.Immuta
 
 /**
  * Pool statistics.
- *
+ * <p>
+ * The total number of connections in the pool is equal to {@code available} plus {@code
leased}.
+ * </p>
+ * 
  * @since 4.2
- *
  */
 @Immutable
 public class PoolStats {
@@ -50,18 +52,46 @@ public class PoolStats {
         this.max = max;
     }
 
+	/**
+	 * Gets the number of persistent connections tracked by the connection manager currently
being used to execute
+	 * requests.
+	 * <p>
+	 * The total number of connections in the pool is equal to {@code available} plus {@code
leased}.
+	 * </p>
+	 * 
+	 * @return the number of persistent connections.
+	 */
     public int getLeased() {
         return this.leased;
     }
 
+	/**
+	 * Gets the number of connection requests being blocked awaiting a free connection. This
can happen only if there
+	 * are more worker threads contending for fewer connections.
+	 * 
+	 * @return the number of connection requests being blocked awaiting a free connection.
+	 */
     public int getPending() {
         return this.pending;
     }
 
+	/**
+	 * Gets the number idle persistent connections.
+	 * <p>
+	 * The total number of connections in the pool is equal to {@code available} plus {@code
leased}.
+	 * </p>
+	 * 
+	 * @return number idle persistent connections.
+	 */
     public int getAvailable() {
         return this.available;
     }
 
+	/**
+	 * Gets the maximum number of allowed persistent connections.
+	 * 
+	 * @return the maximum number of allowed persistent connections.
+	 */
     public int getMax() {
         return this.max;
     }



Mime
View raw message