1 files changed, 73 insertions, 65 deletions

diff --git a/src/include/gnunet_namestore_plugin.h b/src/include/gnunet_namestore_plugin.h
index 3dca5a853..b7bcc4eb6 100644
--- a/src/include/gnunet_namestore_plugin.h
+++ b/src/include/gnunet_namestore_plugin.h
@@ -19,6 +19,9 @@
  */
 
 /**
+ * @addtogroup GNS
+ * @{
+ *
  * @author Christian Grothoff
  *
  * @file
@@ -31,6 +34,7 @@
 #ifndef GNUNET_NAMESTORE_PLUGIN_H
 #define GNUNET_NAMESTORE_PLUGIN_H
 
+
 #include "gnunet_util_lib.h"
 #include "gnunet_namestore_service.h"
 
@@ -49,6 +53,7 @@ extern "C"
  * @param cls closure
  * @param serial unique serial number of the record, MUST NOT BE ZERO,
  *               and must be monotonically increasing while iterating
+ * @param editor_hint content of the editor field when record was read (may be NULL)
  * @param zone_key private key of the zone
  * @param label name that is being mapped (at most 255 characters long)
  * @param rd_count number of entries in @a rd array
@@ -57,8 +62,9 @@ extern "C"
 typedef void
 (*GNUNET_NAMESTORE_RecordIterator) (void *cls,
                                     uint64_t serial,
+                                    const char *editor_hint,
                                     const struct
-                                    GNUNET_IDENTITY_PrivateKey *private_key,
+                                    GNUNET_CRYPTO_PrivateKey *private_key,
                                     const char *label,
                                     unsigned int rd_count,
                                     const struct GNUNET_GNSRECORD_Data *rd);
@@ -85,12 +91,12 @@ struct GNUNET_NAMESTORE_PluginFunctions
    * @param rd array of records with data to store
    * @return #GNUNET_OK on success, else #GNUNET_SYSERR
    */
-  int
-  (*store_records) (void *cls,
-                    const struct GNUNET_IDENTITY_PrivateKey *zone,
-                    const char *label,
-                    unsigned int rd_count,
-                    const struct GNUNET_GNSRECORD_Data *rd);
+  enum GNUNET_GenericReturnValue
+  (*store_records)(void *cls,
+                   const struct GNUNET_CRYPTO_PrivateKey *zone,
+                   const char *label,
+                   unsigned int rd_count,
+                   const struct GNUNET_GNSRECORD_Data *rd);
 
   /**
    * Lookup records in the datastore for which we are the authority.
@@ -102,12 +108,12 @@ struct GNUNET_NAMESTORE_PluginFunctions
    * @param iter_cls closure for @a iter
    * @return #GNUNET_OK on success, #GNUNET_NO for no results, else #GNUNET_SYSERR
    */
-  int
-  (*lookup_records) (void *cls,
-                     const struct GNUNET_IDENTITY_PrivateKey *zone,
-                     const char *label,
-                     GNUNET_NAMESTORE_RecordIterator iter,
-                     void *iter_cls);
+  enum GNUNET_GenericReturnValue
+  (*lookup_records)(void *cls,
+                    const struct GNUNET_CRYPTO_PrivateKey *zone,
+                    const char *label,
+                    GNUNET_NAMESTORE_RecordIterator iter,
+                    void *iter_cls);
 
 
   /**
@@ -124,13 +130,13 @@ struct GNUNET_NAMESTORE_PluginFunctions
    * @param iter_cls closure for @a iter
    * @return #GNUNET_OK on success, #GNUNET_NO if there were no more results, #GNUNET_SYSERR on error
    */
-  int
-  (*iterate_records) (void *cls,
-                      const struct GNUNET_IDENTITY_PrivateKey *zone,
-                      uint64_t serial,
-                      uint64_t limit,
-                      GNUNET_NAMESTORE_RecordIterator iter,
-                      void *iter_cls);
+  enum GNUNET_GenericReturnValue
+  (*iterate_records)(void *cls,
+                     const struct GNUNET_CRYPTO_PrivateKey *zone,
+                     uint64_t serial,
+                     uint64_t limit,
+                     GNUNET_NAMESTORE_RecordIterator iter,
+                     void *iter_cls);
 
 
   /**
@@ -144,77 +150,77 @@ struct GNUNET_NAMESTORE_PluginFunctions
    * @param iter_cls closure for @a iter
    * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
    */
