src/dht/gnunet-service-xdht_neighbours.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-xdht_neighbours.h
  23  * @brief GNUnet DHT routing code
  24  * @author Supriti Singh
  25  */
  26
  27 #ifndef GNUNET_SERVICE_XDHT_NEIGHBOURS_H
  28 #define GNUNET_SERVICE_XDHT_NEIGHBOURS_H
  29
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_block_lib.h"
  32 #include "gnunet_dht_service.h"
  33
  34
  35 /**
  36  * Construct a Put message and send it to target_peer.
  37  * @param key Key for the content
  38  * @param block_type Type of the block
  39  * @param options Routing options
  40  * @param desired_replication_level Desired replication count
  41  * @param current_destination Next current destination which will get this message.
  42  * @param current_source Source for @a current_destination
  43  * @param target_peer Peer to which this message will be forwarded.
  44  * @param hop_count Number of hops traversed so far.
  45  * @param put_path_length Total number of peers in @a put_path
  46  * @param put_path Number of peers traversed so far
  47  * @param expiration_time When does the content expire
  48  * @param data Content to store
  49  * @param data_size Size of content @a data in bytes
  50  */
  51 void
  52 GDS_NEIGHBOURS_send_put (const struct GNUNET_HashCode *key,
  53                          enum GNUNET_BLOCK_Type block_type,
  54                          enum GNUNET_DHT_RouteOption options,
  55                          uint32_t desired_replication_level,
  56                          struct GNUNET_PeerIdentity current_destination,
  57                          struct GNUNET_PeerIdentity current_source,
  58                          struct GNUNET_PeerIdentity *target_peer,
  59                          uint32_t hop_count,
  60                          uint32_t put_path_length,
  61                          struct GNUNET_PeerIdentity *put_path,
  62                          struct GNUNET_TIME_Absolute expiration_time,
  63                          const void *data, size_t data_size);
  64
  65
  66 /**
  67  * Construct a Get message and send it to target_peer.
  68  * @param key Key for the content
  69  * @param block_type Type of the block
  70  * @param options Routing options
  71  * @param desired_replication_level Desired replication count
  72  * @param current_destination Next current destination which will get this message.
  73  * @param current_source Source for @a current_destination
  74  * @param target_peer Peer to which this message will be forwarded.
  75  * @param hop_count Number of hops traversed so far.
  76  * @param data Content to store
  77  * @param data_size Size of content @a data in bytes
  78  * @param get_path_length Total number of peers in @a get_path
  79  * @param get_path Number of peers traversed so far
  80  */
  81 void
  82 GDS_NEIGHBOURS_send_get (const struct GNUNET_HashCode *key,
  83                          enum GNUNET_BLOCK_Type block_type,
  84                          enum GNUNET_DHT_RouteOption options,
  85                          uint32_t desired_replication_level,
  86                          struct GNUNET_PeerIdentity current_destination,
  87                          struct GNUNET_PeerIdentity current_source,
  88                          struct GNUNET_PeerIdentity *target_peer,
  89                          uint32_t hop_count,
  90                          uint32_t get_path_length,
  91                          struct GNUNET_PeerIdentity *get_path);
  92
  93
  94 /**
  95  * Send the get result to requesting client.
  96  * @param key Key of the requested data.
  97  * @param type Block type
  98  * @param target_peer Next peer to forward the message to.
  99  * @param source_peer Peer which has the data for the key.
 100  * @param put_path_length Number of peers in @a put_path
 101  * @param put_path Path taken to put the data at its stored location.
 102  * @param get_path_length Number of peers in @a get_path
 103  * @param get_path Path taken to reach to the location of the key.
 104  * @param expiration When will this result expire?
 105  * @param data Payload to store
 106  * @param data_size Size of the @a data
 107  */
 108 void
 109 GDS_NEIGHBOURS_send_get_result (const struct GNUNET_HashCode *key,
 110                                 enum GNUNET_BLOCK_Type type,
 111                                 struct GNUNET_PeerIdentity *target_peer,
 112                                 struct GNUNET_PeerIdentity *source_peer,
 113                                 unsigned int put_path_length,
 114                                 const struct GNUNET_PeerIdentity *put_path,
 115                                 unsigned int get_path_length,
 116                                 struct GNUNET_PeerIdentity *get_path,
 117                                 struct GNUNET_TIME_Absolute expiration,
 118                                 const void *data, size_t data_size);
 119
 120 /**
 121  * Initialize neighbours subsystem.
 122  *
 123  * @return #GNUNET_OK on success,
 124  *         #GNUNET_SYSERR on error
 125  */
 126 int
 127 GDS_NEIGHBOURS_init (void);
 128
 129
 130 /**
 131  * Shutdown neighbours subsystem.
 132  */
 133 void
 134 GDS_NEIGHBOURS_done (void);
 135
 136
 137 /**
 138  * Get my identity
 139  *
 140  * @return my identity
 141  */
 142 struct GNUNET_PeerIdentity
 143 GDS_NEIGHBOURS_get_my_id (void);
 144
 145
 146 #endif