Documentation tweak.
authorMike Taylor <mike@indexdata.com>
Tue, 6 Jun 2006 16:27:56 +0000 (16:27 +0000)
committerMike Taylor <mike@indexdata.com>
Tue, 6 Jun 2006 16:27:56 +0000 (16:27 +0000)
lib/ZOOM/Pod.pm

index dd6e14c..f285fa4 100644 (file)
@@ -1,4 +1,4 @@
-# $Id: Pod.pm,v 1.10 2006-05-12 13:31:00 mike Exp $
+# $Id: Pod.pm,v 1.11 2006-06-06 16:27:56 mike Exp $
 
 package ZOOM::Pod;
 
@@ -72,12 +72,17 @@ handle errors.
  $pod = new ZOOM::Pod("bagel.indexdata.com/gils",
                       "bagel.indexdata.com/marc");
 
-
 Creates a new pod containing one or more connections.  Each connection
 may be specified either by an existing C<ZOOM::Connection> object,
 which I<must> be asynchronous; or by a ZOOM target string, in which
 case the pod module will make the connection object itself.
 
+If the constructor's first argument is a number, then it is taken as a
+limit on the number of connections to handle at any one time.  In this
+case, the pod initially multiplexes between the first I<n>
+connections, and brings further connections into the active subset
+whenever already-active connections are closed.
+
 Returns the new pod.
 
 =cut