From: Nick Mathewson <nickm@torproject.org>
Date: Sun, 24 Oct 2004 01:50:33 +0000 (+0000)
Subject: Document the swiss-army-knife that retry_listeners has become
X-Git-Tag: debian-version-0.0.8+0.0.9pre5-1~197
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ef4ac65f5e1d6223881ba952702b001e0be849b4;p=thirdparty%2Ftor.git

Document the swiss-army-knife that retry_listeners has become


svn:r2584
---

diff --git a/src/or/connection.c b/src/or/connection.c
index f90b07f20e..0c45b7fb2b 100644
--- a/src/or/connection.c
+++ b/src/or/connection.c
@@ -552,6 +552,17 @@ static void listener_close_if_present(int type) {
   }
 }
 
+/** 
+ * 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)