123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163 |
- /*
- This file is part of GNUnet.
- Copyright (C) 2011 GNUnet e.V.
- GNUnet is free software: you can redistribute it and/or modify it
- under the terms of the GNU Affero General Public License as published
- by the Free Software Foundation, either version 3 of the License,
- or (at your option) any later version.
- GNUnet is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Affero General Public License for more details.
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <http://www.gnu.org/licenses/>.
- SPDX-License-Identifier: AGPL3.0-or-later
- */
- /**
- * @file core/gnunet-service-core_typemap.h
- * @brief management of map that specifies which message types this peer supports
- * @author Christian Grothoff
- */
- #ifndef GNUNET_SERVICE_CORE_TYPEMAP_H
- #define GNUNET_SERVICE_CORE_TYPEMAP_H
- #include "gnunet_util_lib.h"
- #include "gnunet_transport_service.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);
- /**
- * 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);
- /**
- * 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 tmap map to test
- * @param types array of types
- * @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,
- 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 */
|