-  int
-  (*zone_to_name) (void *cls,
-                   const struct GNUNET_IDENTITY_PrivateKey *zone,
-                   const struct GNUNET_IDENTITY_PublicKey *value_zone,
-                   GNUNET_NAMESTORE_RecordIterator iter,
-                   void *iter_cls);
+  enum GNUNET_GenericReturnValue
+  (*zone_to_name)(void *cls,
+                  const struct GNUNET_CRYPTO_PrivateKey *zone,
+                  const struct GNUNET_CRYPTO_PublicKey *value_zone,
+                  GNUNET_NAMESTORE_RecordIterator iter,
+                  void *iter_cls);
 
   /** Transaction-based API draft **/
 
   /**
-   * Start a transaction in the database
+   * Edit records in the namestore.
+   * This modifies the editor hint, an advisory lock entry.
+   * The record iterator will be called with the old editor hint (if any).
    *
    * @param cls closure (internal context for the plugin)
-   * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
+   * @param zone private key of the zone
+   * @param editor_hint the new value for the advisory lock field
+   * @param label name of the record in the zone
+   * @param iter function to call with the result
+   * @param iter_cls closure for @a iter
+   * @return #GNUNET_OK on success, #GNUNET_NO for no results, else #GNUNET_SYSERR
    */
   enum GNUNET_GenericReturnValue
-  (*transaction_begin) (void *cls);
+  (*edit_records)(void *cls,
+                  const char *editor_hint,
+                  const struct GNUNET_CRYPTO_PrivateKey *zone,
+                  const char *label,
+                  GNUNET_NAMESTORE_RecordIterator iter,
+                  void *iter_cls);
 
   /**
-   * Abort a transaction in the database
+   * This clears the editor hint, unless it does not match the
+   * given editor hint, in which case this is a NOP.
+   * If a replacement hint is given, it hint is not cleared, but
+   * set to the replacement.
    *
    * @param cls closure (internal context for the plugin)
-   * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
+   * @param zone private key of the zone
+   * @param editor_hint the new value for the advisory lock field
+   * @param editor_hint_replacement an optional value to use instead of a clear
+   * @param label name of the record in the zone
+   * @param iter function to call with the result
+   * @param iter_cls closure for @a iter
+   * @return #GNUNET_OK on success, #GNUNET_NO for no results, else #GNUNET_SYSERR
    */
   enum GNUNET_GenericReturnValue
-  (*transaction_abort) (void *cls);
+  (*clear_editor_hint)(void *cls,
+                  const char *editor_hint,
+                  const char *editor_hint_replacement,
+                  const struct GNUNET_CRYPTO_PrivateKey *zone,
+                       const char *label);
 
   /**
-   * Commit a transaction in the database
+   * Setup the database.
    *
    * @param cls closure (internal context for the plugin)
-   * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
+   * @return #GNUNET_OK on success, else fails with #GNUNET_SYSERR
    */
   enum GNUNET_GenericReturnValue
-  (*transaction_commit) (void *cls);
+  (*create_tables)(void *cls);
 
-  /**
-   * Replace a record in the datastore for which we are the authority.
-   * Removes any existing record in the same zone with the same name.
-   *
-   * @param cls closure (internal context for the plugin)
-   * @param zone private key of the zone
-   * @param label name of the record in the zone
-   * @param rd_count number of entries in @a rd array, 0 to delete all records
-   * @param rd array of records with data to store
-   * @return #GNUNET_OK on success, else #GNUNET_SYSERR
-   */
-  int
-  (*replace_records) (void *cls,
-                    const struct GNUNET_IDENTITY_PrivateKey *zone,
-                    const char *label,
-                    unsigned int rd_count,
-                    const struct GNUNET_GNSRECORD_Data *rd);
 
   /**
-   * Lookup records in the datastore for which we are the authority.
+   * Drop existing tables.
+   * DANGEROUS: All existing data in the dabase will be lost!
    *
    * @param cls closure (internal context for the plugin)
-   * @param zone private key of the zone
-   * @param label name of the record in the zone
-   * @param iter function to call with the result
-   * @param iter_cls closure for @a iter
-   * @return #GNUNET_OK on success, #GNUNET_NO for no results, else #GNUNET_SYSERR
+   * @return #GNUNET_OK on success, else fails with #GNUNET_SYSERR
    */
-  int
-  (*select_records) (void *cls,
-                     const struct GNUNET_IDENTITY_PrivateKey *zone,
-                     const char *label,
-                     GNUNET_NAMESTORE_RecordIterator iter,
-                     void *iter_cls);
-
+  enum GNUNET_GenericReturnValue
+  (*drop_tables)(void *cls);
 };
 
 
@@ -228,3 +234,5 @@ struct GNUNET_NAMESTORE_PluginFunctions
 #endif
 
 /** @} */  /* end of group */
+
+/** @} */ /* end of group addition */