]> git.ipfire.org Git - thirdparty/squid.git/commitdiff
Document PconnPool
authorAmos Jeffries <squid3@treenet.co.nz>
Thu, 7 Oct 2010 06:34:34 +0000 (19:34 +1300)
committerAmos Jeffries <squid3@treenet.co.nz>
Thu, 7 Oct 2010 06:34:34 +0000 (19:34 +1300)
src/pconn.h

index 34e979a08467c97eff773a58326654c7b63f1888..e874e22c7a93cbeff4cea075cf31fb0582976987 100644 (file)
@@ -65,7 +65,13 @@ class IdleConnLimit;
 /* for hash_table */
 #include "hash.h"
 
-/// \ingroup PConnAPI
+/** \ingroup PConnAPI
+ * Manages idle persistent connections to a caller-defined set of
+ * servers (e.g., all HTTP servers). Uses a collection of IdleConnLists
+ * internally to list the individual open connections to each server.
+ * Controls lists existence and limits the total number of
+ * idle connections across the collection.
+ */
 class PconnPool
 {