/*
This file is part of GNUnet
- (C)
+ 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 free software: you can redistribute it and/or modify it
+ under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ 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.
+ Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
- * @file include/gnunet_rps_service.h
- * @brief API to the rps service
* @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
* @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);
+typedef void (* GNUNET_RPS_NotifyReadyCB) (void *cls,
+ uint64_t num_peers,
+ const struct GNUNET_PeerIdentity *peers);
-/**
- * Request n random peers.
- *
- * This is a wrapper function that makes it unnecessary to have to
- * (dis)connect from/to the service.
- *
- * @param cfg the configuration to use
- * @param n number of peers to be returned
- * @param ready_cb the callback to be called when the PeerIDs are available
- * @param cls closure given to the callback
- * @return handle to this request
- */
- struct GNUNET_RPS_Request_Handle *
-GNUNET_RPS_request_peers_single_call (const struct GNUNET_CONFIGURATION_Handle *cfg,
- uint64_t n,
- GNUNET_RPS_NotifyReadyCB ready_cb,
- void *cls);
/**
* Connect to the rps service
* @return handle to the rps service
*/
struct GNUNET_RPS_Handle *
-GNUNET_RPS_connect( const struct GNUNET_CONFIGURATION_Handle *cfg );
+GNUNET_RPS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
/**
* Request n random peers.
* @return handle to this request
*/
struct GNUNET_RPS_Request_Handle *
-GNUNET_RPS_request_peers (struct GNUNET_RPS_Handle *h, uint64_t n,
+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, uint64_t n,
- struct GNUNET_PeerIdentity * ids);
+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 );
+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_NotifyReadyCB view_update_cb,
+ void *cls);
+
+
+/**
+ * Request biased stream of peers that are being put into the sampler
+ *
+ * @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
+ */
+struct GNUNET_RPS_StreamRequestHandle *
+GNUNET_RPS_stream_request (struct GNUNET_RPS_Handle *rps_handle,
+ uint32_t num_updates,
+ GNUNET_RPS_NotifyReadyCB stream_input_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 );
+GNUNET_RPS_disconnect (struct GNUNET_RPS_Handle *h);
+
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#endif
+
+/** @} */ /* end of group */
projects / oweals / gnunet.git / blobdiff