X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Fcore%2Fgnunet-service-core_typemap.h;h=66596748c1bcebbb9f1c02f05460a8bdd361cec1;hb=43ee295fd2b0d38dcbfa3a7bb6df461cad15cf4f;hp=4bbd6eb29b83e7e00e67a09f24a3c1a70e63c994;hpb=0babf19b445e521fdb78f0e1a67d5548e28405b9;p=oweals%2Fgnunet.git diff --git a/src/core/gnunet-service-core_typemap.h b/src/core/gnunet-service-core_typemap.h index 4bbd6eb29..66596748c 100644 --- 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. */ /** @@ -28,39 +28,136 @@ #include "gnunet_util_lib.h" #include "gnunet_transport_service.h" -#include "gnunet_service_core.h" + +/** + * Map specifying which message types a peer supports. + */ +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); + 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); + unsigned int tlen); + + +/** + * Compute a type map message for this peer. + * + * @return this peers current type map message. + */ +struct GNUNET_MessageHeader * +GSC_TYPEMAP_compute_type_map_message (void); + + +/** + * 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 + */ +struct GSC_TypeMap * +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 (struct GSC_TypeMap *tmap, - const uint16_t *types, - unsigned int tcnt); +GSC_TYPEMAP_test_match (const struct GSC_TypeMap *tmap, + const uint16_t *types, + unsigned int tcnt); + + +/** + * Add additional types to a given typemap. + * + * @param tmap map to extend (not changed) + * @param types array of types to add + * @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, + unsigned int tcnt); + + +/** + * Create an empty type map. + * + * @return an empty type map + */ +struct GSC_TypeMap * +GSC_TYPEMAP_create (void); + + +/** + * Free the given type map. + * + * @param tmap a type map + */ +void +GSC_TYPEMAP_destroy (struct GSC_TypeMap *tmap); +/** + * Initialize typemap subsystem. + */ +void +GSC_TYPEMAP_init (void); + + +/** + * Shutdown typemap subsystem. + */ +void +GSC_TYPEMAP_done (void); + #endif /* end of gnunet-service-core_typemap.h */