tolerate additional IPv4 address now available for gnunet.org
[oweals/gnunet.git] / src / rps / rps.h
index 6bf2273b4927df72ddf98188eeed6b9ed9974189..5bfef93b01f47cebad9f11b69fb56067fc14f1b8 100644 (file)
@@ -14,6 +14,8 @@
      
       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/>.
+
+     SPDX-License-Identifier: AGPL3.0-or-later
  */
 /**
  * @file rps/rps.h
@@ -60,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
@@ -70,43 +72,54 @@ struct GNUNET_RPS_CS_RequestMessage
   struct GNUNET_MessageHeader header;
 
   /**
-   * Identifyer of the message.
-   */
-  uint32_t id GNUNET_PACKED;
-
-  /**
-   * Number of random peer requested
+   * Number of peers
    */
   uint32_t num_peers GNUNET_PACKED;
+
+  /* Followed by num_peers * GNUNET_PeerIdentity */
 };
 
+#if ENABLE_MALICIOUS
 /**
- * Message from RPS service to client to reply with random peer(s).
+ * Message from client to service to turn service malicious.
  */
-struct GNUNET_RPS_CS_ReplyMessage
+struct GNUNET_RPS_CS_ActMaliciousMessage
 {
   /**
-   * Type is #GNUNET_MESSAGE_TYPE_RPS_CS_REPLY.
+   * Header including size and type in NBO
    */
   struct GNUNET_MessageHeader header;
 
   /**
-   * Identifyer of the message.
+   * If the type is 2 this is the attacked peer,
+   * empty otherwise.
    */
-  uint32_t id GNUNET_PACKED;
+  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 random peer replied
+   * Number of peers
    */
   uint32_t num_peers GNUNET_PACKED;
 
-  /* Followed by num_peers * GNUNET_PeerIdentity */
+  /* Followed by num_peers * GNUNET_PeerIdentity when the type of malicious
+     behaviour is 1 */
 };
+#endif /* ENABLE_MALICIOUS */
+
 
 /**
- * Message from client to RPS service to cancel request.
+ * Message from client to service telling it to start a new sub
  */
-struct GNUNET_RPS_CS_RequestCancelMessage
+struct GNUNET_RPS_CS_SubStartMessage
 {
   /**
    * Header including size and type in NBO
@@ -114,34 +127,26 @@ struct GNUNET_RPS_CS_RequestCancelMessage
   struct GNUNET_MessageHeader header;
 
   /**
-   * Identifyer of the message.
+   * For alignment.
    */
-  uint32_t id GNUNET_PACKED;
-};
+  uint32_t reserved GNUNET_PACKED;
 
-/**
- * Message from client to service with seed of peers.
- */
-struct GNUNET_RPS_CS_SeedMessage
-{
   /**
-   * Header including size and type in NBO
+   * Mean interval between two rounds
    */
-  struct GNUNET_MessageHeader header;
+  struct GNUNET_TIME_RelativeNBO round_interval;
 
   /**
-   * Number of peers
+   * Length of the shared value represented as string.
    */
-  uint32_t num_peers GNUNET_PACKED;
-
-  /* Followed by num_peers * GNUNET_PeerIdentity */
+  struct GNUNET_HashCode hash GNUNET_PACKED;
 };
 
-#ifdef ENABLE_MALICIOUS
+
 /**
- * Message from client to service to turn service malicious.
+ * Message from client to service telling it to stop a new sub
  */
-struct GNUNET_RPS_CS_ActMaliciousMessage
+struct GNUNET_RPS_CS_SubStopMessage
 {
   /**
    * Header including size and type in NBO
@@ -149,29 +154,10 @@ struct GNUNET_RPS_CS_ActMaliciousMessage
   struct GNUNET_MessageHeader header;
 
   /**
-   * 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
+   * Length of the shared value represented as string.
    */
-  uint32_t num_peers GNUNET_PACKED;
-
-  /* Followed by num_peers * GNUNET_PeerIdentity when the type of malicious
-     behaviour is 1 */
+  struct GNUNET_HashCode hash GNUNET_PACKED;
 };
-#endif /* ENABLE_MALICIOUS */
 
 
 /* Debug messages */
@@ -216,6 +202,39 @@ struct GNUNET_RPS_CS_DEBUG_ViewReply
 };
   /* 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
+   */
+  uint64_t num_peers GNUNET_PACKED;
+
+  // TODO maybe source of peer (pull/push list, peerinfo, ...)
+
+  /* Followed by num_peers * GNUNET_PeerIdentity */
+};
+
+GNUNET_NETWORK_STRUCT_END
 
 /***********************************************************************
  * Defines from old gnunet-service-rps_peers.h
@@ -312,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;
+