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 Christian Grothoff
  25  * @author Nathan Evans
  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: Change the comment to explain about usage of this in find successor.
  36  * Field in trail setup message to understand if the message is sent to an
  37  * intermediate finger, friend or me.
  38  */
  39 enum current_destination_type
  40 {
  41   FRIEND ,
  42   FINGER ,
  43   MY_ID ,
  44   VALUE
  45 };
  46
  47 /**
  48  * Perform a PUT operation.  Forwards the given request to other
  49  * peers.   Does not store the data locally.  Does not give the
  50  * data to local clients.  May do nothing if this is the only
  51  * peer in the network (or if we are the closest peer in the
  52  * network).
  53  *
  54  * @param type type of the block
  55  * @param options routing options
  56  * @param desired_replication_level desired replication count
  57  * @param expiration_time when does the content expire
  58  * @param hop_count how many hops has this message traversed so far
  59  * @param key key for the content
  60  * @param put_path_length number of entries in @a put_path
  61  * @param put_path peers this request has traversed so far (if tracked)
  62  * @param data payload to store
  63  * @param data_size number of bytes in @a data
  64  */
  65 void
  66 GDS_NEIGHBOURS_handle_put (enum GNUNET_BLOCK_Type type,
  67                            enum GNUNET_DHT_RouteOption options,
  68                            uint32_t desired_replication_level,
  69                            struct GNUNET_TIME_Absolute expiration_time,
  70                            uint32_t hop_count,
  71                            const struct GNUNET_HashCode * key,
  72                            unsigned int put_path_length,
  73                            struct GNUNET_PeerIdentity *put_path,
  74                            const void *data, size_t data_size,
  75                            struct GNUNET_PeerIdentity *current_destination,
  76                            struct GNUNET_PeerIdentity *current_source,
  77                            enum current_destination_type dest_type,
  78                            struct GNUNET_PeerIdentity *target_peer_id);
  79
  80
  81 /**
  82  *
  83  * @param source_peer
  84  * @param get_path
  85  * @param get_path_length
  86  * @param key
  87  */
  88 void
  89 GDS_NEIGHBOURS_handle_get (enum GNUNET_BLOCK_Type block_type,
  90                            enum GNUNET_DHT_RouteOption options,
  91                            uint32_t desired_replication_level,
  92                            uint32_t hop_count,
  93                            struct GNUNET_PeerIdentity *get_peer_path,
  94                            unsigned int get_path_length,
  95                            struct GNUNET_HashCode *key,
  96                            struct GNUNET_PeerIdentity *target_peer,
  97                            struct GNUNET_PeerIdentity *current_destination,
  98                            struct GNUNET_PeerIdentity *current_source,
  99                            enum current_destination_type *current_dest_type);
 100
 101
 102 /**
 103  * FIXME: I am removing source peer as the first element in the trail
 104  * is source identity.
 105  * Send get result back to requesting client.
 106  * @param expiration when will the reply expire
 107  * @param key the query this reply is for
 108  * @param get_path_length number of peers in @a get_path
 109  * @param get_path path the reply took on get
 110  * @param put_path_length number of peers in @a put_path
 111  * @param put_path path the reply took on put
 112  * @param type type of the reply
 113  * @param data_size number of bytes in @a data
 114  * @param data application payload data
 115  * @param get_path
 116  * @param get_path_length
 117  */
 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                                 unsigned int current_trail_index,
 128                                 struct GNUNET_PeerIdentity *next_hop);
 129
 130 /**
 131  * FIXME: Here you should update the fields of struct PeerGetResultMessage.
 132  * At the end of this message you should add the data and get path and send
 133  * to the original requesting client. and there you should call GDS_CLIENT_handle_reply
 134  * with correct parameter.
 135  * @param expiration
 136  * @param key
 137  * @param get_path_length
 138  * @param get_path
 139  * @param put_path_length
 140  * @param put_path
 141  * @param type
 142  * @param data_size
 143  * @param data
 144  */
 145 void
 146 GDS_NEIGHBOURS_datacache_get (struct GNUNET_TIME_Absolute expiration,
 147                               const struct GNUNET_HashCode *key,
 148                               unsigned int get_path_length,
 149                               const struct GNUNET_PeerIdentity *get_path,
 150                               unsigned int put_path_length,
 151                               const struct GNUNET_PeerIdentity *put_path,
 152                               enum GNUNET_BLOCK_Type type, size_t data_size,
 153                               const void *data);
 154
 155
 156 /**
 157  * Initialize neighbours subsystem.
 158  *
 159  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 160  */
 161 int
 162 GDS_NEIGHBOURS_init (void);
 163
 164
 165 /**
 166  * Shutdown neighbours subsystem.
 167  */
 168 void
 169 GDS_NEIGHBOURS_done (void);
 170
 171
 172 /**
 173  * Get the ID of the local node.
 174  *
 175  * @return identity of the local node
 176  */
 177 struct GNUNET_PeerIdentity *
 178 GDS_NEIGHBOURS_get_id ();
 179
 180
 181 #endif