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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
/*
This file is part of GNUnet
Copyright (C)
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.
*/
/**
* @author Julius Bünger
*
* @file
* API to the rps service
*
* @defgroup rps RPS service
* Random Peer Sampling
* @{
*/
#ifndef GNUNET_RPS_SERVICE_H
#define GNUNET_RPS_SERVICE_H
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
/**
* Version of the rps API.
*/
#define GNUNET_RPS_VERSION 0x00000000
/**
* Handle for the random peer sampling service
*/
struct GNUNET_RPS_Handle;
/**
* Handle for one request to the rps service
*/
struct GNUNET_RPS_Request_Handle;
/**
* Callback called when requested random peers are available.
*
* @param cls the closure given with the request
* @param num_peers the number of peers returned
* @param peers array with num_peers PeerIDs
*/
typedef void (* GNUNET_RPS_NotifyReadyCB) (void *cls,
uint64_t num_peers,
const struct GNUNET_PeerIdentity *peers);
/**
* Callback called when view was updated
*
* @param num_peers the number of peers returned
* @param peers array with num_peers PeerIDs
*/
typedef void (* GNUNET_RPS_ViewUpdateCB) (void *cls,
uint64_t num_peers,
const struct GNUNET_PeerIdentity *peers);
/**
* Connect to the rps service
*
* @param cfg configuration to use
* @return handle to the rps service
*/
struct GNUNET_RPS_Handle *
GNUNET_RPS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
/**
* Request n random peers.
*
* This does exacly the same as GNUNET_RPS_request_peers_single_call
* but needs a GNUNET_RPS_Handle.
* This exists only for other parts of GNUnet that expect having to
* (dis)connect from/to a service.
*
* @param h handle to the rps service
* @param n number of random peers to return
* @param ready_cb the callback to be called when the peers are available
* @param cls a closure that will be given to the callback
* @return handle to this request
*/
struct GNUNET_RPS_Request_Handle *
GNUNET_RPS_request_peers (struct GNUNET_RPS_Handle *h, uint32_t n,
GNUNET_RPS_NotifyReadyCB ready_cb,
void *cls);
/**
* Seed rps service with peerIDs.
*
* @param h handle to the rps service
* @param n number of peers to seed
* @param ids the ids of the peers seeded
*/
void
GNUNET_RPS_seed_ids (struct GNUNET_RPS_Handle *h, uint32_t n,
const struct GNUNET_PeerIdentity * ids);
/**
* Cancle an issued request.
*
* @param rh handle of the pending request to be canceled
*/
void
GNUNET_RPS_request_cancel (struct GNUNET_RPS_Request_Handle *rh);
#ifdef ENABLE_MALICIOUS
/**
* Turn RPS service to act malicious.
*
* @param h handle to the rps service
* @param type which type of malicious peer to turn to.
* 0 Don't act malicious at all
* 1 Try to maximise representation
* 2 Try to partition the network
* (isolate one peer from the rest)
* @param n number of @a ids
* @param ids the ids of the malicious peers
* if @type is 2 the last id is the id of the
* peer to be isolated from the rest
*/
void
GNUNET_RPS_act_malicious (struct GNUNET_RPS_Handle *h,
uint32_t type,
uint32_t num_peers,
const struct GNUNET_PeerIdentity *ids,
const struct GNUNET_PeerIdentity *target_peer);
#endif /* ENABLE_MALICIOUS */
/* Get internals for debugging/profiling purposes */
/**
* Request updates of view
*
* @param rps_handle handle to the rps service
* @param num_req_peers number of peers we want to receive
* (0 for infinite updates)
* @param cls a closure that will be given to the callback
* @param ready_cb the callback called when the peers are available
*/
void
GNUNET_RPS_view_request (struct GNUNET_RPS_Handle *rps_handle,
uint32_t num_updates,
GNUNET_RPS_ViewUpdateCB view_update_cb,
void *cls);
/**
* Disconnect from the rps service
*
* @param h the handle to the rps service
*/
void
GNUNET_RPS_disconnect (struct GNUNET_RPS_Handle *h);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
#endif
/** @} */ /* end of group */
|
