src/include/gnunet_dht_service.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2004, 2005, 2006, 2008, 2009, 2011 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19  */
  20
  21 /**
  22  * @file include/gnunet_dht_service.h
  23  * @brief API to the DHT service
  24  * @author Christian Grothoff
  25  */
  26
  27 #ifndef GNUNET_DHT_SERVICE_H
  28 #define GNUNET_DHT_SERVICE_H
  29
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_block_lib.h"
  32 #include "gnunet_hello_lib.h"
  33
  34 #ifdef __cplusplus
  35 extern "C"
  36 {
  37 #if 0                           /* keep Emacsens' auto-indent happy */
  38 }
  39 #endif
  40 #endif
  41
  42
  43 /**
  44  * Default republication frequency for stored data in the DHT.
  45  */
  46 #define GNUNET_DHT_DEFAULT_REPUBLISH_FREQUENCY GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 60)
  47
  48
  49
  50 /**
  51  * Connection to the DHT service.
  52  */
  53 struct GNUNET_DHT_Handle;
  54
  55 /**
  56  * Handle to control a get operation.
  57  */
  58 struct GNUNET_DHT_GetHandle;
  59
  60 /**
  61  * Handle to control a find peer operation.
  62  */
  63 struct GNUNET_DHT_FindPeerHandle;
  64
  65
  66 /**
  67  * Options for routing.
  68  */
  69 enum GNUNET_DHT_RouteOption
  70 {
  71     /**
  72      * Default.  Do nothing special.
  73      */
  74   GNUNET_DHT_RO_NONE = 0,
  75
  76     /**
  77      * Each peer along the way should look at 'enc' (otherwise
  78      * only the k-peers closest to the key should look at it).
  79      */
  80   GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE = 1,
  81
  82     /**
  83      * We should keep track of the route that the message
  84      * took in the P2P network.
  85      */
  86   GNUNET_DHT_RO_RECORD_ROUTE = 2,
  87
  88   /**
  89    * This is a 'FIND-PEER' request, so approximate results are fine.
  90    */
  91   GNUNET_DHT_RO_FIND_PEER = 4,
  92
  93     /**
  94      * Possible message option for query key randomization.
  95      */
  96   GNUNET_DHT_RO_BART = 8
  97 };
  98
  99
 100 /**
 101  * Initialize the connection with the DHT service.
 102  *
 103  * @param cfg configuration to use
 104  * @param ht_len size of the internal hash table to use for
 105  *               processing multiple GET/FIND requests in parallel
 106  * @return NULL on error
 107  */
 108 struct GNUNET_DHT_Handle *
 109 GNUNET_DHT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 110                     unsigned int ht_len);
 111
 112
 113 /**
 114  * Shutdown connection with the DHT service.
 115  *
 116  * @param handle connection to shut down
 117  */
 118 void
 119 GNUNET_DHT_disconnect (struct GNUNET_DHT_Handle *handle);
 120
 121
 122 /* *************** Standard API: get and put ******************* */
 123
 124
 125 /**
 126  * Opaque handle to cancel a PUT operation.
 127  */
 128 struct GNUNET_DHT_PutHandle;
 129
 130
 131 /**
 132  * Type of a PUT continuation.  You must not call
 133  * "GNUNET_DHT_disconnect" in this continuation.
 134  *
 135  * @param cls closure
 136  * @param success GNUNET_OK if the PUT was transmitted,
 137  *                GNUNET_NO on timeout,
 138  *                GNUNET_SYSERR on disconnect from service
 139  *                after the PUT message was transmitted
 140  *                (so we don't know if it was received or not)
 141  */
 142 typedef void (*GNUNET_DHT_PutContinuation)(void *cls,
 143                                            int success);
 144
 145
 146 /**
 147  * Perform a PUT operation storing data in the DHT.
 148  *
 149  * @param handle handle to DHT service
 150  * @param key the key to store under
 151  * @param desired_replication_level estimate of how many
 152  *                nearest peers this request should reach
 153  * @param options routing options for this message
 154  * @param type type of the value
 155  * @param size number of bytes in data; must be less than 64k
 156  * @param data the data to store
 157  * @param exp desired expiration time for the value
 158  * @param timeout how long to wait for transmission of this request
 159  * @param cont continuation to call when done (transmitting request to service)
 160  *        You must not call "GNUNET_DHT_disconnect" in this continuation
 161  * @param cont_cls closure for cont
 162  * @return handle to cancel the "PUT" operation, NULL on error
 163  *        (size too big)
 164  */
 165 struct GNUNET_DHT_PutHandle *
 166 GNUNET_DHT_put (struct GNUNET_DHT_Handle *handle,
 167                 const struct GNUNET_HashCode * key,
 168                 uint32_t desired_replication_level,
 169                 enum GNUNET_DHT_RouteOption options,
 170                 enum GNUNET_BLOCK_Type type,
 171                 size_t size, const void *data,
 172                 struct GNUNET_TIME_Absolute exp,
 173                 struct GNUNET_TIME_Relative timeout,
 174                 GNUNET_DHT_PutContinuation cont,
 175                 void *cont_cls);
 176
 177
 178 /**
 179  * Cancels a DHT PUT operation.  Note that the PUT request may still
 180  * go out over the network (we can't stop that); However, if the PUT
 181  * has not yet been sent to the service, cancelling the PUT will stop
 182  * this from happening (but there is no way for the user of this API
 183  * to tell if that is the case).  The only use for this API is to
 184  * prevent a later call to 'cont' from "GNUNET_DHT_put" (i.e. because
 185  * the system is shutting down).
 186  *
 187  * @param ph put operation to cancel ('cont' will no longer be called)
 188  */
 189 void
 190 GNUNET_DHT_put_cancel (struct GNUNET_DHT_PutHandle *ph);
 191
 192
 193 /**
 194  * Iterator called on each result obtained for a DHT
 195  * operation that expects a reply
 196  *
 197  * @param cls closure
 198  * @param exp when will this value expire
 199  * @param key key of the result
 200  * @param get_path peers on reply path (or NULL if not recorded)
 201  * @param get_path_length number of entries in get_path
 202  * @param put_path peers on the PUT path (or NULL if not recorded)
 203  * @param put_path_length number of entries in get_path
 204  * @param type type of the result
 205  * @param size number of bytes in data
 206  * @param data pointer to the result data
 207  */
 208 typedef void (*GNUNET_DHT_GetIterator) (void *cls,
 209                                         struct GNUNET_TIME_Absolute exp,
 210                                         const struct GNUNET_HashCode * key,
 211                                         const struct GNUNET_PeerIdentity *
 212                                         get_path, unsigned int get_path_length,
 213                                         const struct GNUNET_PeerIdentity *
 214                                         put_path, unsigned int put_path_length,
 215                                         enum GNUNET_BLOCK_Type type,
 216                                         size_t size, const void *data);
 217
 218
 219
 220 /**
 221  * Perform an asynchronous GET operation on the DHT identified. See
 222  * also "GNUNET_BLOCK_evaluate".
 223  *
 224  * @param handle handle to the DHT service
 225  * @param type expected type of the response object
 226  * @param key the key to look up
 227  * @param desired_replication_level estimate of how many
 228                   nearest peers this request should reach
 229  * @param options routing options for this message
 230  * @param xquery extended query data (can be NULL, depending on type)
 231  * @param xquery_size number of bytes in xquery
 232  * @param iter function to call on each result
 233  * @param iter_cls closure for iter
 234  *
 235  * @return handle to stop the async get
 236  */
 237 struct GNUNET_DHT_GetHandle *
 238 GNUNET_DHT_get_start (struct GNUNET_DHT_Handle *handle,
 239                       enum GNUNET_BLOCK_Type type,
 240                       const struct GNUNET_HashCode *key,
 241                       uint32_t desired_replication_level,
 242                       enum GNUNET_DHT_RouteOption options,
 243                       const void *xquery, size_t xquery_size,
 244                       GNUNET_DHT_GetIterator iter, void *iter_cls);
 245
 246
 247 /**
 248  * Tell the DHT not to return any of the following known results
 249  * to this client.
 250  *
 251  * @param get_handle get operation for which results should be filtered
 252  * @param num_results number of results to be blocked that are
 253  *        provided in this call (size of the 'results' array)
 254  * @param results array of hash codes over the 'data' of the results
 255  *        to be blocked
 256  */
 257 void
 258 GNUNET_DHT_get_filter_known_results (struct GNUNET_DHT_GetHandle *get_handle,
 259                                      unsigned int num_results,
 260                                      const struct GNUNET_HashCode *results);
 261
 262 /**
 263  * Stop async DHT-get.  Frees associated resources.
 264  *
 265  * @param get_handle GET operation to stop.
 266  *
 267  * On return get_handle will no longer be valid, caller
 268  * must not use again!!!
 269  */
 270 void
 271 GNUNET_DHT_get_stop (struct GNUNET_DHT_GetHandle *get_handle);
 272
 273
 274 /* *************** Extended API: monitor ******************* */
 275
 276 /**
 277  * Handle to monitor requests
 278  */
 279 struct GNUNET_DHT_MonitorHandle;
 280
 281 /**
 282  * Callback called on each GET request going through the DHT.
 283  *
 284  * @param cls Closure.
 285  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
 286  * @param type The type of data in the request.
 287  * @param hop_count Hop count so far.
 288  * @param path_length number of entries in path (or 0 if not recorded).
 289  * @param path peers on the GET path (or NULL if not recorded).
 290  * @param desired_replication_level Desired replication level.
 291  * @param key Key of the requested data.
 292  */
 293 typedef void (*GNUNET_DHT_MonitorGetCB) (void *cls,
 294                                          enum GNUNET_DHT_RouteOption options,
 295                                          enum GNUNET_BLOCK_Type type,
 296                                          uint32_t hop_count,
 297                                          uint32_t desired_replication_level,
 298                                          unsigned int path_length,
 299                                          const struct GNUNET_PeerIdentity *path,
 300                                          const struct GNUNET_HashCode * key);
 301
 302 /**
 303  * Callback called on each GET reply going through the DHT.
 304  *
 305  * @param cls Closure.
 306  * @param type The type of data in the result.
 307  * @param get_path Peers on GET path (or NULL if not recorded).
 308  * @param get_path_length number of entries in get_path.
 309  * @param put_path peers on the PUT path (or NULL if not recorded).
 310  * @param put_path_length number of entries in get_path.
 311  * @param exp Expiration time of the data.
 312  * @param key Key of the data.
 313  * @param data Pointer to the result data.
 314  * @param size Number of bytes in data.
 315  */
 316 typedef void (*GNUNET_DHT_MonitorGetRespCB) (void *cls,
 317                                              enum GNUNET_BLOCK_Type type,
 318                                              const struct GNUNET_PeerIdentity
 319                                              *get_path,
 320                                              unsigned int get_path_length,
 321                                              const struct GNUNET_PeerIdentity
 322                                              * put_path,
 323                                              unsigned int put_path_length,
 324                                              struct GNUNET_TIME_Absolute exp,
 325                                              const struct GNUNET_HashCode * key,
 326                                              const void *data,
 327                                              size_t size);
 328
 329 /**
 330  * Callback called on each PUT request going through the DHT.
 331  *
 332  * @param cls Closure.
 333  * @param options Options, for instance RecordRoute, DemultiplexEverywhere.
 334  * @param type The type of data in the request.
 335  * @param hop_count Hop count so far.
 336  * @param path_length number of entries in path (or 0 if not recorded).
 337  * @param path peers on the PUT path (or NULL if not recorded).
 338  * @param desired_replication_level Desired replication level.
 339  * @param exp Expiration time of the data.
 340  * @param key Key under which data is to be stored.
 341  * @param data Pointer to the data carried.
 342  * @param size Number of bytes in data.
 343  */
 344 typedef void (*GNUNET_DHT_MonitorPutCB) (void *cls,
 345                                          enum GNUNET_DHT_RouteOption options,
 346                                          enum GNUNET_BLOCK_Type type,
 347                                          uint32_t hop_count,
 348                                          uint32_t desired_replication_level,
 349                                          unsigned int path_length,
 350                                          const struct GNUNET_PeerIdentity *path,
 351                                          struct GNUNET_TIME_Absolute exp,
 352                                          const struct GNUNET_HashCode * key,
 353                                          const void *data,
 354                                          size_t size);
 355
 356 /**
 357  * Start monitoring the local DHT service.
 358  *
 359  * @param handle Handle to the DHT service.
 360  * @param type Type of blocks that are of interest.
 361  * @param key Key of data of interest, NULL for all.
 362  * @param get_cb Callback to process monitored get messages.
 363  * @param get_resp_cb Callback to process monitored get response messages.
 364  * @param put_cb Callback to process monitored put messages.
 365  * @param cb_cls Closure for cb.
 366  *
 367  * @return Handle to stop monitoring.
 368  */
 369 struct GNUNET_DHT_MonitorHandle *
 370 GNUNET_DHT_monitor_start (struct GNUNET_DHT_Handle *handle,
 371                           enum GNUNET_BLOCK_Type type,
 372                           const struct GNUNET_HashCode *key,
 373                           GNUNET_DHT_MonitorGetCB get_cb,
 374                           GNUNET_DHT_MonitorGetRespCB get_resp_cb,
 375                           GNUNET_DHT_MonitorPutCB put_cb,
 376                           void *cb_cls);
 377
 378
 379 /**
 380  * Stop monitoring.
 381  *
 382  * @param handle The handle to the monitor request returned by monitor_start.
 383  *
 384  * On return handle will no longer be valid, caller must not use again!!!
 385  */
 386 void
 387 GNUNET_DHT_monitor_stop (struct GNUNET_DHT_MonitorHandle *handle);
 388
 389
 390 #if 0                           /* keep Emacsens' auto-indent happy */
 391 {
 392 #endif
 393 #ifdef __cplusplus
 394 }
 395 #endif
 396
 397
 398 #endif
 399 /* gnunet_dht_service.h */