[GNUnet-SVN] r20671 - gnunet/src/gns

[gnunet]

Author: schanzen
Date: 2012-03-22 12:22:37 +0100 (Thu, 22 Mar 2012)
New Revision: 20671

Modified:
   gnunet/src/gns/gns.conf.in
   gnunet/src/gns/gnunet-service-gns_resolver.h
Log:
-doc, new config options


Modified: gnunet/src/gns/gns.conf.in
===================================================================
--- gnunet/src/gns/gns.conf.in  2012-03-22 11:05:22 UTC (rev 20670)
+++ gnunet/src/gns/gns.conf.in  2012-03-22 11:22:37 UTC (rev 20671)
@@ -8,6 +8,8 @@
 ZONEKEY = $SERVICEHOME/gns/zonekey.zkey
 HIJACK_DNS = NO
 AUTO_IMPORT_PKEY = YES
+MAX_PARALLEL_BACKGROUND_QUERIES = 25
+DEFAULT_LOOKUP_TIMEOUT = 10
 
 [fcfsd]
 HTTPPORT = 18080

Modified: gnunet/src/gns/gnunet-service-gns_resolver.h
===================================================================
--- gnunet/src/gns/gnunet-service-gns_resolver.h        2012-03-22 11:05:22 UTC 
(rev 20670)
+++ gnunet/src/gns/gnunet-service-gns_resolver.h        2012-03-22 11:22:37 UTC 
(rev 20671)
@@ -144,9 +144,16 @@
   /* status of the resolution result */
   enum ResolutionStatus status;
 
+  /**
+   * private key of an/our authoritative zone
+   * can be NULL but automatical PKEY import will not work
+   */
   struct GNUNET_CRYPTO_RsaPrivateKey *priv_key;
 
-  /* the heap node associated with this lookup, null if timeout is set */
+  /**
+   * the heap node associated with this lookup, null if timeout is set
+   * used for DHT background lookups.
+   */
   struct GNUNET_CONTAINER_HeapNode *dht_heap_node;
 
 };
@@ -233,6 +240,7 @@
 
 /**
  * Initialize the resolver
+ * MUST be called before other gns_resolver_* methods
  *
  * @param nh handle to the namestore
  * @param dh handle to the dht
@@ -262,6 +270,18 @@
                            RecordLookupProcessor proc,
                            void* cls);
 
+/**
+ * Shortens a name if possible. If the shortening fails
+ * name will be returned as shortened string. Else
+ * a shorter version of the name will be returned.
+ * There is no guarantee that the shortened name will
+ * actually be canonical/short etc.
+ *
+ * @param zone the zone to perform the operation in
+ * @param name name to shorten
+ * @param proc the processor to call on shorten result
+ * @param proc_cls teh closure to pass to proc
+ */
 void
 gns_resolver_shorten_name(struct GNUNET_CRYPTO_ShortHashCode zone,
                           const char* name,