1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
/*
This file is part of GNUnet.
Copyright (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
/**
* @file dht/gnunet-service-dht_neighbours.h
* @brief GNUnet DHT routing code
* @author Christian Grothoff
* @author Nathan Evans
*/
#ifndef GNUNET_SERVICE_DHT_NEIGHBOURS_H
#define GNUNET_SERVICE_DHT_NEIGHBOURS_H
#include "gnunet_util_lib.h"
#include "gnunet_block_lib.h"
#include "gnunet_dht_service.h"
/**
* Perform a PUT operation. Forwards the given request to other
* peers. Does not store the data locally. Does not give the
* data to local clients. May do nothing if this is the only
* peer in the network (or if we are the closest peer in the
* network).
*
* @param type type of the block
* @param options routing options
* @param desired_replication_level desired replication level
* @param expiration_time when does the content expire
* @param hop_count how many hops has this message traversed so far
* @param bf Bloom filter of peers this PUT has already traversed
* @param key key for the content
* @param put_path_length number of entries in put_path
* @param put_path peers this request has traversed so far (if tracked)
* @param data payload to store
* @param data_size number of bytes in data
* @return #GNUNET_OK if the request was forwarded, #GNUNET_NO if not
*/
int
GDS_NEIGHBOURS_handle_put (enum GNUNET_BLOCK_Type type,
enum GNUNET_DHT_RouteOption options,
uint32_t desired_replication_level,
struct GNUNET_TIME_Absolute expiration_time,
uint32_t hop_count,
struct GNUNET_CONTAINER_BloomFilter *bf,
const struct GNUNET_HashCode * key,
unsigned int put_path_length,
struct GNUNET_PeerIdentity *put_path,
const void *data, size_t data_size);
/**
* Perform a GET operation. Forwards the given request to other
* peers. Does not lookup the key locally. May do nothing if this is
* the only peer in the network (or if we are the closest peer in the
* network).
*
* @param type type of the block
* @param options routing options
* @param desired_replication_level desired replication count
* @param hop_count how many hops did this request traverse so far?
* @param key key for the content
* @param xquery extended query
* @param xquery_size number of bytes in @a xquery
* @param reply_bf bloomfilter to filter duplicates
* @param reply_bf_mutator mutator for @a reply_bf
* @param peer_bf filter for peers not to select (again, updated)
* @return #GNUNET_OK if the request was forwarded, #GNUNET_NO if not
*/
int
GDS_NEIGHBOURS_handle_get (enum GNUNET_BLOCK_Type type,
enum GNUNET_DHT_RouteOption options,
uint32_t desired_replication_level,
uint32_t hop_count,
const struct GNUNET_HashCode *key,
const void *xquery, size_t xquery_size,
const struct GNUNET_CONTAINER_BloomFilter *reply_bf,
uint32_t reply_bf_mutator,
struct GNUNET_CONTAINER_BloomFilter *peer_bf);
/**
* Handle a reply (route to origin). Only forwards the reply back to
* other peers waiting for it. Does not do local caching or
* forwarding to local clients.
*
* @param target neighbour that should receive the block (if still connected)
* @param type type of the block
* @param expiration_time when does the content expire
* @param key key for the content
* @param put_path_length number of entries in put_path
* @param put_path peers the original PUT traversed (if tracked)
* @param get_path_length number of entries in put_path
* @param get_path peers this reply has traversed so far (if tracked)
* @param data payload of the reply
* @param data_size number of bytes in data
*/
void
GDS_NEIGHBOURS_handle_reply (const struct GNUNET_PeerIdentity *target,
enum GNUNET_BLOCK_Type type,
struct GNUNET_TIME_Absolute expiration_time,
const struct GNUNET_HashCode * key,
unsigned int put_path_length,
const struct GNUNET_PeerIdentity *put_path,
unsigned int get_path_length,
const struct GNUNET_PeerIdentity *get_path,
const void *data, size_t data_size);
/**
* Initialize neighbours subsystem.
*
* @return GNUNET_OK on success, GNUNET_SYSERR on error
*/
int
GDS_NEIGHBOURS_init (void);
/**
* Shutdown neighbours subsystem.
*/
void
GDS_NEIGHBOURS_done (void);
/**
* Get the ID of the local node.
*
* @return identity of the local node
*/
struct GNUNET_PeerIdentity *
GDS_NEIGHBOURS_get_id ();
#endif
|
