tolerate additional IPv4 address now available for gnunet.org
[oweals/gnunet.git] / src / rps / rps.h
index f5cc2e8d10dea7083b3c213fed8e25cfd317e566..5bfef93b01f47cebad9f11b69fb56067fc14f1b8 100644 (file)
@@ -2,20 +2,20 @@
       This file is part of GNUnet
       Copyright (C) 2012-2013 GNUnet e.V.
 
-      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., 51 Franklin Street, Fifth Floor,
-      Boston, MA 02110-1301, USA.
+     SPDX-License-Identifier: AGPL3.0-or-later
  */
 /**
  * @file rps/rps.h
@@ -62,9 +62,9 @@ struct GNUNET_RPS_P2P_PullReplyMessage
 ***********************************************************************/
 
 /**
- * Message from client to RPS service to request random peer(s).
+ * Message from client to service with seed of peers.
  */
-struct GNUNET_RPS_CS_RequestMessage
+struct GNUNET_RPS_CS_SeedMessage
 {
   /**
    * Header including size and type in NBO
@@ -72,43 +72,81 @@ struct GNUNET_RPS_CS_RequestMessage
   struct GNUNET_MessageHeader header;
 
   /**
-   * Identifyer of the message.
+   * Number of peers
    */
-  uint32_t id GNUNET_PACKED;
+  uint32_t num_peers GNUNET_PACKED;
+
+  /* Followed by num_peers * GNUNET_PeerIdentity */
+};
+
+#if ENABLE_MALICIOUS
+/**
+ * Message from client to service to turn service malicious.
+ */
+struct GNUNET_RPS_CS_ActMaliciousMessage
+{
+  /**
+   * Header including size and type in NBO
+   */
+  struct GNUNET_MessageHeader header;
 
   /**
-   * Number of random peer requested
+   * If the type is 2 this is the attacked peer,
+   * empty otherwise.
+   */
+  struct GNUNET_PeerIdentity attacked_peer;
+
+  /**
+   * Type of malicious behaviour.
+   *
+   * 0 No malicious bahaviour at all
+   * 1 Try to maximise representation
+   * 2 Try to partition the network
+   */
+  uint32_t type GNUNET_PACKED;
+
+  /**
+   * Number of peers
    */
   uint32_t num_peers GNUNET_PACKED;
+
+  /* Followed by num_peers * GNUNET_PeerIdentity when the type of malicious
+     behaviour is 1 */
 };
+#endif /* ENABLE_MALICIOUS */
+
 
 /**
- * Message from RPS service to client to reply with random peer(s).
+ * Message from client to service telling it to start a new sub
  */
-struct GNUNET_RPS_CS_ReplyMessage
+struct GNUNET_RPS_CS_SubStartMessage
 {
   /**
-   * Type is #GNUNET_MESSAGE_TYPE_RPS_CS_REPLY.
+   * Header including size and type in NBO
    */
   struct GNUNET_MessageHeader header;
 
   /**
-   * Identifyer of the message.
+   * For alignment.
    */
-  uint32_t id GNUNET_PACKED;
+  uint32_t reserved GNUNET_PACKED;
 
   /**
-   * Number of random peer replied
+   * Mean interval between two rounds
    */
-  uint32_t num_peers GNUNET_PACKED;
+  struct GNUNET_TIME_RelativeNBO round_interval;
 
-  /* Followed by num_peers * GNUNET_PeerIdentity */
+  /**
+   * Length of the shared value represented as string.
+   */
+  struct GNUNET_HashCode hash GNUNET_PACKED;
 };
 
+
 /**
- * Message from client to RPS service to cancel request.
+ * Message from client to service telling it to stop a new sub
  */
-struct GNUNET_RPS_CS_RequestCancelMessage
+struct GNUNET_RPS_CS_SubStopMessage
 {
   /**
    * Header including size and type in NBO
@@ -116,15 +154,19 @@ struct GNUNET_RPS_CS_RequestCancelMessage
   struct GNUNET_MessageHeader header;
 
   /**
-   * Identifyer of the message.
+   * Length of the shared value represented as string.
    */
-  uint32_t id GNUNET_PACKED;
+  struct GNUNET_HashCode hash GNUNET_PACKED;
 };
 
+
+/* Debug messages */
+
 /**
- * Message from client to service with seed of peers.
+ * Message from client to service indicating that
+ * clients wants to get updates of the view
  */
-struct GNUNET_RPS_CS_SeedMessage
+struct GNUNET_RPS_CS_DEBUG_ViewRequest
 {
   /**
    * Header including size and type in NBO
@@ -132,18 +174,16 @@ struct GNUNET_RPS_CS_SeedMessage
   struct GNUNET_MessageHeader header;
 
   /**
-   * Number of peers
+   * Number of updates
+   * 0 for sending updates until cancellation
    */
-  uint32_t num_peers GNUNET_PACKED;
-
-  /* Followed by num_peers * GNUNET_PeerIdentity */
+  uint32_t num_updates GNUNET_PACKED;
 };
 
-#ifdef ENABLE_MALICIOUS
 /**
- * Message from client to service to turn service malicious.
+ * Message from service to client containing current update of view
  */
-struct GNUNET_RPS_CS_ActMaliciousMessage
+struct GNUNET_RPS_CS_DEBUG_ViewReply
 {
   /**
    * Header including size and type in NBO
@@ -151,30 +191,50 @@ struct GNUNET_RPS_CS_ActMaliciousMessage
   struct GNUNET_MessageHeader header;
 
   /**
-   * If the type is 2 this is the attacked peer,
-   * empty otherwise.
+   * Identifyer of the message.
    */
-  struct GNUNET_PeerIdentity attacked_peer;
+  uint32_t id GNUNET_PACKED;
 
   /**
-   * Type of malicious behaviour.
-   *
-   * 0 No malicious bahaviour at all
-   * 1 Try to maximise representation
-   * 2 Try to partition the network
+   * Number of peers in the view
    */
-  uint32_t type GNUNET_PACKED;
+  uint64_t num_peers GNUNET_PACKED;
+};
+  /* Followed by num_peers * GNUNET_PeerIdentity */
+
+/**
+ * Message from client to service indicating that
+ * clients wants to get stream of biased peers
+ */
+struct GNUNET_RPS_CS_DEBUG_StreamRequest
+{
+  /**
+   * Header including size and type in NBO
+   */
+  struct GNUNET_MessageHeader header;
+};
+
+/**
+ * Message from service to client containing peer from biased stream
+ */
+struct GNUNET_RPS_CS_DEBUG_StreamReply
+{
+  /**
+   * Header including size and type in NBO
+   */
+  struct GNUNET_MessageHeader header;
 
   /**
    * Number of peers
    */
-  uint32_t num_peers GNUNET_PACKED;
+  uint64_t num_peers GNUNET_PACKED;
 
-  /* Followed by num_peers * GNUNET_PeerIdentity when the type of malicious
-     behaviour is 1 */
+  // TODO maybe source of peer (pull/push list, peerinfo, ...)
+
+  /* Followed by num_peers * GNUNET_PeerIdentity */
 };
-#endif /* ENABLE_MALICIOUS */
 
+GNUNET_NETWORK_STRUCT_END
 
 /***********************************************************************
  * Defines from old gnunet-service-rps_peers.h
@@ -271,4 +331,8 @@ typedef int
                   const struct GNUNET_PeerIdentity *peer);
 
 
-GNUNET_NETWORK_STRUCT_END
+/**
+ * Handle to the statistics service.
+ */
+extern struct GNUNET_STATISTICS_Handle *stats;
+