2 This file is part of GNUnet
3 (C) 2012 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 2, 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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @brief IPC messages between GNS API and GNS service
23 * @author Martin Schanzenbach
28 #include "gnunet_gns_service.h"
31 * Name of the GADS TLD.
33 #define GNUNET_GNS_TLD "gads"
36 * Name of the zone key TLD.
38 #define GNUNET_GNS_TLD_ZKEY "zkey"
41 * TLD name used to indicate relative names.
43 #define GNUNET_GNS_TLD_PLUS "+"
46 GNUNET_NETWORK_STRUCT_BEGIN
49 * Message from client to GNS service to lookup records.
51 struct GNUNET_GNS_ClientLookupMessage
54 * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_LOOKUP
56 struct GNUNET_MessageHeader header;
59 * Unique identifier for this request (for key collisions).
61 uint32_t id GNUNET_PACKED;
64 * If use_default_zone is empty this zone is used for lookup
66 struct GNUNET_CRYPTO_ShortHashCode zone;
69 * Only check cached results
71 uint32_t only_cached GNUNET_PACKED;
74 * Should we look up in the default zone?
76 uint32_t use_default_zone GNUNET_PACKED;
79 * Is a shorten key attached?
81 uint32_t have_key GNUNET_PACKED;
84 * the type of record to look up
86 /* enum GNUNET_GNS_RecordType */ uint32_t type;
88 /* Followed by the key for shorten (optional) see have_key */
90 /* Followed by the name to look up */
95 * Message from GNS service to client: new results.
97 struct GNUNET_GNS_ClientLookupResultMessage
100 * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_RESULT
102 struct GNUNET_MessageHeader header;
105 * Unique identifier for this request (for key collisions).
107 uint32_t id GNUNET_PACKED;
110 * The number of records contained in response
114 /* followed by rd_count GNUNET_NAMESTORE_RecordData structs*/
120 * Message from client to GNS service to shorten names.
122 struct GNUNET_GNS_ClientShortenMessage
125 * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_SHORTEN
127 struct GNUNET_MessageHeader header;
130 * Unique identifier for this request
132 uint32_t id GNUNET_PACKED;
135 * If use_default_zone is empty this zone is used for lookup
137 struct GNUNET_CRYPTO_ShortHashCode zone;
142 struct GNUNET_CRYPTO_ShortHashCode shorten_zone;
147 struct GNUNET_CRYPTO_ShortHashCode private_zone;
150 * Should we look up in the default zone?
152 uint32_t use_default_zone GNUNET_PACKED;
154 /* Followed by the name to shorten up */
159 * Message from GNS service to client: shorten result.
161 struct GNUNET_GNS_ClientShortenResultMessage
164 * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_SHORTEN_RESULT
166 struct GNUNET_MessageHeader header;
169 * Unique identifier for this request (for key collisions).
171 uint32_t id GNUNET_PACKED;
173 /* followed by the shortened name or '\0' for no result*/
179 * Message from client to GNS service to lookup an authority of a name.
181 struct GNUNET_GNS_ClientGetAuthMessage
184 * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_GET_AUTH
186 struct GNUNET_MessageHeader header;
189 * Unique identifier for this request
191 uint32_t id GNUNET_PACKED;
193 /* Followed by the name to get authority for */
198 * Message from GNS service to client: authority result.
200 struct GNUNET_GNS_ClientGetAuthResultMessage
203 * Header of type GNUNET_MESSAGE_TYPE_GNS_CLIENT_GET_AUTH_RESULT
205 struct GNUNET_MessageHeader header;
208 * Unique identifier for this request (for key collisions).
210 uint32_t id GNUNET_PACKED;
212 /* followed by the authority part of the name or '\0' for no result*/
216 GNUNET_NETWORK_STRUCT_END