-rename file
[oweals/gnunet.git] / src / set / set.h
index f3aedff4f87e2e635a7292e278b2729ea11c1d43..944881b630d644390ec99b01d616a9e83f75a794 100644 (file)
 #include "platform.h"
 #include "gnunet_common.h"
 
-/**
- * FIXME
- */
-#define GNUNET_SET_ACK_WINDOW 10
-
-
 GNUNET_NETWORK_STRUCT_BEGIN
 
 /**
@@ -150,7 +144,8 @@ struct GNUNET_SET_RequestMessage
    */
   struct GNUNET_PeerIdentity peer_id;
 
-  /* rest: nested context message */
+  /* rest: context message, that is, application-specific
+     message to convince listener to pick up */
 };
 
 
@@ -206,7 +201,8 @@ struct GNUNET_SET_ResultMessage
   uint32_t request_id GNUNET_PACKED;
 
   /**
-   * Was the evaluation successful?
+   * Was the evaluation successful? Contains
+   * an `enum GNUNET_SET_Status` in NBO.
    */
   uint16_t result_status GNUNET_PACKED;
 
@@ -264,6 +260,10 @@ struct GNUNET_SET_CancelMessage
 };
 
 
+/**
+ * Set element transmitted by service to client in response to a set
+ * iteration request.
+ */
 struct GNUNET_SET_IterResponseMessage
 {
   /**
@@ -271,6 +271,12 @@ struct GNUNET_SET_IterResponseMessage
    */
   struct GNUNET_MessageHeader header;
 
+  /**
+   * To which set iteration does this reponse belong to?  First
+   * iteration (per client) has counter zero. Wraps around.
+   */
+  uint16_t iteration_id GNUNET_PACKED;
+
   /**
    * Type of the element attachted to the message,
    * if any.
@@ -280,6 +286,10 @@ struct GNUNET_SET_IterResponseMessage
   /* rest: element */
 };
 
+
+/**
+ * Client acknowledges receiving element in iteration.
+ */
 struct GNUNET_SET_IterAckMessage
 {
   /**