Add configvar documentation comments.

[doldaconnect.git] / daemon / client.c

diff --git a/daemon/client.c b/daemon/client.c
index 1e659ab..47ac9de 100644 (file)
--- a/daemon/client.c
+++ b/daemon/client.c
@@ -36,9 +36,9 @@
 #include "log.h"
 #include "utils.h"
 #include "module.h"
-#include "tiger.h"
 #include "net.h"
 #include "sysevents.h"
+#include <tiger.h>
 
 struct scanstate
 {
@@ -56,12 +56,24 @@ struct scanqueue
 static int conf_share(int argc, wchar_t **argv);
 static void freecache(struct sharecache *node);
 static void checkhashes(void);
+static void writehashcache(int now);
 
 static struct configvar myvars[] =
 {
+    /** The default nick name to use. The nickname can also be
+     * specified for individual hubs, overriding this setting. */
     {CONF_VAR_STRING, "defnick", {.str = L"DoldaConnect user"}},
+    /** When scanning shares, this bitmask is consulted for every
+     * regular file. Unless the file's mode has the bits specified by
+     * this mask set, it will not be shared. */
     {CONF_VAR_INT, "scanfilemask", {.num = 0004}},
+    /** When scanning shares, this bitmask is consulted for every
+     * directory encountered. Unless the directory's mode has the bits
+     * specified by this mask set, it will be ignored and any files
+     * under it will not be shared. */
     {CONF_VAR_INT, "scandirmask", {.num = 0005}},
+    /** The filename to use for the hash cache (see the FILES section
+     * for more information). */
     {CONF_VAR_STRING, "hashcache", {.str = L"dc-hashcache"}},
     {CONF_VAR_END}
 };
@@ -76,6 +88,7 @@ static struct scanstate *scanjob = NULL;
 static struct scanqueue *scanqueue = NULL;
 static struct sharepoint *shares = NULL;
 static struct hashcache *hashcache = NULL;
+static struct timer *hashwritetimer = NULL;
 /* Set initially to -1, but changed to 0 the first time run() is
  * called. This is to avoid forking a hash job before daemonizing,
  * since that would make the daemon unable to wait() for the hash
@@ -364,13 +377,28 @@ static void readhashcache(void)
     fclose(stream);
 }
 
-static void writehashcache(void)
+static void hashtimercb(int cancelled, void *uudata)
+{
+    hashwritetimer = NULL;
+    if(!cancelled)
+       writehashcache(1);
+}
+
+static void writehashcache(int now)
 {
     char *buf;
     char *hcname;
     FILE *stream;
     struct hashcache *hc;
     
+    if(!now)
+    {
+       if(hashwritetimer == NULL)
+           hashwritetimer = timercallback(ntime() + 300, (void (*)(int, void *))hashtimercb, NULL);
+       return;
+    }
+    if(hashwritetimer != NULL)
+       canceltimer(hashwritetimer);
     hcname = findhashcachefile(1);
     if((stream = fopen(hcname, "w")) == NULL)
     {
@@ -443,7 +471,7 @@ static void hashread(struct socket *sk, void *uudata)
            buf = base64decode(wv[3], NULL);
            memcpy(hc->tth, buf, 24);
            free(buf);
-           writehashcache();
+           writehashcache(0);
        }
        memmove(hashbuf, lp, hashbufdata -= (lp - hashbuf));
     }