fix related to #4909/12605: force desirability of path if path is in use
[oweals/gnunet.git] / src / namestore / namestore.h
index 7d406df61d56be3c0124da9736c05e9bcbb4407c..ec7f2870401b8a78acc83b483c03d7d1d4a0a29b 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2011-2013 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2011-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
@@ -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.
 */
 
 /**
@@ -48,142 +48,135 @@ struct GNUNET_NAMESTORE_Header
   /**
    * Request ID in NBO
    */
-  uint32_t r_id;
+  uint32_t r_id GNUNET_PACKED;
 };
 
 
 /**
- * Lookup a block in the namestore
+ * Store a record to the namestore (as authority).
  */
-struct LookupBlockMessage
+struct RecordStoreMessage
 {
   /**
-   * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_BLOCK
+   * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE
    */
   struct GNUNET_NAMESTORE_Header gns_header;
 
   /**
-   * The query.
+   * Expiration time
    */
-  struct GNUNET_HashCode query;
-
-};
+  struct GNUNET_TIME_AbsoluteNBO expire;
 
+  /**
+   * Name length
+   */
+  uint16_t name_len GNUNET_PACKED;
 
-/**
- * Lookup response
- */
-struct LookupBlockResponseMessage
-{
   /**
-   * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_BLOCK_RESPONSE
+   * Length of serialized record data
    */
-  struct GNUNET_NAMESTORE_Header gns_header;
+  uint16_t rd_len GNUNET_PACKED;
 
   /**
-   * Expiration time
+   * Number of records contained
    */
-  struct GNUNET_TIME_AbsoluteNBO expire;
+  uint16_t rd_count GNUNET_PACKED;
 
   /**
-   * Signature.
+   * always zero (for alignment)
    */
-  struct GNUNET_CRYPTO_EccSignature signature;
+  uint16_t reserved GNUNET_PACKED;
 
   /**
-   * Derived public key.
+   * The private key of the authority.
    */
-  struct GNUNET_CRYPTO_EccPublicKey derived_key;
+  struct GNUNET_CRYPTO_EcdsaPrivateKey private_key;
 
-  /* follwed by encrypted block data */
+  /* followed by:
+   * name with length name_len
+   * serialized record data with rd_count records
+   */
 };
 
 
 /**
- * Cache a record in the namestore.
+ * Response to a record storage request.
  */
-struct BlockCacheMessage
+struct RecordStoreResponseMessage
 {
   /**
-   * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_BLOCK_CACHE
+   * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE
    */
   struct GNUNET_NAMESTORE_Header gns_header;
 
   /**
-   * Expiration time
-   */
-  struct GNUNET_TIME_AbsoluteNBO expire;
-
-  /**
-   * Signature.
-   */
-  struct GNUNET_CRYPTO_EccSignature signature;
-
-  /**
-   * Derived public key.
+   * #GNUNET_SYSERR on failure, #GNUNET_OK on success
    */
-  struct GNUNET_CRYPTO_EccPublicKey derived_key;
-
-  /* follwed by encrypted block data */
+  int32_t op_result GNUNET_PACKED;
 };
 
 
 /**
- * Response to a request to cache a block.
+ * Lookup a label
  */
-struct BlockCacheResponseMessage
+struct LabelLookupMessage
 {
   /**
-   * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_BLOCK_CACHE_RESPONSE
+   * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP
    */
   struct GNUNET_NAMESTORE_Header gns_header;
 
   /**
-   * #GNUNET_OK on success, #GNUNET_SYSERR error
+   * Length of the name
+   */
+  uint32_t label_len GNUNET_PACKED;
+
+  /**
+   * The private key of the zone to look up in
+   */
+  struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
+
+  /* followed by:
+   * name with length name_len
    */
-  int32_t op_result;
 };
 
 
 /**
- * Store a record to the namestore (as authority).
+ * Lookup a label
  */
