src/dht/gnunet-service-wdht_neighbours.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009, 2010, 2011, 2015 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-wdht_neighbours.h
  23  * @brief GNUnet DHT routing code
  24  * @author Supriti Singh
  25  */
  26
  27 #ifndef GNUNET_SERVICE_WDHT_NEIGHBOURS_H
  28 #define GNUNET_SERVICE_WDHT_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  * Handle the put request from the client.
  37  *
  38  * @param key Key for the content
  39  * @param block_type Type of the block
  40  * @param options Routing options
  41  * @param desired_replication_level Desired replication count
  42  * @param expiration_time When does the content expire
  43  * @param data Content to store
  44  * @param data_size Size of content @a data in bytes
  45  */
  46 void
  47 GDS_NEIGHBOURS_handle_put (const struct GNUNET_HashCode *key,
  48                            enum GNUNET_BLOCK_Type block_type,
  49                            enum GNUNET_DHT_RouteOption options,
  50                            uint32_t desired_replication_level,
  51                            struct GNUNET_TIME_Absolute expiration_time,
  52                            const void *data, size_t data_size);
  53
  54 /**
  55  * Handle the get request from the client file. If I am destination do
  56  * datacache put and return. Else find the target friend and forward message
  57  * to it.
  58  *
  59  * @param key Key for the content
  60  * @param block_type Type of the block
  61  * @param options Routing options
  62  * @param desired_replication_level Desired replication count
  63  */
  64 void
  65 GDS_NEIGHBOURS_handle_get (const struct GNUNET_HashCode *key,
  66                            enum GNUNET_BLOCK_Type block_type,
  67                            enum GNUNET_DHT_RouteOption options,
  68                            uint32_t desired_replication_level);
  69
  70
  71 /**
  72  * Send the get result to requesting client.
  73  *
  74  * @param key Key of the requested data.
  75  * @param type Block type
  76  * @param target_peer Next peer to forward the message to.
  77  * @param source_peer Peer which has the data for the key.
  78  * @param put_path_length Number of peers in @a put_path
  79  * @param put_path Path taken to put the data at its stored location.
  80  * @param get_path_length Number of peers in @a get_path
  81  * @param get_path Path taken to reach to the location of the key.
  82  * @param expiration When will this result expire?
  83  * @param data Payload to store
  84  * @param data_size Size of the @a data
  85  */
  86 void
  87 GDS_NEIGHBOURS_send_get_result (const struct GNUNET_HashCode *key,
  88                                 enum GNUNET_BLOCK_Type type,
  89                                 const struct GNUNET_PeerIdentity *target_peer,
  90                                 const struct GNUNET_PeerIdentity *source_peer,
  91                                 unsigned int put_path_length,
  92                                 const struct GNUNET_PeerIdentity *put_path,
  93                                 unsigned int get_path_length,
  94                                 const struct GNUNET_PeerIdentity *get_path,
  95                                 struct GNUNET_TIME_Absolute expiration,
  96                                 const void *data, size_t data_size);
  97
  98
  99 /**
 100  * Initialize neighbours subsystem.
 101  *
 102  * @return #GNUNET_OK on success,
 103  *         #GNUNET_SYSERR on error
 104  */
 105 int
 106 GDS_NEIGHBOURS_init (void);
 107
 108
 109 /**
 110  * Shutdown neighbours subsystem.
 111  */
 112 void
 113 GDS_NEIGHBOURS_done (void);
 114
 115
 116 /**
 117  * Get my identity
 118  *
 119  * @return my identity
 120  */
 121 struct GNUNET_PeerIdentity
 122 GDS_NEIGHBOURS_get_my_id (void);
 123
 124 #endif