src/mesh/gnunet-service-mesh_dht.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2013 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 mesh/gnunet-service-mesh_dht.h
  23  * @brief mesh service; dealing with DHT requests and results
  24  * @author Bartlomiej Polot
  25  *
  26  * All functions in this file should use the prefix GMD (Gnunet Mesh Dht)
  27  */
  28
  29 #ifndef GNUNET_SERVICE_MESH_DHT_H
  30 #define GNUNET_SERVICE_MESH_DHT_H
  31
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #if 0                           /* keep Emacsens' auto-indent happy */
  36 }
  37 #endif
  38 #endif
  39
  40 #include "platform.h"
  41 #include "gnunet_util_lib.h"
  42
  43 struct GMD_search_handle;
  44
  45
  46 /**
  47  * Callback called on each path found over the DHT.
  48  *
  49  * @param cls Closure.
  50  * @param path An unchecked, unoptimized path to the target node.
  51  *             After callback will no longer be valid!
  52  */
  53 typedef void (*GMD_search_callback) (void *cls,
  54                                      const struct MeshPeerPath *path);
  55
  56 /******************************************************************************/
  57 /********************************    API    ***********************************/
  58 /******************************************************************************/
  59
  60 /**
  61  * Initialize the DHT subsystem.
  62  *
  63  * @param c Configuration.
  64  * @param peer_id Local peer ID (must remain valid during all execution time).
  65  */
  66 void
  67 GMD_init (const struct GNUNET_CONFIGURATION_Handle *c,
  68           struct GNUNET_PeerIdentity *peer_id);
  69
  70 /**
  71  * Shut down the DHT subsystem.
  72  */
  73 void
  74 GMD_shutdown (void);
  75
  76
  77 struct GMD_search_handle *
  78 GMD_search (const struct GNUNET_PeerIdentity *peer_id,
  79             GMD_search_callback callback, void *cls);
  80
  81
  82 void
  83 GMD_search_stop (struct GMD_search_handle *h);
  84
  85 #if 0                           /* keep Emacsens' auto-indent happy */
  86 {
  87 #endif
  88 #ifdef __cplusplus
  89 }
  90 #endif
  91
  92 /* ifndef GNUNET_MESH_SERVICE_LOCAL_H */
  93 #endif
  94 /* end of gnunet-mesh-service_LOCAL.h */