2 This file is part of GNUnet
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.
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.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file include/gnunet_rps_service.h
23 * @brief API to the rps service
24 * @author Julius Bünger
26 #ifndef GNUNET_RPS_SERVICE_H
27 #define GNUNET_RPS_SERVICE_H
32 #if 0 /* keep Emacsens' auto-indent happy */
38 * Version of the rps API.
40 #define GNUNET_RPS_VERSION 0x00000000
43 * Handle for the random peer sampling service
45 struct GNUNET_RPS_Handle;
48 * Handle for one request to the rps service
50 struct GNUNET_RPS_Request_Handle;
53 * Callback called when requested random peers are available.
55 * @param cls the closure given with the request
56 * @param num_peers the number of peers returned
57 * @param peers array with num_peers PeerIDs
59 typedef void (* GNUNET_RPS_NotifyReadyCB) (void *cls,
61 const struct GNUNET_PeerIdentity *peers);
64 * Connect to the rps service
66 * @param cfg configuration to use
67 * @return handle to the rps service
69 struct GNUNET_RPS_Handle *
70 GNUNET_RPS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
73 * Request n random peers.
75 * This does exacly the same as GNUNET_RPS_request_peers_single_call
76 * but needs a GNUNET_RPS_Handle.
77 * This exists only for other parts of GNUnet that expect having to
78 * (dis)connect from/to a service.
80 * @param h handle to the rps service
81 * @param n number of random peers to return
82 * @param ready_cb the callback to be called when the peers are available
83 * @param cls a closure that will be given to the callback
84 * @return handle to this request
86 struct GNUNET_RPS_Request_Handle *
87 GNUNET_RPS_request_peers (struct GNUNET_RPS_Handle *h, uint32_t n,
88 GNUNET_RPS_NotifyReadyCB ready_cb,
92 * Seed rps service with peerIDs.
94 * @param h handle to the rps service
95 * @param n number of peers to seed
96 * @param ids the ids of the peers seeded
99 GNUNET_RPS_seed_ids (struct GNUNET_RPS_Handle *h, uint32_t n,
100 const struct GNUNET_PeerIdentity * ids);
103 * Cancle an issued request.
105 * @param rh handle of the pending request to be canceled
108 GNUNET_RPS_request_cancel (struct GNUNET_RPS_Request_Handle *rh);
111 #ifdef ENABLE_MALICIOUS
113 * Turn RPS service to act malicious.
115 * @param h handle to the rps service
116 * @param type which type of malicious peer to turn to.
117 * 0 Don't act malicious at all
118 * 1 Try to maximise representation
119 * 2 Try to partition the network
120 * (isolate one peer from the rest)
121 * @param n number of @a ids
122 * @param ids the ids of the malicious peers
123 * if @type is 2 the last id is the id of the
124 * peer to be isolated from the rest
127 GNUNET_RPS_act_malicious (struct GNUNET_RPS_Handle *h,
130 const struct GNUNET_PeerIdentity *ids,
131 const struct GNUNET_PeerIdentity *target_peer);
132 #endif /* ENABLE_MALICIOUS */
136 * Disconnect from the rps service
138 * @param h the handle to the rps service
141 GNUNET_RPS_disconnect (struct GNUNET_RPS_Handle *h);
143 #if 0 /* keep Emacsens' auto-indent happy */