-getting rid of duplication of record type values / enum GNUNET_GNS_RecordType

[oweals/gnunet.git] / src / gns / gns.h

diff --git a/src/gns/gns.h b/src/gns/gns.h
index 695722b785864287f783ee505d5ec8bcf46fa12a..a7697be1deace8460c00c41f6cba38b348fdf640 100644 (file)
--- a/src/gns/gns.h
+++ b/src/gns/gns.h
@@ -17,7 +17,6 @@
       Free Software Foundation, Inc., 59 Temple Place - Suite 330,
       Boston, MA 02111-1307, USA.
  */
-
 /**
  * @file gns/gns.h
  * @brief IPC messages between GNS API and GNS service
@@ -26,8 +25,25 @@
 #ifndef GNS_H
 #define GNS_H
 
-GNUNET_NETWORK_STRUCT_BEGIN
+#include "gnunet_gns_service.h"
+
+/**
+ * Name of the GADS TLD.
+ */
+#define GNUNET_GNS_TLD "gads"
+
+/**
+ * Name of the zone key TLD.
+ */
+#define GNUNET_GNS_TLD_ZKEY "zkey"
+
+/**
+ * TLD name used to indicate relative names.
+ */
+#define GNUNET_GNS_TLD_PLUS "+"
+
 
+GNUNET_NETWORK_STRUCT_BEGIN
 
 /**
  * Message from client to GNS service to lookup records.
@@ -35,27 +51,44 @@ GNUNET_NETWORK_STRUCT_BEGIN
 struct GNUNET_GNS_ClientLookupMessage
 {
   /**
-    * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_LOOKUP
+   * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_LOOKUP
    */
   struct GNUNET_MessageHeader header;
 
   /**
    * Unique identifier for this request (for key collisions).
    */
-  // FIXME: unaligned
-  uint64_t unique_id;
+  uint32_t id GNUNET_PACKED;
 
   /**
-   * the type of record to look up
+   * If use_default_zone is empty this zone is used for lookup
+   */
+  struct GNUNET_CRYPTO_ShortHashCode zone;
+
+  /**
+   * Only check cached results
+   */
+  uint32_t only_cached GNUNET_PACKED;
+
+  /**
+   * Should we look up in the given zone, instead of the default zone?
    */
-  // FIXME: bad type
-  int type;
+  uint32_t have_zone GNUNET_PACKED;
 
   /**
-   * Length of name to lookup
-   * // FIXME: redundant
+   * Is a shorten key attached?
    */
-  uint32_t namelen;
+  uint32_t have_key GNUNET_PACKED;
+
+  /**
+   * the type of record to look up
+   */
+  /* int */ uint32_t type;
+  
+  /**
+   * The key for shorten, if 'have_key' is set 
+   */
+  struct GNUNET_CRYPTO_EccPrivateKey shorten_key;
 
   /* Followed by the name to look up */
 };
@@ -64,7 +97,7 @@ struct GNUNET_GNS_ClientLookupMessage
 /**
  * Message from GNS service to client: new results.
  */
-struct GNUNET_GNS_ClientResultMessage
+struct GNUNET_GNS_ClientLookupResultMessage
 {
   /**
     * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_RESULT
@@ -74,26 +107,115 @@ struct GNUNET_GNS_ClientResultMessage
   /**
    * Unique identifier for this request (for key collisions).
    */
-  // FIXME: unaligned
-  uint64_t unique_id;
+  uint32_t id GNUNET_PACKED;
 
   /**
-   * A key. TODO some uid
-   * // FIXME: why hash?
+   * The number of records contained in response
+   */  
+  uint32_t rd_count;
+
+  /* followed by rd_count GNUNET_NAMESTORE_RecordData structs*/
+
+};
+
+
+/**
+ * Message from client to GNS service to shorten names.
+ */
+struct GNUNET_GNS_ClientShortenMessage
+{
+  /**
+   * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_SHORTEN
    */
-  GNUNET_HashCode key;
+  struct GNUNET_MessageHeader header;
 
   /**
-   * The number of records contained in response
-   */  
-  uint32_t num_records;
+   * Unique identifier for this request
+   */
+  uint32_t id GNUNET_PACKED;
 
-  // FIXME: what format has a GNS_Record?
-  /* followed by num_records GNUNET_GNS_Records*/
+  /**
+   * If use_default_zone is empty this zone is used for lookup
+   */
+  struct GNUNET_CRYPTO_ShortHashCode zone;
 
+  /**
+   * Shorten zone
+   */
+  struct GNUNET_CRYPTO_ShortHashCode shorten_zone;
+
+  /**
+   * Private zone
+   */
+  struct GNUNET_CRYPTO_ShortHashCode private_zone;
+
+  /**
+   * Should we look up in the default zone?
+   */
+  uint32_t use_default_zone GNUNET_PACKED;
+  
+  /* Followed by the name to shorten up */
+};
+
+
+/**
+ * Message from GNS service to client: shorten result.
+ */
+struct GNUNET_GNS_ClientShortenResultMessage
+{
+  /**
+   * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_SHORTEN_RESULT
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * Unique identifier for this request (for key collisions).
+   */
+  uint32_t id GNUNET_PACKED;
+
+  /* followed by the shortened name or '\0' for no result*/
+
+};
+
+
+/**
+ * Message from client to GNS service to lookup an authority of a name.
+ */
+struct GNUNET_GNS_ClientGetAuthMessage
+{
+  /**
+   * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_GET_AUTH
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * Unique identifier for this request
+   */
+  uint32_t id GNUNET_PACKED;
+
+  /* Followed by the name to get authority for */
 };
 
 
+/**
+ * Message from GNS service to client: authority result.
+ */
+struct GNUNET_GNS_ClientGetAuthResultMessage
+{
+  /**
+   * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_GET_AUTH_RESULT
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * Unique identifier for this request (for key collisions).
+   */
+  uint32_t id GNUNET_PACKED;
+
+  /* followed by the authority part of the name or '\0' for no result*/
+
+};
+
 GNUNET_NETWORK_STRUCT_END
 
 #endif