convert fs publish to MQ

[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 39c9a1f385a9418b2fcdbe69ef722d57f87e86bc..c91804a60230833da493c350195b6356945c450c 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,14 +14,19 @@
 
       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.
  */
 
 /**
- * @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
@@ -56,7 +61,9 @@ struct GNUNET_RPS_Request_Handle;
  * @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);
 
 /**
  * Connect to the rps service
@@ -82,7 +89,7 @@ GNUNET_RPS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
  * @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);
 
@@ -94,7 +101,7 @@ GNUNET_RPS_request_peers (struct GNUNET_RPS_Handle *h, uint64_t n,
  * @param ids the ids of the peers seeded
  */
   void
-GNUNET_RPS_seed_ids (struct GNUNET_RPS_Handle *h, uint64_t n,
+GNUNET_RPS_seed_ids (struct GNUNET_RPS_Handle *h, uint32_t n,
                      const struct GNUNET_PeerIdentity * ids);
 
 /**
@@ -105,6 +112,31 @@ GNUNET_RPS_seed_ids (struct GNUNET_RPS_Handle *h, uint64_t n,
   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 */
+
+
 /**
  * Disconnect from the rps service
  *
@@ -113,6 +145,7 @@ GNUNET_RPS_request_cancel (struct GNUNET_RPS_Request_Handle *rh);
   void
 GNUNET_RPS_disconnect (struct GNUNET_RPS_Handle *h);
 
+
 #if 0                           /* keep Emacsens' auto-indent happy */
 {
 #endif
@@ -121,3 +154,5 @@ GNUNET_RPS_disconnect (struct GNUNET_RPS_Handle *h);
 #endif
 
 #endif
+
+/** @} */  /* end of group */