2 This file is part of GNUnet.
3 Copyright (C) 2009, 2010, 2011, 2015 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file dht/gnunet-service-wdht_neighbours.h
23 * @brief GNUnet DHT routing code
24 * @author Supriti Singh
27 #ifndef GNUNET_SERVICE_WDHT_NEIGHBOURS_H
28 #define GNUNET_SERVICE_WDHT_NEIGHBOURS_H
30 #include "gnunet_util_lib.h"
31 #include "gnunet_block_lib.h"
32 #include "gnunet_dht_service.h"
36 * Handle the put request from the client.
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 expiration_time When does the content expire
42 * @param data Content to store
43 * @param data_size Size of content @a data in bytes
46 GDS_NEIGHBOURS_handle_put (const struct GNUNET_HashCode *key,
47 enum GNUNET_BLOCK_Type block_type,
48 enum GNUNET_DHT_RouteOption options,
49 uint32_t desired_replication_level,
50 struct GNUNET_TIME_Absolute expiration_time,
51 const void *data, size_t data_size);
54 * Handle the get request from the client file. If I am destination do
55 * datacache put and return. Else find the target friend and forward message
57 * @param key Key for the content
58 * @param block_type Type of the block
59 * @param options Routing options
60 * @param desired_replication_level Desired replication count
63 GDS_NEIGHBOURS_handle_get (const struct GNUNET_HashCode *key,
64 enum GNUNET_BLOCK_Type block_type,
65 enum GNUNET_DHT_RouteOption options,
66 uint32_t desired_replication_level);
70 * Send the get result to requesting client.
71 * @param key Key of the requested data.
72 * @param type Block type
73 * @param target_peer Next peer to forward the message to.
74 * @param source_peer Peer which has the data for the key.
75 * @param put_path_length Number of peers in @a put_path
76 * @param put_path Path taken to put the data at its stored location.
77 * @param get_path_length Number of peers in @a get_path
78 * @param get_path Path taken to reach to the location of the key.
79 * @param expiration When will this result expire?
80 * @param data Payload to store
81 * @param data_size Size of the @a data
84 GDS_NEIGHBOURS_send_get_result (const struct GNUNET_HashCode *key,
85 enum GNUNET_BLOCK_Type type,
86 const struct GNUNET_PeerIdentity *target_peer,
87 const struct GNUNET_PeerIdentity *source_peer,
88 unsigned int put_path_length,
89 const struct GNUNET_PeerIdentity *put_path,
90 unsigned int get_path_length,
91 const struct GNUNET_PeerIdentity *get_path,
92 struct GNUNET_TIME_Absolute expiration,
93 const void *data, size_t data_size);
97 * Initialize neighbours subsystem.
99 * @return #GNUNET_OK on success,
100 * #GNUNET_SYSERR on error
103 GDS_NEIGHBOURS_init (void);
107 * Shutdown neighbours subsystem.
110 GDS_NEIGHBOURS_done (void);
116 * @return my identity
118 struct GNUNET_PeerIdentity
119 GDS_NEIGHBOURS_get_my_id (void);