2 This file is part of GNUnet
3 Copyright (C) 2012, 2013 GNUnet e.V.
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.
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.
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/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @author Christian Grothoff
25 * Plugin API for GNS record types
27 * @defgroup gnsrecord-plugin GNS Record plugin API
28 * To be implemented by applications defining new record types.
30 * @see [Documentation](https://gnunet.org/gns-plugins)
34 #ifndef GNUNET_GNSRECORD_PLUGIN_H
35 #define GNUNET_GNSRECORD_PLUGIN_H
40 #if 0 /* keep Emacsens' auto-indent happy */
47 * Function called to convert the binary value @a data of a record of
48 * type @a type to a human-readable string.
51 * @param type type of the record
52 * @param data value in binary encoding
53 * @param data_size number of bytes in @a data
54 * @return NULL on error, otherwise human-readable representation of the value
57 (*GNUNET_GNSRECORD_ValueToStringFunction) (void *cls,
64 * Function called to convert human-readable version of the value @a s
65 * of a record of type @a type to the respective binary
69 * @param type type of the record
70 * @param s human-readable string
71 * @param data set to value in binary encoding (will be allocated)
72 * @param data_size set to number of bytes in @a data
73 * @return #GNUNET_OK on success
76 (*GNUNET_GNSRECORD_StringToValueFunction) (void *cls,
84 * Function called to convert a type name (i.e. "AAAA") to the
85 * corresponding number.
88 * @param dns_typename name to convert
89 * @return corresponding number, UINT32_MAX on error
92 (*GNUNET_GNSRECORD_TypenameToNumberFunction) (void *cls,
93 const char *dns_typename);
97 * Function called to convert a type number (i.e. 1) to the
98 * corresponding type string (i.e. "A")
101 * @param type number of a type to convert
102 * @return corresponding typestring, NULL on error
105 (*GNUNET_GNSRECORD_NumberToTypenameFunction) (void *cls,
110 * Each plugin is required to return a pointer to a struct of this
111 * type as the return value from its entry point.
113 struct GNUNET_GNSRECORD_PluginFunctions
117 * Closure for all of the callbacks.
122 * Conversion to string.
124 GNUNET_GNSRECORD_ValueToStringFunction value_to_string;
127 * Conversion to binary.
129 GNUNET_GNSRECORD_StringToValueFunction string_to_value;
132 * Typename to number.
134 GNUNET_GNSRECORD_TypenameToNumberFunction typename_to_number;
137 * Number to typename.
139 GNUNET_GNSRECORD_NumberToTypenameFunction number_to_typename;
143 /** @} */ /* end of group */
145 #if 0 /* keep Emacsens' auto-indent happy */