add nick name for cached records

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

diff --git a/src/datastore/datastore.h b/src/datastore/datastore.h
index 9165c8af89515c63ab03588e98bcfb0a0842a130..75e122058d30db0cf61bcfc3acb02e41b13e04d5 100644 (file)
--- a/src/datastore/datastore.h
+++ b/src/datastore/datastore.h
@@ -4,7 +4,7 @@
 
      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
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file datastore/datastore.hc
+ * @file datastore/datastore.h
  * @brief structs for communication between datastore service and API
  * @author Christian Grothoff
  */
@@ -27,28 +27,78 @@
 #ifndef DATASTORE_H
 #define DATASTORE_H
 
+
 #include "gnunet_util_lib.h"
 
+GNUNET_NETWORK_STRUCT_BEGIN
+
 /**
  * Message from datastore service informing client about
  * the current size of the datastore.
  */
-struct SizeMessage
+struct ReserveMessage
 {
   /**
-   * Type is GNUNET_MESSAGE_TYPE_DATASTORE_SIZE.
+   * Type is GNUNET_MESSAGE_TYPE_DATASTORE_RESERVE.
    */
   struct GNUNET_MessageHeader header;
 
   /**
-   * Always zero.
+   * Number of items to reserve.
    */
-  uint32_t reserved GNUNET_PACKED;
+  uint32_t entries GNUNET_PACKED;
+
+  /**
+   * Number of bytes to reserve.
+   */
+  uint64_t amount GNUNET_PACKED;
+};
+
+
+/**
+ * Message from datastore service informing client about
+ * the success or failure of a requested operation.
+ * This header is optionally followed by a variable-size,
+ * 0-terminated error message.
+ */
+struct StatusMessage
+{
+  /**
+   * Type is GNUNET_MESSAGE_TYPE_DATASTORE_STATUS.
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * Status code, -1 for errors.
+   */
+  int32_t status GNUNET_PACKED;
+
+  /**
+   * Minimum expiration time required for content to be stored
+   * by the datacache at this time, zero for unknown or no limit.
+   */
+  struct GNUNET_TIME_AbsoluteNBO min_expiration;
 
+};
+
+
+/**
+ * Message from datastore client informing service that
+ * the remainder of the reserved bytes can now be released
+ * for other requests.
+ */
+struct ReleaseReserveMessage
+{
   /**
-   * Size of the datastore in bytes.
+   * Type is GNUNET_MESSAGE_TYPE_DATASTORE_RELEASE_RESERVE.
    */
-  uint64_t size GNUNET_PACKED;
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * Reservation id.
+   */
+  int32_t rid GNUNET_PACKED;
+
 };
 
 
@@ -60,21 +110,79 @@ struct GetMessage
 {
   /**
    * Type is GNUNET_MESSAGE_TYPE_DATASTORE_GET.  Size
-   * can either be "sizeof(struct GetMessage)" or 
-   * "sizeof(struct GetMessage) - sizeof(GNUNET_HashCode)"!
+   * can either be "sizeof(struct GetMessage)" or
+   * "sizeof(struct GetMessage) - sizeof(struct GNUNET_HashCode)"!
    */
   struct GNUNET_MessageHeader header;
 
   /**
-   * Desired content type.
+   * Desired content type.  (actually an enum GNUNET_BLOCK_Type)
    */
   uint32_t type GNUNET_PACKED;
 
+  /**
+   * Offset of the result.
+   */
+  uint64_t offset GNUNET_PACKED;
+
   /**
    * Desired key (optional).  Check the "size" of the
    * header to see if the key is actually present.
    */
-  GNUNET_HashCode key GNUNET_PACKED;
+  struct GNUNET_HashCode key;
+
+};
+
+
+/**
+ * Message to the datastore service asking about zero
+ * anonymity content.
+ */
+struct GetZeroAnonymityMessage
+{
+  /**
+   * Type is GNUNET_MESSAGE_TYPE_DATASTORE_GET_ZERO_ANONYMITY.
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * Desired content type (actually an enum GNUNET_BLOCK_Type)
+   */
+  uint32_t type GNUNET_PACKED;
+
+  /**
+   * Offset of the result.
+   */
+  uint64_t offset GNUNET_PACKED;
+
+};
+
+
+/**
+ * Message to the datastore service requesting an update
+ * to the priority or expiration for some content.
+ */
+struct UpdateMessage
+{
+  /**
+   * Type is GNUNET_MESSAGE_TYPE_DATASTORE_UPDATE.
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * Desired priority increase.
+   */
+  int32_t priority GNUNET_PACKED;
+
+  /**
+   * Desired new expiration time.
+   */
+  struct GNUNET_TIME_AbsoluteNBO expiration;
+
+  /**
+   * Unique ID for the content.
+   */
+  uint64_t uid;
 
 };
 
@@ -94,9 +202,9 @@ struct DataMessage
   struct GNUNET_MessageHeader header;
 
   /**
-   * Always zero.
+   * Reservation ID to use; use zero for none.
    */
-  uint32_t reserved GNUNET_PACKED;
+  uint32_t rid GNUNET_PACKED;
 
   /**
    * Number of bytes in the item (NBO).
@@ -104,7 +212,7 @@ struct DataMessage
   uint32_t size GNUNET_PACKED;
 
   /**
-   * Type of the item (NBO), zero for remove.
+   * Type of the item (NBO), zero for remove,  (actually an enum GNUNET_BLOCK_Type)
    */
   uint32_t type GNUNET_PACKED;
 
@@ -112,12 +220,30 @@ struct DataMessage
    * Priority of the item (NBO), zero for remove.
    */
   uint32_t priority GNUNET_PACKED;
-  
+
   /**
    * Desired anonymity level (NBO), zero for remove.
    */
   uint32_t anonymity GNUNET_PACKED;
-  
+
+  /**
+   * Desired replication level. 0 from service to API.
+   */
+  uint32_t replication GNUNET_PACKED;
+
+  /**
+   * For alignment.
+   */
+  uint32_t reserved GNUNET_PACKED;
+
+  /**
+   * Unique ID for the content (can be used for UPDATE);
+   * can be zero for remove (which indicates that
+   * the datastore should use whatever UID matches
+   * the key and content).
+   */
+  uint64_t uid;
+
   /**
    * Expiration time (NBO); zero for remove.
    */
@@ -126,10 +252,10 @@ struct DataMessage
   /**
    * Key under which the item can be found.
    */
-  GNUNET_HashCode key GNUNET_PACKED;
+  struct GNUNET_HashCode key;
 
 };
-
+GNUNET_NETWORK_STRUCT_END