multicast, psyc, psycstore, client_manager fixes

[oweals/gnunet.git] / src / include / gnunet_rps_service.h

diff --git a/src/include/gnunet_rps_service.h b/src/include/gnunet_rps_service.h
index 3a3b2cbad4cabdbc66bde597f0e30a2efebe1e20..47b153b14e3c26d7f9612c815ff705a3afeb6b00 100644 (file)
--- a/src/include/gnunet_rps_service.h
+++ b/src/include/gnunet_rps_service.h
@@ -1,6 +1,6 @@
 /*
       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
@@ -14,8 +14,8 @@
 
       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.
+      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+      Boston, MA 02110-1301, USA.
  */
 
 /**
@@ -39,25 +39,35 @@ extern "C"
  */
 #define GNUNET_RPS_VERSION 0x00000000
 
-typedef void (* GNUNET_RPS_NotifyReadyCB) (void *cls, uint64_t num_peers, struct GNUNET_PeerIdentity *peers);
+/**
+ * Handle for the random peer sampling service
+ */
+struct GNUNET_RPS_Handle;
 
 /**
- * Request n random peers.
+ * Handle for one request to the rps service
+ */
+struct GNUNET_RPS_Request_Handle;
+
+/**
+ * Callback called when requested random peers are available.
  *
- * This is a wrapper function that makes it useless to have to
- * (dis)connect from/to the service.
+ * @param cls the closure given with the request
+ * @param num_peers the number of peers returned
+ * @param peers array with num_peers PeerIDs
  */
-  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);
+typedef void (* GNUNET_RPS_NotifyReadyCB) (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 );
+GNUNET_RPS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 /**
  * Request n random peers.
@@ -66,23 +76,69 @@ GNUNET_RPS_connect( const struct GNUNET_CONFIGURATION_Handle *cfg );
  * 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, 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, 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_request_cancel ( struct GNUNET_RPS_Request_Handle *rh );
+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 */
+
 
 /**
  * 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 */
 {