src/core/gnunet-service-core_typemap.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file core/gnunet-service-core_typemap.h
  23  * @brief management of map that specifies which message types this peer supports
  24  * @author Christian Grothoff
  25  */
  26 #ifndef GNUNET_SERVICE_CORE_TYPEMAP_H
  27 #define GNUNET_SERVICE_CORE_TYPEMAP_H
  28
  29 #include "gnunet_util_lib.h"
  30 #include "gnunet_transport_service.h"
  31
  32 /**
  33  * Map specifying which message types a peer supports.
  34  */
  35 struct GSC_TypeMap;
  36
  37
  38 /**
  39  * Add a set of types to our type map.
  40  */
  41 void
  42 GSC_TYPEMAP_add (const uint16_t * types, unsigned int tlen);
  43
  44
  45 /**
  46  * Remove a set of types from our type map.
  47  */
  48 void
  49 GSC_TYPEMAP_remove (const uint16_t * types, unsigned int tlen);
  50
  51
  52 /**
  53  * Compute a type map message for this peer.
  54  *
  55  * @return this peers current type map message.
  56  */
  57 struct GNUNET_MessageHeader *
  58 GSC_TYPEMAP_compute_type_map_message (void);
  59
  60
  61 /**
  62  * Extract a type map from a TYPE_MAP message.
  63  *
  64  * @param msg a type map message
  65  * @return NULL on error
  66  */
  67 struct GSC_TypeMap *
  68 GSC_TYPEMAP_get_from_message (const struct GNUNET_MessageHeader *msg);
  69
  70
  71 /**
  72  * Test if any of the types from the types array is in the
  73  * given type map.
  74  *
  75  * @param tmap map to test
  76  * @param types array of types
  77  * @param tcnt number of entries in types
  78  * @return GNUNET_YES if a type is in the map, GNUNET_NO if not
  79  */
  80 int
  81 GSC_TYPEMAP_test_match (const struct GSC_TypeMap *tmap, const uint16_t * types,
  82                         unsigned int tcnt);
  83
  84
  85 /**
  86  * Add additional types to a given typemap.
  87  *
  88  * @param tmap map to extend (not changed)
  89  * @param types array of types to add
  90  * @param tcnt number of entries in types
  91  * @return updated type map (fresh copy)
  92  */
  93 struct GSC_TypeMap *
  94 GSC_TYPEMAP_extend (const struct GSC_TypeMap *tmap, const uint16_t * types,
  95                     unsigned int tcnt);
  96
  97 /**
  98  * Create an empty type map.
  99  *
 100  * @return an empty type map
 101  */
 102 struct GSC_TypeMap *
 103 GSC_TYPEMAP_create (void);
 104
 105
 106 /**
 107  * Free the given type map.
 108  *
 109  * @param tmap a type map
 110  */
 111 void
 112 GSC_TYPEMAP_destroy (struct GSC_TypeMap *tmap);
 113
 114
 115 /**
 116  * Initialize typemap subsystem.
 117  */
 118 void
 119 GSC_TYPEMAP_init (void);
 120
 121
 122 /**
 123  * Shutdown typemap subsystem.
 124  */
 125 void
 126 GSC_TYPEMAP_done (void);
 127
 128 #endif
 129 /* end of gnunet-service-core_typemap.h */