gnunet_dht_service.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2004, 2005, 2006, 2008, 2009 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 2, 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
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #if 0                           /* keep Emacsens' auto-indent happy */
  36 }
  37 #endif
  38 #endif
  39
  40 struct GNUNET_DHT_GetHandle;
  41
  42   /**
  43    * Perform an asynchronous GET operation on the DHT identified.
  44    *
  45    * @param type expected type of the response object
  46    * @param key the key to look up
  47    * @param callback function to call on each result
  48    * @param closure extra argument to callback
  49    * @return handle to stop the async get
  50    */
  51   struct GNUNET_DHT_GetHandle *
  52 GNUNET_DHT_get_start) (struct GNUNET_DHT_Handle *h,
  53                 unsigned int type,
  54                                              const GNUNET_HashCode * key,
  55                                              GNUNET_DHT_ResultProcessor callback,
  56                                              void *callback_cls);
  57
  58   /**
  59    * Stop async DHT-get.  Frees associated resources.
  60    */
  61   int GNUNET_DHT_get_stop (struct GNUNET_DHT_GetHandle * record);
  62
  63   /**
  64    * Perform a PUT operation on the DHT identified by 'table' storing
  65    * a binding of 'key' to 'value'.  The peer does not have to be part
  66    * of the table (if so, we will attempt to locate a peer that is!)
  67    *
  68    * @param key the key to store under
  69    */
  70   int GNUNET_DHT_put (struct GNUNET_DHT_Handle *h,
  71 const GNUNET_HashCode * key,
  72               unsigned int type, unsigned int size, const char *data);
  73
  74
  75 #if 0                           /* keep Emacsens' auto-indent happy */
  76 {
  77 #endif
  78 #ifdef __cplusplus
  79 }
  80 #endif
  81
  82
  83 #endif /* DHT_SERVICE_API_H */