-struct RecordStoreMessage
+struct LabelLookupResponseMessage
 {
   /**
-   * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE
+   * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_LOOKUP_RESPONSE
    */
   struct GNUNET_NAMESTORE_Header gns_header;
 
-  /**
-   * Expiration time
-   */
-  struct GNUNET_TIME_AbsoluteNBO expire;
-
   /**
    * Name length
    */
-  uint16_t name_len;
+  uint16_t name_len GNUNET_PACKED;
 
   /**
    * Length of serialized record data
    */
-  uint16_t rd_len;
+  uint16_t rd_len GNUNET_PACKED;
 
   /**
-   * Number of records contained 
+   * Number of records contained
    */
-  uint16_t rd_count;
+  uint16_t rd_count GNUNET_PACKED;
 
   /**
-   * always zero (for alignment)
+   * Was the label found in the database??
+   * GNUNET_YES or GNUNET_NO
    */
-  uint16_t reserved;
+  uint16_t found GNUNET_PACKED;
 
   /**
    * The private key of the authority.
    */
-  struct GNUNET_CRYPTO_EccPrivateKey private_key;
+  struct GNUNET_CRYPTO_EcdsaPrivateKey private_key;
 
   /* followed by:
    * name with length name_len
@@ -192,23 +185,6 @@ struct RecordStoreMessage
 };
 
 
-/**
- * Response to a record storage request.
- */
-struct RecordStoreResponseMessage
-{
-  /**
-   * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE
-   */
-  struct GNUNET_NAMESTORE_Header gns_header;
-
-  /**
-   * #GNUNET_SYSERR on failure, #GNUNET_OK on success
-   */
-  int32_t op_result;
-};
-
-
 
 /**
  * Lookup a name for a zone hash
@@ -221,14 +197,14 @@ struct ZoneToNameMessage
   struct GNUNET_NAMESTORE_Header gns_header;
 
   /**
-   * The private key of the zone to look up in 
+   * The private key of the zone to look up in
    */
-  struct GNUNET_CRYPTO_EccPrivateKey zone;
+  struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
 
   /**
-   * The public key of the target zone  
+   * The public key of the target zone
    */
-  struct GNUNET_CRYPTO_EccPublicKey value_zone;
+  struct GNUNET_CRYPTO_EcdsaPublicKey value_zone;
 };
 
 
@@ -245,28 +221,28 @@ struct ZoneToNameResponseMessage
   /**
    * Length of the name
    */
-  uint16_t name_len;
+  uint16_t name_len GNUNET_PACKED;
 
   /**
    * Length of serialized record data
    */
-  uint16_t rd_len;
+  uint16_t rd_len GNUNET_PACKED;
 
   /**
    * Number of records contained
    */
-  uint16_t rd_count;
+  uint16_t rd_count GNUNET_PACKED;
 
   /**
    * result in NBO: #GNUNET_OK on success, #GNUNET_NO if there were no
-   * results, #GNUNET_SYSERR on error 
+   * results, #GNUNET_SYSERR on error
    */
-  int16_t res;
+  int16_t res GNUNET_PACKED;
 
   /**
    * The private key of the zone that contained the name.
    */
-  struct GNUNET_CRYPTO_EccPrivateKey zone;
+  struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
 
   /* followed by:
    * name with length name_len
@@ -289,27 +265,27 @@ struct RecordResultMessage
   /**
    * Name length
    */
-  uint16_t name_len;
+  uint16_t name_len GNUNET_PACKED;
 
   /**
    * Length of serialized record data
    */
-  uint16_t rd_len;
+  uint16_t rd_len GNUNET_PACKED;
 
   /**
-   * Number of records contained 
+   * Number of records contained
    */
-  uint16_t rd_count;
+  uint16_t rd_count GNUNET_PACKED;
 
   /**
    * always zero (for alignment)
    */
-  uint16_t reserved;
+  uint16_t reserved GNUNET_PACKED;
 
   /**
    * The private key of the authority.
    */
-  struct GNUNET_CRYPTO_EccPrivateKey private_key;
+  struct GNUNET_CRYPTO_EcdsaPrivateKey private_key;
 
   /* followed by:
    * name with length name_len
@@ -326,12 +302,18 @@ struct ZoneMonitorStartMessage
   /**
    * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START
    */
-  struct GNUNET_NAMESTORE_Header gns_header;
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * #GNUNET_YES to first iterate over all records,
+   * #GNUNET_NO to only monitor changes.o
+   */
+  uint32_t iterate_first GNUNET_PACKED;
 
   /**
    * Zone key.
    */
-  struct GNUNET_CRYPTO_EccPrivateKey zone;
+  struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
 
 };
 
@@ -349,7 +331,7 @@ struct ZoneIterationStartMessage
   /**
    * Zone key.  All zeros for "all zones".
    */
-  struct GNUNET_CRYPTO_EccPrivateKey zone;
+  struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
 
 };