porting xdht to new service API, major code de-duplication effort

[oweals/gnunet.git] / src / core / gnunet-service-core_typemap.h

diff --git a/src/core/gnunet-service-core_typemap.h b/src/core/gnunet-service-core_typemap.h
index ab106a1613008ea1ba5e7b7c55d96e76f7f3d75d..66596748c1bcebbb9f1c02f05460a8bdd361cec1 100644 (file)
--- a/src/core/gnunet-service-core_typemap.h
+++ b/src/core/gnunet-service-core_typemap.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2011 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2011 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.
 */
 
 /**
@@ -37,16 +37,24 @@ struct GSC_TypeMap;
 
 /**
  * Add a set of types to our type map.
+ *
+ * @param types array of message types supported by this peer
+ * @param tlen number of entries in @a types
  */
 void
-GSC_TYPEMAP_add (const uint16_t * types, unsigned int tlen);
+GSC_TYPEMAP_add (const uint16_t *types,
+                 unsigned int tlen);
 
 
 /**
- * Remove a set of types from our type map.
+ * Remove a set of message types from our type map.
+ *
+ * @param types array of message types no longer supported by this peer
+ * @param tlen number of entries in @a types
  */
 void
-GSC_TYPEMAP_remove (const uint16_t * types, unsigned int tlen);
+GSC_TYPEMAP_remove (const uint16_t *types,
+                    unsigned int tlen);
 
 
 /**
@@ -59,7 +67,30 @@ GSC_TYPEMAP_compute_type_map_message (void);
 
 
 /**
- * Extract a type map from a TYPE_MAP message.
+ * Check if the given hash matches our current type map.
+ *
+ * @param hc hash code to check if it matches our type map
+ * @return #GNUNET_YES if the hash matches, #GNUNET_NO if not
+ */
+int
+GSC_TYPEMAP_check_hash (const struct GNUNET_HashCode *hc);
+
+
+/**
+ * Hash the contents of a type map.
+ *
+ * @param tm map to hash
+ * @param hc where to store the hash code
+ */
+void
+GSC_TYPEMAP_hash (const struct GSC_TypeMap *tm,
+                  struct GNUNET_HashCode *hc);
+
+
+/**
+ * Extract a type map from a
+ * #GNUNET_MESSAGE_TYPE_CORE_COMRESSED_TYPE_MAP or
+ * #GNUNET_MESSAGE_TYPE_CORE_BINARY_TYPE_MAP message.
  *
  * @param msg a type map message
  * @return NULL on error
@@ -72,32 +103,35 @@ GSC_TYPEMAP_get_from_message (const struct GNUNET_MessageHeader *msg);
  * Test if any of the types from the types array is in the
  * given type map.
  *
- * @param map map to test
+ * @param tmap map to test
  * @param types array of types
- * @param tcnt number of entries in types
- * @return GNUNET_YES if a type is in the map, GNUNET_NO if not
+ * @param tcnt number of entries in @a types
+ * @return #GNUNET_YES if a type is in the map, #GNUNET_NO if not
  */
 int
-GSC_TYPEMAP_test_match (const struct GSC_TypeMap *tmap, const uint16_t * types,
+GSC_TYPEMAP_test_match (const struct GSC_TypeMap *tmap,
+                        const uint16_t *types,
                         unsigned int tcnt);
 
 
 /**
  * Add additional types to a given typemap.
  *
- * @param map map to extend (not changed)
+ * @param tmap map to extend (not changed)
  * @param types array of types to add
- * @param tcnt number of entries in types
+ * @param tcnt number of entries in @a types
  * @return updated type map (fresh copy)
  */
 struct GSC_TypeMap *
-GSC_TYPEMAP_extend (const struct GSC_TypeMap *tmap, const uint16_t * types,
+GSC_TYPEMAP_extend (const struct GSC_TypeMap *tmap,
+                    const uint16_t *types,
                     unsigned int tcnt);
 
+
 /**
  * Create an empty type map.
  *
- * @param map a type map
+ * @return an empty type map
  */
 struct GSC_TypeMap *
 GSC_TYPEMAP_create (void);
@@ -106,7 +140,7 @@ GSC_TYPEMAP_create (void);
 /**
  * Free the given type map.
  *
- * @param map a type map
+ * @param tmap a type map
  */
 void
 GSC_TYPEMAP_destroy (struct GSC_TypeMap *tmap);