src/dht/gnunet-service-dht_clients.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010, 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 dht/gnunet-service-dht_clients.h
  23  * @brief GNUnet DHT service's client management code
  24  * @author Christian Grothoff
  25  * @author Nathan Evans
  26  */
  27 #ifndef GNUNET_SERVICE_DHT_CLIENTS_H
  28 #define GNUNET_SERVICE_DHT_CLIENTS_H
  29
  30
  31 /**
  32  * Handle a reply we've received from another peer.  If the reply
  33  * matches any of our pending queries, forward it to the respective
  34  * client(s).
  35  *
  36  * @param expiration when will the reply expire
  37  * @param key the query this reply is for
  38  * @param get_path_length number of peers in 'get_path'
  39  * @param get_path path the reply took on get
  40  * @param put_path_length number of peers in 'put_path'
  41  * @param put_path path the reply took on put
  42  * @param type type of the reply
  43  * @param data_size number of bytes in 'data'
  44  * @param data application payload data
  45  */
  46 void
  47 GDS_CLIENT_handle_reply (struct GNUNET_TIME_Absolute expiration,
  48                          const GNUNET_HashCode *key,
  49                          unsigned int get_path_length,
  50                          const struct GNUNET_PeerIdentity *get_path,
  51                          unsigned int put_path_length,
  52                          const struct GNUNET_PeerIdentity *put_path,
  53                          enum GNUNET_BLOCK_Type type,
  54                          size_t data_size,
  55                          const void *data);
  56
  57
  58 /**
  59  * Initialize client subsystem.
  60  *
  61  * @param server the initialized server
  62  */
  63 void
  64 GDS_CLIENT_init (struct GNUNET_SERVER_Handle *server);
  65
  66
  67 /**
  68  * Shutdown client subsystem.
  69  */
  70 void
  71 GDS_CLIENT_done (void);
  72
  73 #endif