1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
/*
This file is part of GNUnet
Copyright (C) 2012, 2013 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 3, 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
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
/**
* @author Christian Grothoff
*
* @file
* Plugin API for GNS record types
*
* @defgroup gnsrecord-plugin GNS Record plugin API
* To be implemented by applications defining new record types.
*
* @see [Documentation](https://gnunet.org/gns-plugins)
*
* @{
*/
#ifndef GNUNET_GNSRECORD_PLUGIN_H
#define GNUNET_GNSRECORD_PLUGIN_H
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
/**
* Function called to convert the binary value @a data of a record of
* type @a type to a human-readable string.
*
* @param cls closure
* @param type type of the record
* @param data value in binary encoding
* @param data_size number of bytes in @a data
* @return NULL on error, otherwise human-readable representation of the value
*/
typedef char * (*GNUNET_GNSRECORD_ValueToStringFunction) (void *cls,
uint32_t type,
const void *data,
size_t data_size);
/**
* Function called to convert human-readable version of the value @a s
* of a record of type @a type to the respective binary
* representation.
*
* @param cls closure
* @param type type of the record
* @param s human-readable string
* @param data set to value in binary encoding (will be allocated)
* @param data_size set to number of bytes in @a data
* @return #GNUNET_OK on success
*/
typedef int (*GNUNET_GNSRECORD_StringToValueFunction) (void *cls,
uint32_t type,
const char *s,
void **data,
size_t *data_size);
/**
* Function called to convert a type name (i.e. "AAAA") to the
* corresponding number.
*
* @param cls closure
* @param dns_typename name to convert
* @return corresponding number, UINT32_MAX on error
*/
typedef uint32_t (*GNUNET_GNSRECORD_TypenameToNumberFunction) (void *cls,
const char *dns_typename);
/**
* Function called to convert a type number (i.e. 1) to the
* corresponding type string (i.e. "A")
*
* @param cls closure
* @param type number of a type to convert
* @return corresponding typestring, NULL on error
*/
typedef const char * (*GNUNET_GNSRECORD_NumberToTypenameFunction) (void *cls,
uint32_t type);
/**
* Each plugin is required to return a pointer to a struct of this
* type as the return value from its entry point.
*/
struct GNUNET_GNSRECORD_PluginFunctions
{
/**
* Closure for all of the callbacks.
*/
void *cls;
/**
* Conversion to string.
*/
GNUNET_GNSRECORD_ValueToStringFunction value_to_string;
/**
* Conversion to binary.
*/
GNUNET_GNSRECORD_StringToValueFunction string_to_value;
/**
* Typename to number.
*/
GNUNET_GNSRECORD_TypenameToNumberFunction typename_to_number;
/**
* Number to typename.
*/
GNUNET_GNSRECORD_NumberToTypenameFunction number_to_typename;
};
/** @} */ /* end of group */
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
#endif
|
