[GNUnet-SVN] r19966 - gnunet/src/include

[gnunet]

Author: grothoff
Date: 2012-02-23 14:33:26 +0100 (Thu, 23 Feb 2012)
New Revision: 19966

Modified:
   gnunet/src/include/gnunet_namestore_plugin.h
Log:
-revised plugin API

Modified: gnunet/src/include/gnunet_namestore_plugin.h
===================================================================
--- gnunet/src/include/gnunet_namestore_plugin.h        2012-02-23 13:16:27 UTC 
(rev 19965)
+++ gnunet/src/include/gnunet_namestore_plugin.h        2012-02-23 13:33:26 UTC 
(rev 19966)
@@ -22,9 +22,6 @@
  * @file include/gnunet_namestore_plugin.h
  * @brief plugin API for the namestore database backend
  * @author Christian Grothoff
- *
- * Other functions we might want:
- * - enumerate all known zones
  */
 #ifndef GNUNET_NAMESTORE_PLUGIN_H
 #define GNUNET_NAMESTORE_PLUGIN_H
@@ -46,65 +43,25 @@
  * Function called by for each matching record.
  *
  * @param cls closure
- * @param zone hash of the public key of the zone
- * @param loc location of the signature for this record
+ * @param zone_key public key of the zone
+ * @param expire when does the corresponding block in the DHT expire (until
+ *               when should we never do a DHT lookup for the same name again)?
  * @param name name that is being mapped (at most 255 characters long)
- * @param record_type type of the record (A, AAAA, PKEY, etc.)
- * @param expiration expiration time for the content
- * @param flags flags for the content
- * @param data_size number of bytes in data
- * @param data value, semantics depend on 'record_type' (see RFCs for DNS and 
- *             GNS specification for GNS extensions) 
+ * @param rd_count number of entries in 'rd' array
+ * @param rd array of records with data to store
+ * @param signature signature of the record block, NULL if signature is 
unavailable (i.e. 
+ *        because the user queried for a particular record type only)
  */
 typedef void (*GNUNET_NAMESTORE_RecordIterator) (void *cls,
-                                                const GNUNET_HashCode *zone,
-                                                const struct 
GNUNET_NAMESTORE_SignatureLocation *loc,
+                                                const struct 
GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key,
+                                                struct GNUNET_TIME_Absolute 
expire,
                                                 const char *name,
-                                                uint32_t record_type,
-                                                struct GNUNET_TIME_Absolute 
expiration,
-                                                enum 
GNUNET_NAMESTORE_RecordFlags flags,
-                                                size_t data_size,
-                                                const void *data);
+                                                unsigned int rd_count,
+                                                const struct 
GNUNET_NAMESTORE_RecordData *rd,
+                                                const struct 
GNUNET_CRYPTO_RsaSignature *signature);
 
 
 /**
- * Function called with the matching node.
- *
- * @param cls closure
- * @param zone hash of public key of the zone
- * @param loc location in the B-tree
- * @param ploc parent's location in the B-tree (must have depth = loc.depth - 
1), NULL for root
- * @param num_entries number of entries at this node in the B-tree
- * @param entries the 'num_entries' entries to store (hashes over the
- *                records)
- */
-typedef void (*GNUNET_NAMESTORE_NodeCallback) (void *cls,
-                                              const GNUNET_HashCode *zone,
-                                              const struct 
GNUNET_NAMESTORE_SignatureLocation *loc,
-                                              const struct 
GNUNET_NAMESTORE_SignatureLocation *ploc,
-                                              unsigned int num_entries,
-                                              const GNUNET_HashCode *entries);
-
-
-/**
- * Function called with the matching signature.
- *
- * @param cls closure
- * @param zone public key of the zone
- * @param loc location of the root in the B-tree (depth, revision)
- * @param top_sig signature signing the zone
- * @param zone_time time the signature was created
- * @param root_hash top level hash that is being signed
- */
-typedef void (*GNUNET_NAMESTORE_SignatureCallback) (void *cls,
-                                                   const struct 
GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *zone_key,
-                                                   const struct 
GNUNET_NAMESTORE_SignatureLocation *loc,
-                                                   const struct 
GNUNET_CRYPTO_RsaSignature *top_sig,
-                                                   struct GNUNET_TIME_Absolute 
zone_time,
-                                                   const GNUNET_HashCode 
*root_hash);
-
-
-/**
  * @brief struct returned by the initialization function of the plugin
  */
 struct GNUNET_NAMESTORE_PluginFunctions
@@ -116,126 +73,65 @@
   void *cls;
 
   /**
-   * Store a record in the datastore.
+   * Store a record in the datastore.  Removes any existing record in the
+   * same zone with the same name.
    *
    * @param cls closure (internal context for the plugin)
-   * @param zone hash of the public key of the zone
+   * @param zone_key public key of the zone
+   * @param expire when does the corresponding block in the DHT expire (until
+   *               when should we never do a DHT lookup for the same name 
again)?
    * @param name name that is being mapped (at most 255 characters long)
-   * @param record_type type of the record (A, AAAA, PKEY, etc.)
-   * @param loc location of the signature for the record
-   * @param expiration expiration time for the content
-   * @param flags flags for the content
-   * @param data_size number of bytes in data
-   * @param data value, semantics depend on 'record_type' (see RFCs for DNS 
and 
-   *             GNS specification for GNS extensions)
+   * @param rd_count number of entries in 'rd' array
+   * @param rd array of records with data to store
+   * @param signature signature of the record block, NULL if signature is 
unavailable (i.e. 
+   *        because the user queried for a particular record type only)
    * @return GNUNET_OK on success
    */
