fix compiler warning for format string
[oweals/gnunet.git] / src / gns / gns.h
index c8d27b673767ecb609cecbb0d24bcd1b93b50a5c..ca5525f801895ec07891252e70668da48668ea1c 100644 (file)
@@ -1,10 +1,10 @@
 /*
       This file is part of GNUnet
-      (C) 2012-2013 Christian Grothoff (and other contributing authors)
+      Copyright (C) 2012-2013 GNUnet e.V.
 
       GNUnet is free software; you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published
-      by the Free Software Foundation; either version 2, or (at your
+      by the Free Software Foundation; either version 3, or (at your
       option) any later version.
 
       GNUnet is distributed in the hope that it will be useful, but
@@ -14,8 +14,8 @@
 
       You should have received a copy of the GNU General Public License
       along with GNUnet; see the file COPYING.  If not, write to the
-      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-      Boston, MA 02111-1307, USA.
+      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+      Boston, MA 02110-1301, USA.
  */
 /**
  * @file gns/gns.h
@@ -48,10 +48,10 @@ GNUNET_NETWORK_STRUCT_BEGIN
 /**
  * Message from client to GNS service to lookup records.
  */
-struct GNUNET_GNS_ClientLookupMessage
+struct LookupMessage
 {
   /**
-   * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_LOOKUP
+   * Header of type #GNUNET_MESSAGE_TYPE_GNS_LOOKUP
    */
   struct GNUNET_MessageHeader header;
 
@@ -63,12 +63,13 @@ struct GNUNET_GNS_ClientLookupMessage
   /**
    * Zone that is to be used for lookup
    */
-  struct GNUNET_CRYPTO_EccPublicKey zone;
+  struct GNUNET_CRYPTO_EcdsaPublicKey zone;
 
   /**
-   * Only check cached results
+   * Local options for where to look for results
+   * (an `enum GNUNET_GNS_LocalOptions` in NBO).
    */
-  int16_t only_cached GNUNET_PACKED;
+  int16_t options GNUNET_PACKED;
 
   /**
    * Is a shorten key attached?
@@ -78,24 +79,50 @@ struct GNUNET_GNS_ClientLookupMessage
   /**
    * the type of record to look up
    */
-  int32_t type;
-  
+  int32_t type GNUNET_PACKED;
+
   /**
-   * The key for shorten, if 'have_key' is set 
+   * The key for shorten, if @e have_key is set
    */
-  struct GNUNET_CRYPTO_EccPrivateKey shorten_key;
+  struct GNUNET_CRYPTO_EcdsaPrivateKey shorten_key;
 
-  /* Followed by the name to look up */
+  /* Followed by the zero-terminated name to look up */
 };
 
 
+/**
+ * Message from client to GNS service to lookup records.
+ */
+struct ReverseLookupMessage
+{
+  /**
+   * Header of type #GNUNET_MESSAGE_TYPE_GNS_REVERSE_LOOKUP
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * Unique identifier for this request (for key collisions).
+   */
+  uint32_t id GNUNET_PACKED;
+
+  /**
+   * Zone that is target for reverse lookup
+   */
+  struct GNUNET_CRYPTO_EcdsaPublicKey zone_pkey;
+  
+  /**
+   * Root zone
+   */
+  struct GNUNET_CRYPTO_EcdsaPublicKey root_pkey;
+};
+
 /**
  * Message from GNS service to client: new results.
  */
-struct GNUNET_GNS_ClientLookupResultMessage
+struct LookupResultMessage
 {
   /**
-    * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_RESULT
+    * Header of type #GNUNET_MESSAGE_TYPE_GNS_LOOKUP_RESULT
    */
   struct GNUNET_MessageHeader header;
 
@@ -106,11 +133,29 @@ struct GNUNET_GNS_ClientLookupResultMessage
 
   /**
    * The number of records contained in response
-   */  
-  uint32_t rd_count;
+   */
+  uint32_t rd_count GNUNET_PACKED;
+
+  /* followed by rd_count GNUNET_GNSRECORD_Data structs*/
 
-  /* followed by rd_count GNUNET_NAMESTORE_RecordData structs*/
+};
+
+/**
+ * Message from GNS service to client: new results.
+ */
+struct ReverseLookupResultMessage
+{
+  /**
+    * Header of type #GNUNET_MESSAGE_TYPE_GNS_REVERSE_LOOKUP_RESULT
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * Unique identifier for this request (for key collisions).
+   */
+  uint32_t id GNUNET_PACKED;
 
+  /* followed by the resulting name of the reverse lookup */
 };