/usr/include/gnunet/gnunet_gns_service.h is in gnunet-dev 0.9.3-7build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 | /*
This file is part of GNUnet
(C) 2012 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., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
/**
* @file include/gnunet_gns_service.h
* @brief API to the GNS service
* @author Martin Schanzenbach
*
* TODO:
* - decide what goes into storage API and what into GNS-service API
* - decide where to pass/expose/check keys / signatures
* - are GNS private keys per peer or per user?
*/
#ifndef GNUNET_GNS_SERVICE_H
#define GNUNET_GNS_SERVICE_H
#include "gnunet_util_lib.h"
#include "gnunet_dnsparser_lib.h"
#include "gnunet_namestore_service.h"
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
/**
* Connection to the GNS service.
*/
struct GNUNET_GNS_Handle;
/**
* Handle to control a get operation.
*/
struct GNUNET_GNS_LookupHandle;
/**
* Handle to control a shorten operation
*/
/**
* Record types
* Based on GNUNET_DNSPARSER_TYPEs (standard DNS)
*/
enum GNUNET_GNS_RecordType
{
/* Standard DNS */
GNUNET_GNS_RECORD_TYPE_A = GNUNET_DNSPARSER_TYPE_A,
GNUNET_GNS_RECORD_TYPE_NS = GNUNET_DNSPARSER_TYPE_NS,
GNUNET_GNS_RECORD_TYPE_CNAME = GNUNET_DNSPARSER_TYPE_CNAME,
GNUNET_GNS_RECORD_TYPE_SOA = GNUNET_DNSPARSER_TYPE_SOA,
GNUNET_GNS_RECORD_TYPE_PTR = GNUNET_DNSPARSER_TYPE_PTR,
GNUNET_GNS_RECORD_MX = GNUNET_DNSPARSER_TYPE_MX,
GNUNET_GNS_RECORD_TXT = GNUNET_DNSPARSER_TYPE_TXT,
GNUNET_GNS_RECORD_AAAA = GNUNET_DNSPARSER_TYPE_AAAA,
/* GNS specific */
GNUNET_GNS_RECORD_PKEY = GNUNET_NAMESTORE_TYPE_PKEY,
GNUNET_GNS_RECORD_PSEU = GNUNET_NAMESTORE_TYPE_PSEU,
GNUNET_GNS_RECORD_ANY = GNUNET_NAMESTORE_TYPE_ANY
};
/**
* Initialize the connection with the GNS service.
*
* @param cfg configuration to use
*
* @return handle to the GNS service, or NULL on error
*/
struct GNUNET_GNS_Handle *
GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
/**
* Shutdown connection with the GNS service.
*
* @param handle connection to shut down
*/
void
GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
/* *************** Standard API: lookup ******************* */
/**
* Iterator called on obtained result for a GNS
* lookup
*
* @param cls closure
* @param name "name" of the original lookup
* @param rd_count number of records
* @param rd the records in reply
*/
typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls,
uint32_t rd_count,
const struct GNUNET_NAMESTORE_RecordData *rd);
/**
* Perform an asynchronous lookup operation on the GNS
* in the default zone.
*
* @param handle handle to the GNS service
* @param name the name to look up
* @param type the GNUNET_GNS_RecordType to look for
* @param proc function to call on result
* @param proc_cls closure for processor
*
* @return handle to the queued request
*/
struct GNUNET_GNS_QueueEntry *
GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
const char * name,
enum GNUNET_GNS_RecordType type,
GNUNET_GNS_LookupResultProcessor proc,
void *proc_cls);
/**
* Perform an asynchronous lookup operation on the GNS
* in the zone specified by 'zone'.
*
* @param handle handle to the GNS service
* @param name the name to look up
* @param zone the zone to start the resolution in
* @param type the GNUNET_GNS_RecordType to look for
* @param proc function to call on result
* @param proc_cls closure for processor
*
* @return handle to the queued request
*/
struct GNUNET_GNS_QueueEntry *
GNUNET_GNS_lookup_zone (struct GNUNET_GNS_Handle *handle,
const char * name,
struct GNUNET_CRYPTO_ShortHashCode *zone,
enum GNUNET_GNS_RecordType type,
GNUNET_GNS_LookupResultProcessor proc,
void *proc_cls);
/* *************** Standard API: shorten ******************* */
/**
* Processor called on for a name shortening result
* called only once
*
* @param cls closure
* @param short_name the shortened name or NULL if no result
*/
typedef void (*GNUNET_GNS_ShortenResultProcessor) (void *cls,
const char* short_name);
/**
* Perform a name shortening operation on the GNS.
*
* @param handle handle to the GNS service
* @param name the name to look up
* @param proc function to call on result
* @param proc_cls closure for processor
* @return handle to the operation
*/
struct GNUNET_GNS_QueueEntry *
GNUNET_GNS_shorten (struct GNUNET_GNS_Handle *handle,
const char * name,
GNUNET_GNS_ShortenResultProcessor proc,
void *proc_cls);
/**
* Perform a name shortening operation on the GNS.
*
* @param handle handle to the GNS service
* @param name the name to look up
* @param zone the zone to start the resolution in
* @param proc function to call on result
* @param proc_cls closure for processor
* @return handle to the operation
*/
struct GNUNET_GNS_QueueEntry *
GNUNET_GNS_shorten_zone (struct GNUNET_GNS_Handle *handle,
const char * name,
struct GNUNET_CRYPTO_ShortHashCode *zone,
GNUNET_GNS_ShortenResultProcessor proc,
void *proc_cls);
/* *************** Standard API: get authority ******************* */
/**
* Processor called on for a name shortening result
* called only once
*
* @param cls closure
* @param auth_name the name of the auhtority or NULL
*/
typedef void (*GNUNET_GNS_GetAuthResultProcessor) (void *cls,
const char* short_name);
/**
* Perform an authority lookup for a given name.
*
* @param handle handle to the GNS service
* @param name the name to look up authority for
* @param proc function to call on result
* @param proc_cls closure for processor
* @return handle to the operation
*/
struct GNUNET_GNS_QueueEntry *
GNUNET_GNS_get_authority (struct GNUNET_GNS_Handle *handle,
const char * name,
GNUNET_GNS_GetAuthResultProcessor proc,
void *proc_cls);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
#endif
/* gnunet_gns_service.h */
|