-  int (*put_record) (void *cls, 
-                    const GNUNET_HashCode *zone,
-                    const char *name,
-                    uint32_t record_type,
-                    const struct GNUNET_NAMESTORE_SignatureLocation *loc,
-                    struct GNUNET_TIME_Absolute expiration,
-                    enum GNUNET_NAMESTORE_RecordFlags flags,
-                    size_t data_size,
-                    const void *data);
+  int (*put_records) (void *cls, 
+                     const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded 
*zone_key,
+                     struct GNUNET_TIME_Absolute expire,
+                     const char *name,
+                     unsigned int rd_count,
+                     const struct GNUNET_NAMESTORE_RecordData *rd,
+                     const struct GNUNET_CRYPTO_RsaSignature *signature);
 
 
   /**
-   * Store a Merkle tree node in the datastore.
+   * Removes any existing record in the given zone with the same name.
    *
    * @param cls closure (internal context for the plugin)
-   * @param zone hash of public key of the zone
-   * @param loc location in the B-tree
-   * @param ploc parent's location in the B-tree (must have depth = loc.depth 
+ 1) and the
-   *             revision must also match loc's revision; NULL for root
-   * @param num_entries number of entries at this node in the B-tree
-   * @param entries the 'num_entries' entries to store (hashes over the
-   *                records)
+   * @param zone hash of the public key of the zone
+   * @param name name that is being mapped (at most 255 characters long)
    * @return GNUNET_OK on success
    */
-  int (*put_node) (void *cls, 
-                  const GNUNET_HashCode *zone,
-                  const struct GNUNET_NAMESTORE_SignatureLocation *loc,
-                  const struct GNUNET_NAMESTORE_SignatureLocation *ploc,
-                  unsigned int num_entries,
-                  const GNUNET_HashCode *entries);
-  
+  int (*remove_records) (void *cls, 
+                        const GNUNET_HashCode *zone,
+                        const char *name);
 
+
   /**
-   * Store a zone signature in the datastore.  If a signature for the zone 
with a
-   * lower depth exists, the old signature is removed.  If a signature for an
-   * older revision of the zone exists, this will delete all records, nodes
-   * and signatures for the older revision of the zone.
-   *
-   * @param cls closure (internal context for the plugin)
-   * @param zone_key public key of the zone
-   * @param loc location in the B-tree (top of the tree, offset 0, depth at 
'maximum')
-   * @param top_sig signature at the top
-   * @param root_hash top level hash that is signed
-   * @param zone_time time the zone was signed
-   * @return GNUNET_OK on success
-   */
-  int (*put_signature) (void *cls, 
-                       const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded 
*zone_key,
-                       const struct GNUNET_NAMESTORE_SignatureLocation *loc,
-                       const struct GNUNET_CRYPTO_RsaSignature *top_sig,
-                       const GNUNET_HashCode *root_hash,
-                       struct GNUNET_TIME_Absolute zone_time);
-  
-  
-  /**
    * Iterate over the results for a particular key and zone in the
-   * datastore.  Will only query the latest revision known for the
-   * zone (as adding a new zone revision will cause the plugin to
-   * delete all records from previous revisions).
+   * datastore.  Will return at most one result to the iterator.
    *
    * @param cls closure (internal context for the plugin)
-   * @param zone hash of public key of the zone
+   * @param zone hash of public key of the zone, NULL to iterate over all zones
    * @param name_hash hash of name, NULL to iterate over all records of the 
zone
-   * @param iter maybe NULL (to just count)
+   * @param offset offset in the list of all matching records
+   * @param iter function to call with the result
    * @param iter_cls closure for iter
-   * @return the number of results found
+   * @return GNUNET_OK on success, GNUNET_NO if there were no results, 
GNUNET_SYSERR on error
    */
-  unsigned int (*iterate_records) (void *cls, 
-                                  const GNUNET_HashCode *zone,
-                                  const GNUNET_HashCode *name_hash,
-                                  GNUNET_NAMESTORE_RecordIterator iter, void 
*iter_cls);
+  int (*iterate_records) (void *cls, 
+                         const GNUNET_HashCode *zone,
+                         const GNUNET_HashCode *name_hash,
+                         uint64_t offset,
+                         GNUNET_NAMESTORE_RecordIterator iter, void *iter_cls);
 
- 
-  /**
-   * Get a particular node from the signature tree.
-   *
-   * @param cls closure (internal context for the plugin)
-   * @param zone hash of public key of the zone
-   * @param loc location of the node in the signature tree
-   * @param cb function to call with the result
-   * @param cb_cls closure for cont
-   */
-  int (*get_node) (void *cls, 
-                   const GNUNET_HashCode *zone,
-                   const struct GNUNET_NAMESTORE_SignatureLocation *loc,
-                   GNUNET_NAMESTORE_NodeCallback cb, void *cb_cls);
 
-
   /**
-   * Get the current signature for a zone.
+   * Delete an entire zone (all records).  Not used in normal operation.
    *
    * @param cls closure (internal context for the plugin)
-   * @param zone hash of public key of the zone
-   * @param cb function to call with the result
-   * @param cb_cls closure for cont
-   */
-  int (*get_signature) (void *cls, 
-                        const GNUNET_HashCode *zone,
-                        GNUNET_NAMESTORE_SignatureCallback cb, void *cb_cls);
-
-
-  /**
-   * Delete an entire zone (all revisions, all records, all nodes,
-   * all signatures).  Not used in normal operation.
-   *
-   * @param cls closure (internal context for the plugin)
    * @param zone zone to delete
    */
   void (*delete_zone) (void *cls,