skeleton for TCP communicator

[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 ac84611d9131031c7b26449a5f2c6a6bfdd09dfa..8ae9f1e936fc56b21fa5cd2f4eafb7122ccd3317 100644 (file)
--- a/src/include/gnunet_rps_service.h
+++ b/src/include/gnunet_rps_service.h
@@ -1,27 +1,32 @@
 /*
       This file is part of GNUnet
-      Copyright (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.
+      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/>.
 
-      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.
+     SPDX-License-Identifier: AGPL3.0-or-later
  */
 
 /**
- * @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,10 @@ 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
@@ -67,6 +75,29 @@ typedef void (* GNUNET_RPS_NotifyReadyCB) (void *cls, uint64_t num_peers, const
   struct GNUNET_RPS_Handle *
 GNUNET_RPS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
 
+
+/**
+ * @brief Start a sub with the given shared value
+ *
+ * @param h Handle to rps
+ * @param shared_value The shared value that defines the members of the sub (-gorup)
+ */
+void
+GNUNET_RPS_sub_start (struct GNUNET_RPS_Handle *h,
+                      const char *shared_value);
+
+
+/**
+ * @brief Stop a sub with the given shared value
+ *
+ * @param h Handle to rps
+ * @param shared_value The shared value that defines the members of the sub (-gorup)
+ */
+void
+GNUNET_RPS_sub_stop (struct GNUNET_RPS_Handle *h,
+                     const char *shared_value);
+
+
 /**
  * Request n random peers.
  *
@@ -106,7 +137,7 @@ GNUNET_RPS_seed_ids (struct GNUNET_RPS_Handle *h, uint32_t n,
 GNUNET_RPS_request_cancel (struct GNUNET_RPS_Request_Handle *rh);
 
 
-#if ENABLE_MALICIOUS
+#ifdef ENABLE_MALICIOUS
 /**
  * Turn RPS service to act malicious.
  *
@@ -125,8 +156,48 @@ 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);
-#endif
+                          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 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,
+                           GNUNET_RPS_NotifyReadyCB stream_input_cb,
+                           void *cls);
+
+
+/**
+ * @brief Cancel a specific request for updates from the biased peer stream
+ *
+ * @param srh The request handle to cancel
+ */
+void
+GNUNET_RPS_stream_cancel (struct GNUNET_RPS_StreamRequestHandle *srh);
 
 
 /**
@@ -137,6 +208,7 @@ GNUNET_RPS_act_malicious (struct GNUNET_RPS_Handle *h,
   void
 GNUNET_RPS_disconnect (struct GNUNET_RPS_Handle *h);
 
+
 #if 0                           /* keep Emacsens' auto-indent happy */
 {
 #endif
@@ -145,3 +217,5 @@ GNUNET_RPS_disconnect (struct GNUNET_RPS_Handle *h);
 #endif
 
 #endif
+
+/** @} */  /* end of group */