[or-cvs] Document the swiss-army-knife that retry_listeners has become

[nickm@seul.org (Nick Mathewson)]

Update of /home/or/cvsroot/src/or
In directory moria.mit.edu:/tmp/cvs-serv15087/src/or

Modified Files:
	connection.c 
Log Message:
Document the swiss-army-knife that retry_listeners has become

Index: connection.c
===================================================================
RCS file: /home/or/cvsroot/src/or/connection.c,v
retrieving revision 1.269
retrieving revision 1.270
diff -u -d -r1.269 -r1.270
--- connection.c	24 Oct 2004 01:29:01 -0000	1.269
+++ connection.c	24 Oct 2004 01:50:33 -0000	1.270
@@ -552,6 +552,17 @@
   }
 }
 
+/** 
+ * Launch any configured listener connections of type <b>type</b>.  (A
+ * listener is configured if <b>port_option</b> is non-zero.  If any
+ * BindAddress configuration options are given in <b>cfg</b>, create a
+ * connection binding to each one.  Otherwise, create a single
+ * connection binding to the address <b>default_addr</b>.)
+ *
+ * If <b>force</b> is true, close and re-open all listener connections.
+ * Otherwise, only relaunch the listeners of this type if the number of 
+ * existing connections is not as configured (e.g., because one died).
+ */
 static int retry_listeners(int type, struct config_line_t *cfg,
                            int port_option, const char *default_addr,
                            int force)