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 /** FIXME: by default I keep current_source, and destination as my own id.
  36  * in case we find a finger then we update current_source in the
  37  * find_successor message.
  38  * Construct a Put message and send it to target_peer.
  39  * @param key Key for the content
  40  * @param data Content to store
  41  * @param data_size Size of content @a data in bytes
  42  * @param block_type Type of the block
  43  * @param options Routing options
  44  * @param desired_replication_level Desired replication count
  45  * @param expiration_time When does the content expire
  46  * @param current_destination
  47  * @param current_source
  48  * @param target_peer Peer to which this message will be forwarded.
  49  * @param hop_count Number of hops traversed so far.
  50  * @param put_path_length Total number of peers in @a put_path
  51  * @param put_path Number of peers traversed so far
  52  */
  53 void
  54 GDS_NEIGHBOURS_send_put (const struct GNUNET_HashCode *key,
  55                          const void *data, size_t data_size,
  56                          enum GNUNET_BLOCK_Type block_type,
  57                          enum GNUNET_DHT_RouteOption options,
  58                          uint32_t desired_replication_level,
  59                          struct GNUNET_TIME_Absolute expiration_time,
  60                          struct GNUNET_PeerIdentity current_destination,
  61                          struct GNUNET_PeerIdentity current_source,
  62                          struct GNUNET_PeerIdentity *target_peer,
  63                          uint32_t hop_count,
  64                          uint32_t put_path_length,
  65                          struct GNUNET_PeerIdentity *put_path);
  66
  67
  68 /** FIXME: by default I keep current_source, and destination as my own id.
  69  * in case we find a finger then we update current_source in the
  70  * find_successor message.
  71  * Construct a Get message and send it to target_peer.
  72  * @param key Key for the content
  73  * @param data Content to store
  74  * @param data_size Size of content @a data in bytes
  75  * @param block_type Type of the block
  76  * @param options Routing options
  77  * @param desired_replication_level Desired replication count
  78  * @param expiration_time When does the content expire
  79  * @param current_destination
  80  * @param current_source
  81  * @param target_peer Peer to which this message will be forwarded.
  82  * @param hop_count Number of hops traversed so far.
  83  * @param put_path_length Total number of peers in @a put_path
  84  * @param put_path Number of peers traversed so far
  85  */
  86 void
  87 GDS_NEIGHBOURS_send_get (const struct GNUNET_HashCode *key,
  88                          enum GNUNET_BLOCK_Type block_type,
  89                          enum GNUNET_DHT_RouteOption options,
  90                          uint32_t desired_replication_level,
  91                          struct GNUNET_PeerIdentity current_destination,
  92                          struct GNUNET_PeerIdentity current_source,
  93                          struct GNUNET_PeerIdentity *target_peer,
  94                          uint32_t hop_count,
  95                          uint32_t get_path_length,
  96                          struct GNUNET_PeerIdentity *get_path);
  97
  98
  99 /**
 100  * Send the get result to requesting client.
 101  * @param expiration When will this result expire?
 102  * @param key Key of the requested data.
 103  * @param put_path_length Number of peers in @a put_path
 104  * @param put_path Path taken to put the data at its stored location.
 105  * @param type Block type
 106  * @param data_size Size of the @a data
 107  * @param data Payload to store
 108  * @param get_path Path taken to reach to the location of the key.
 109  * @param get_path_length Number of peers in @a get_path
 110  * @param current_get_path_index Index in get_path
 111  * @param next_hop Next peer to forward the message to.
 112  * @param source_peer Peer which has the data for the key.
 113  */
 114 /* FIXME: Remove redundant arguments
 115  * 1.remove get_path_index from message and just look up into the get path
 116  for your location and get the next peer.
 117  * 2. Remove next_hop, source_peer */
 118 void
 119 GDS_NEIGHBOURS_send_get_result (struct GNUNET_TIME_Absolute expiration,
 120                                 const struct GNUNET_HashCode *key,
 121                                 unsigned int put_path_length,
 122                                 const struct GNUNET_PeerIdentity *put_path,
 123                                 enum GNUNET_BLOCK_Type type, size_t data_size,
 124                                 const void *data,
 125                                 struct GNUNET_PeerIdentity *get_path,
 126                                 unsigned int get_path_length,
 127                                 struct GNUNET_PeerIdentity *next_hop,
 128                                 struct GNUNET_PeerIdentity *source_peer);
 129
 130 /**
 131  * Initialize neighbours subsystem.
 132  *
 133  * @return #GNUNET_OK on success,
 134  *         #GNUNET_SYSERR on error
 135  */
 136 int
 137 GDS_NEIGHBOURS_init (void);
 138
 139
 140 /**
 141  * Shutdown neighbours subsystem.
 142  */
 143 void
 144 GDS_NEIGHBOURS_done (void);
 145
 146
 147 /**
 148  * Get my identity
 149  *
 150  * @return my identity
 151  */
 152 struct GNUNET_PeerIdentity
 153 GDS_NEIGHBOURS_get_my_id (void);
 154
 155
 156 #endif