src/include/gnunet_reclaim_attribute_plugin.h

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2012, 2013 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19  */
  20
  21 /**
  22  * @author Martin Schanzenbach
  23  *
  24  * @file
  25  * Plugin API for reclaim attribute types
  26  *
  27  * @defgroup reclaim-attribute-plugin  reclaim plugin API for attributes/claims
  28  * @{
  29  */
  30 #ifndef GNUNET_RECLAIM_ATTRIBUTE_PLUGIN_H
  31 #define GNUNET_RECLAIM_ATTRIBUTE_PLUGIN_H
  32
  33 #include "gnunet_util_lib.h"
  34 #include "gnunet_reclaim_attribute_lib.h"
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #if 0 /* keep Emacsens' auto-indent happy */
  39 }
  40 #endif
  41 #endif
  42
  43
  44 /**
  45  * Function called to convert the binary value @a data of an attribute of
  46  * type @a type to a human-readable string.
  47  *
  48  * @param cls closure
  49  * @param type type of the attribute
  50  * @param data value in binary encoding
  51  * @param data_size number of bytes in @a data
  52  * @return NULL on error, otherwise human-readable representation of the value
  53  */
  54 typedef char *(*GNUNET_RECLAIM_ATTRIBUTE_ValueToStringFunction) (
  55   void *cls,
  56   uint32_t type,
  57   const void *data,
  58   size_t data_size);
  59
  60
  61 /**
  62  * Function called to convert human-readable version of the value @a s
  63  * of an attribute of type @a type to the respective binary
  64  * representation.
  65  *
  66  * @param cls closure
  67  * @param type type of the attribute
  68  * @param s human-readable string
  69  * @param data set to value in binary encoding (will be allocated)
  70  * @param data_size set to number of bytes in @a data
  71  * @return #GNUNET_OK on success
  72  */
  73 typedef int (*GNUNET_RECLAIM_ATTRIBUTE_StringToValueFunction) (
  74   void *cls,
  75   uint32_t type,
  76   const char *s,
  77   void **data,
  78   size_t *data_size);
  79
  80
  81 /**
  82  * Function called to convert a type name to the
  83  * corresponding number.
  84  *
  85  * @param cls closure
  86  * @param typename name to convert
  87  * @return corresponding number, UINT32_MAX on error
  88  */
  89 typedef uint32_t (*GNUNET_RECLAIM_ATTRIBUTE_TypenameToNumberFunction) (
  90   void *cls,
  91   const char *typename);
  92
  93
  94 /**
  95  * Function called to convert a type number (i.e. 1) to the
  96  * corresponding type string
  97  *
  98  * @param cls closure
  99  * @param type number of a type to convert
 100  * @return corresponding typestring, NULL on error
 101  */
 102 typedef const char *(*GNUNET_RECLAIM_ATTRIBUTE_NumberToTypenameFunction) (
 103   void *cls,
 104   uint32_t type);
 105
 106
 107 /**
 108  * Each plugin is required to return a pointer to a struct of this
 109  * type as the return value from its entry point.
 110  */
 111 struct GNUNET_RECLAIM_ATTRIBUTE_PluginFunctions
 112 {
 113   /**
 114    * Closure for all of the callbacks.
 115    */
 116   void *cls;
 117
 118   /**
 119    * Conversion to string.
 120    */
 121   GNUNET_RECLAIM_ATTRIBUTE_ValueToStringFunction value_to_string;
 122
 123   /**
 124    * Conversion to binary.
 125    */
 126   GNUNET_RECLAIM_ATTRIBUTE_StringToValueFunction string_to_value;
 127
 128   /**
 129    * Typename to number.
 130    */
 131   GNUNET_RECLAIM_ATTRIBUTE_TypenameToNumberFunction typename_to_number;
 132
 133   /**
 134    * Number to typename.
 135    */
 136   GNUNET_RECLAIM_ATTRIBUTE_NumberToTypenameFunction number_to_typename;
 137 };
 138
 139
 140 #if 0 /* keep Emacsens' auto-indent happy */
 141 {
 142 #endif
 143 #ifdef __cplusplus
 144 }
 145 #endif
 146
 147 #endif
 148
 149 /** @} */ /* end of group */