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,
  43                  unsigned int tlen);
  44
  45
  46 /**
  47  * Remove a set of types from our type map.
  48  */
  49 void
  50 GSC_TYPEMAP_remove (const uint16_t *types,
  51                     unsigned int tlen);
  52
  53
  54 /**
  55  * Compute a type map message for this peer.
  56  *
  57  * @return this peers current type map message.
  58  */
  59 struct GNUNET_MessageHeader *
  60 GSC_TYPEMAP_compute_type_map_message (void);
  61
  62
  63 /**
  64  * Extract a type map from a TYPE_MAP message.
  65  *
  66  * @param msg a type map message
  67  * @return NULL on error
  68  */
  69 struct GSC_TypeMap *
  70 GSC_TYPEMAP_get_from_message (const struct GNUNET_MessageHeader *msg);
  71
  72
  73 /**
  74  * Test if any of the types from the types array is in the
  75  * given type map.
  76  *
  77  * @param map map to test
  78  * @param types array of types
  79  * @param tcnt number of entries in types
  80  * @return GNUNET_YES if a type is in the map, GNUNET_NO if not
  81  */
  82 int
  83 GSC_TYPEMAP_test_match (const struct GSC_TypeMap *tmap,
  84                         const uint16_t *types,
  85                         unsigned int tcnt);
  86
  87
  88 /**
  89  * Add additional types to a given typemap.
  90  *
  91  * @param map map to extend (not changed)
  92  * @param types array of types to add
  93  * @param tcnt number of entries in types
  94  * @return updated type map (fresh copy)
  95  */
  96 struct GSC_TypeMap *
  97 GSC_TYPEMAP_extend (const struct GSC_TypeMap *tmap,
  98                     const uint16_t *types,
  99                     unsigned int tcnt);
 100
 101
 102 /**
 103  * Free the given type map.
 104  *
 105  * @param map a type map
 106  */
 107 void
 108 GSC_TYPEMAP_destroy (struct GSC_TypeMap *tmap);
 109
 110
 111 /**
 112  * Initialize typemap subsystem.
 113  */
 114 void
 115 GSC_TYPEMAP_init (void);
 116
 117
 118 /**
 119  * Shutdown typemap subsystem.
 120  */
 121 void
 122 GSC_TYPEMAP_done (void);
 123
 124 #endif
 125 /* end of gnunet-service-core_typemap.h */