session end function must include address to notify address
[oweals/gnunet.git] / 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  * Perform a PUT operation.  Forwards the given request to other
36  * peers.   Does not store the data locally.  Does not give the
37  * data to local clients.  May do nothing if this is the only
38  * peer in the network (or if we are the closest peer in the
39  * network).
40  *
41  * @param type type of the block
42  * @param options routing options
43  * @param desired_replication_level desired replication level
44  * @param expiration_time when does the content expire
45  * @param hop_count how many hops has this message traversed so far
46  * @param bf Bloom filter of peers this PUT has already traversed
47  * @param key key for the content
48  * @param put_path_length number of entries in put_path
49  * @param put_path peers this request has traversed so far (if tracked)
50  * @param data payload to store
51  * @param data_size number of bytes in data
52  */
53 void
54 GDS_NEIGHBOURS_handle_put (enum GNUNET_BLOCK_Type type,
55                            enum GNUNET_DHT_RouteOption options,
56                            uint32_t desired_replication_level,
57                            struct GNUNET_TIME_Absolute expiration_time,
58                            uint32_t hop_count,
59                            struct GNUNET_CONTAINER_BloomFilter *bf,
60                            const struct GNUNET_HashCode * key,
61                            unsigned int put_path_length,
62                            struct GNUNET_PeerIdentity *put_path,
63                            const void *data, size_t data_size);
64
65
66 /**
67  * Perform a GET operation.  Forwards the given request to other
68  * peers.  Does not lookup the key locally.  May do nothing if this is
69  * the only peer in the network (or if we are the closest peer in the
70  * network).
71  *
72  * @param type type of the block
73  * @param options routing options
74  * @param desired_replication_level desired replication count
75  * @param hop_count how many hops did this request traverse so far?
76  * @param key key for the content
77  * @param xquery extended query
78  * @param xquery_size number of bytes in xquery
79  * @param reply_bf bloomfilter to filter duplicates
80  * @param reply_bf_mutator mutator for reply_bf
81  * @param peer_bf filter for peers not to select (again, updated)
82  */
83 void
84 GDS_NEIGHBOURS_handle_get (enum GNUNET_BLOCK_Type type,
85                            enum GNUNET_DHT_RouteOption options,
86                            uint32_t desired_replication_level,
87                            uint32_t hop_count, const struct GNUNET_HashCode * key,
88                            const void *xquery, size_t xquery_size,
89                            const struct GNUNET_CONTAINER_BloomFilter *reply_bf,
90                            uint32_t reply_bf_mutator,
91                            struct GNUNET_CONTAINER_BloomFilter *peer_bf);
92
93
94 /**
95  * Initialize neighbours subsystem.
96  *
97  * @return GNUNET_OK on success, GNUNET_SYSERR on error
98  */
99 int
100 GDS_NEIGHBOURS_init (void);
101
102
103 /**
104  * Shutdown neighbours subsystem.
105  */
106 void
107 GDS_NEIGHBOURS_done (void);
108
109
110 /**
111  * Get the ID of the local node.
112  *
113  * @return identity of the local node
114  */
115 struct GNUNET_PeerIdentity *
116 GDS_NEIGHBOURS_get_id ();
117
118
119 #endif