2 This file is part of GNUnet
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * @author Julius Bünger
23 * API to the rps service
25 * @defgroup rps RPS service
26 * Random Peer Sampling
29 #ifndef GNUNET_RPS_SERVICE_H
30 #define GNUNET_RPS_SERVICE_H
35 #if 0 /* keep Emacsens' auto-indent happy */
41 * Version of the rps API.
43 #define GNUNET_RPS_VERSION 0x00000000
46 * Handle for the random peer sampling service
48 struct GNUNET_RPS_Handle;
51 * Handle for one request to the rps service
53 struct GNUNET_RPS_Request_Handle;
56 * Callback called when requested random peers are available.
58 * @param cls the closure given with the request
59 * @param num_peers the number of peers returned
60 * @param peers array with num_peers PeerIDs
62 typedef void (* GNUNET_RPS_NotifyReadyCB) (void *cls,
64 const struct GNUNET_PeerIdentity *peers);
68 * Connect to the rps service
70 * @param cfg configuration to use
71 * @return handle to the rps service
73 struct GNUNET_RPS_Handle *
74 GNUNET_RPS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
78 * @brief Start a sub with the given shared value
80 * @param h Handle to rps
81 * @param shared_value The shared value that defines the members of the sub (-gorup)
84 GNUNET_RPS_sub_start (struct GNUNET_RPS_Handle *h,
85 const char *shared_value);
89 * @brief Stop a sub with the given shared value
91 * @param h Handle to rps
92 * @param shared_value The shared value that defines the members of the sub (-gorup)
95 GNUNET_RPS_sub_stop (struct GNUNET_RPS_Handle *h,
96 const char *shared_value);
100 * Request n random peers.
102 * This does exacly the same as GNUNET_RPS_request_peers_single_call
103 * but needs a GNUNET_RPS_Handle.
104 * This exists only for other parts of GNUnet that expect having to
105 * (dis)connect from/to a service.
107 * @param h handle to the rps service
108 * @param n number of random peers to return
109 * @param ready_cb the callback to be called when the peers are available
110 * @param cls a closure that will be given to the callback
111 * @return handle to this request
113 struct GNUNET_RPS_Request_Handle *
114 GNUNET_RPS_request_peers (struct GNUNET_RPS_Handle *h, uint32_t n,
115 GNUNET_RPS_NotifyReadyCB ready_cb,
119 * Seed rps service with peerIDs.
121 * @param h handle to the rps service
122 * @param n number of peers to seed
123 * @param ids the ids of the peers seeded
126 GNUNET_RPS_seed_ids (struct GNUNET_RPS_Handle *h, uint32_t n,
127 const struct GNUNET_PeerIdentity * ids);
130 * Cancle an issued request.
132 * @param rh handle of the pending request to be canceled
135 GNUNET_RPS_request_cancel (struct GNUNET_RPS_Request_Handle *rh);
138 #ifdef ENABLE_MALICIOUS
140 * Turn RPS service to act malicious.
142 * @param h handle to the rps service
143 * @param type which type of malicious peer to turn to.
144 * 0 Don't act malicious at all
145 * 1 Try to maximise representation
146 * 2 Try to partition the network
147 * (isolate one peer from the rest)
148 * @param n number of @a ids
149 * @param ids the ids of the malicious peers
150 * if @type is 2 the last id is the id of the
151 * peer to be isolated from the rest
154 GNUNET_RPS_act_malicious (struct GNUNET_RPS_Handle *h,
157 const struct GNUNET_PeerIdentity *ids,
158 const struct GNUNET_PeerIdentity *target_peer);
159 #endif /* ENABLE_MALICIOUS */
161 /* Get internals for debugging/profiling purposes */
164 * Request updates of view
166 * @param rps_handle handle to the rps service
167 * @param num_req_peers number of peers we want to receive
168 * (0 for infinite updates)
169 * @param cls a closure that will be given to the callback
170 * @param ready_cb the callback called when the peers are available
173 GNUNET_RPS_view_request (struct GNUNET_RPS_Handle *rps_handle,
174 uint32_t num_updates,
175 GNUNET_RPS_NotifyReadyCB view_update_cb,
180 * Request biased stream of peers that are being put into the sampler
182 * @param rps_handle handle to the rps service
183 * @param cls a closure that will be given to the callback
184 * @param ready_cb the callback called when the peers are available
186 struct GNUNET_RPS_StreamRequestHandle *
187 GNUNET_RPS_stream_request (struct GNUNET_RPS_Handle *rps_handle,
188 GNUNET_RPS_NotifyReadyCB stream_input_cb,
193 * @brief Cancel a specific request for updates from the biased peer stream
195 * @param srh The request handle to cancel
198 GNUNET_RPS_stream_cancel (struct GNUNET_RPS_StreamRequestHandle *srh);
202 * Disconnect from the rps service
204 * @param h the handle to the rps service
207 GNUNET_RPS_disconnect (struct GNUNET_RPS_Handle *h);
210 #if 0 /* keep Emacsens' auto-indent happy */
219 /** @} */ /* end of group */