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
|
/*
This file is part of GNUnet.
(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., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
/**
* @file dht/gnunet-service-xdht_neighbours.h
* @brief GNUnet DHT routing code
* @author Christian Grothoff
* @author Nathan Evans
*/
#ifndef GNUNET_SERVICE_XDHT_NEIGHBOURS_H
#define GNUNET_SERVICE_XDHT_NEIGHBOURS_H
#include "gnunet_util_lib.h"
#include "gnunet_block_lib.h"
#include "gnunet_dht_service.h"
/**
* FIXME: Change the comment to explain about usage of this in find successor.
* Field in trail setup message to understand if the message is sent to an
* intermediate finger, friend or me.
*/
enum current_destination_type
{
FRIEND ,
FINGER ,
MY_ID ,
VALUE
};
/**
* 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 count
* @param expiration_time when does the content expire
* @param hop_count how many hops has this message traversed so far
* @param key key for the content
* @param put_path_length number of entries in @a 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 @a data
*/
void
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,
const struct GNUNET_HashCode * key,
unsigned int put_path_length,
struct GNUNET_PeerIdentity *put_path,
const void *data, size_t data_size,
struct GNUNET_PeerIdentity *current_destination,
enum current_destination_type dest_type,
struct GNUNET_PeerIdentity *target_peer_id);
/**
*
* @param source_peer
* @param get_path
* @param get_path_length
* @param key
*/
void
GDS_NEIGHBOURS_handle_get (struct GNUNET_PeerIdentity *source_peer,
struct GNUNET_PeerIdentity *get_path,
unsigned int get_path_length,
struct GNUNET_HashCode *key,
struct GNUNET_PeerIdentity *target_peer,
struct GNUNET_PeerIdentity *current_destination,
enum current_destination_type *type);
/**
* Send get result back to requesting client.
* @param source_peer
* @param get_path
* @param get_path_length
* @param key
* @param destination_peer
* @param current_path_index
* @param data
* @param data_size
*/
void
GDS_NEIGHBOURS_send_get_result (struct GNUNET_PeerIdentity *source_peer,
struct GNUNET_PeerIdentity *get_path,
unsigned int get_path_length,
struct GNUNET_HashCode *key,
struct GNUNET_PeerIdentity *destination_peer,
unsigned int current_path_index,
const void *data, size_t data_size,
struct GNUNET_PeerIdentity *next_peer);
/**
* 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
|
