chiark / gitweb /
Keepalives: Document that they're unimplemented; remove vestigial code
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Wed, 13 Jul 2011 23:52:47 +0000 (00:52 +0100)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Wed, 17 Aug 2011 22:03:55 +0000 (23:03 +0100)
Keepalives are not actually implemented; the keepalive option does
nothing.  Mention this in the README.  Remove the option's parsing
and recording from site.c.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
README
site.c

diff --git a/README b/README
index b094e66..73679c2 100644 (file)
--- a/README
+++ b/README
@@ -290,7 +290,8 @@ site: dict argument
     allowing another attempt [20000]
   renegotiate-time (integer): if we see traffic on the link after this time
     then renegotiate another session key immediately [depends on key-lifetime]
-  keepalive (bool): if True then attempt always to keep a valid session key
+  keepalive (bool): if True then attempt always to keep a valid session key.
+    Not actually currently implemented. [false]
   log-events (string list): types of events to log for this site
     unexpected: unexpected key setup packets (may be late retransmissions)
     setup-init: start of attempt to setup a session key
diff --git a/site.c b/site.c
index 006d9b4..a7775bd 100644 (file)
--- a/site.c
+++ b/site.c
@@ -154,8 +154,6 @@ struct site {
     int32_t key_renegotiate_time; /* If we see traffic (or a keepalive)
                                      after this time, initiate a new
                                      key exchange */
-    bool_t keepalive; /* Send keepalives to detect peer failure (not yet
-                        implemented) */
 
     uint8_t *setupsig; /* Expected signature of incoming MSG1 packets */
     int32_t setupsiglen; /* Allows us to discard packets quickly if
@@ -1259,7 +1257,6 @@ static list_t *site_apply(closure_t *self, struct cloc loc, dict_t *context,
        cfgfatal(loc,"site",
                 "renegotiate-time must be less than key-lifetime\n");
     }
-    st->keepalive=dict_read_bool(dict,"keepalive",False,"site",loc,False);
 
     st->log_events=string_list_to_word(dict_lookup(dict,"log-events"),
                                       log_event_table,"site");