2 This file is part of GNUnet
3 Copyright (C) 2012, 2013 Christian Grothoff (and other contributing authors)
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.
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.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file include/gnunet_gnsrecord_plugin.h
23 * @brief plugin API for GNS record types
24 * @author Christian Grothoff
25 * @defgroup gnsrecordplugin API to be implemented by applications defining new GNS record types
27 #ifndef GNUNET_GNSRECORD_PLUGIN_H
28 #define GNUNET_GNSRECORD_PLUGIN_H
33 #if 0 /* keep Emacsens' auto-indent happy */
40 * Function called to convert the binary value @a data of a record of
41 * type @a type to a human-readable string.
44 * @param type type of the record
45 * @param data value in binary encoding
46 * @param data_size number of bytes in @a data
47 * @return NULL on error, otherwise human-readable representation of the value
49 typedef char * (*GNUNET_GNSRECORD_ValueToStringFunction) (void *cls,
56 * Function called to convert human-readable version of the value @a s
57 * of a record of type @a type to the respective binary
61 * @param type type of the record
62 * @param s human-readable string
63 * @param data set to value in binary encoding (will be allocated)
64 * @param data_size set to number of bytes in @a data
65 * @return #GNUNET_OK on success
67 typedef int (*GNUNET_GNSRECORD_StringToValueFunction) (void *cls,
75 * Function called to convert a type name (i.e. "AAAA") to the
76 * corresponding number.
79 * @param dns_typename name to convert
80 * @return corresponding number, UINT32_MAX on error
82 typedef uint32_t (*GNUNET_GNSRECORD_TypenameToNumberFunction) (void *cls,
83 const char *dns_typename);
87 * Function called to convert a type number (i.e. 1) to the
88 * corresponding type string (i.e. "A")
91 * @param type number of a type to convert
92 * @return corresponding typestring, NULL on error
94 typedef const char * (*GNUNET_GNSRECORD_NumberToTypenameFunction) (void *cls,
99 * Each plugin is required to return a pointer to a struct of this
100 * type as the return value from its entry point.
102 struct GNUNET_GNSRECORD_PluginFunctions
106 * Closure for all of the callbacks.
111 * Conversion to string.
113 GNUNET_GNSRECORD_ValueToStringFunction value_to_string;
116 * Conversion to binary.
118 GNUNET_GNSRECORD_StringToValueFunction string_to_value;
121 * Typename to number.
123 GNUNET_GNSRECORD_TypenameToNumberFunction typename_to_number;
126 * Number to typename.
128 GNUNET_GNSRECORD_NumberToTypenameFunction number_to_typename;
133 /** @} */ /* end of group gnsrecordplugin */
135 #if 0 /* keep Emacsens' auto-indent happy */