- use message ID for end-to-end ACKs

[oweals/gnunet.git] / src / mesh / mesh_protocol.h

diff --git a/src/mesh/mesh_protocol.h b/src/mesh/mesh_protocol.h
index f01cb7d982a4a965b69ccca63ba5ed744f6cec75..6067da90895e6dd8413a3feeabe9bfdf621fecf4 100644 (file)
--- a/src/mesh/mesh_protocol.h
+++ b/src/mesh/mesh_protocol.h
@@ -42,12 +42,12 @@ extern "C"
 GNUNET_NETWORK_STRUCT_BEGIN
 
 /**
- * Message for mesh path management
+ * Message for mesh path creation.
  */
-struct GNUNET_MESH_ManipulatePath
+struct GNUNET_MESH_CreateTunnel
 {
     /**
-     * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_[CREATE|CHANGE|ADD|DEL]
+     * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_CREATE
      *
      * Size: sizeof(struct GNUNET_MESH_ManipulatePath) +
      *       path_length * sizeof (struct GNUNET_PeerIdentity)
@@ -61,6 +61,17 @@ struct GNUNET_MESH_ManipulatePath
   uint32_t tid GNUNET_PACKED;
 
     /**
+     * Tunnel options (GNUNET_MESH_OPTION_*).
+     */
+  uint32_t opt GNUNET_PACKED;
+
+    /**
+     * Destination port.
+     */
+  uint32_t port GNUNET_PACKED;
+
+    /**
+     * FIXME do not add the first hop
      * path_length structs defining the *whole* path from the origin [0] to the
      * final destination [path_length-1].
      */
@@ -68,12 +79,34 @@ struct GNUNET_MESH_ManipulatePath
 };
 
 /**
- * Message for mesh data traffic to all tunnel targets.
+ * Message for mesh path destruction.
  */
-struct GNUNET_MESH_Multicast
+struct GNUNET_MESH_DestroyTunnel
+{
+  /**
+   * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_DESTROY
+   *
+   * Size: sizeof(struct GNUNET_MESH_ManipulatePath) +
+   *       path_length * sizeof (struct GNUNET_PeerIdentity)
+   */
+  struct GNUNET_MessageHeader header;
+  
+  /**
+   * Global id of the tunnel this path belongs to,
+   * unique in conjunction with the origin.
+   */
+  uint32_t tid GNUNET_PACKED;
+};
+
+
+/**
+ * Message for mesh data traffic.
+ */
+struct GNUNET_MESH_Data
 {
     /**
-     * Type: GNUNET_MESSAGE_TYPE_MESH_MULTICAST
+     * Type: GNUNET_MESSAGE_TYPE_MESH_UNICAST,
+     *       GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN
      */
   struct GNUNET_MessageHeader header;
 
@@ -88,7 +121,7 @@ struct GNUNET_MESH_Multicast
   uint32_t ttl GNUNET_PACKED;
 
     /**
-     * Unique ID of the packet
+     * ID of the packet
      */
   uint32_t pid GNUNET_PACKED;
 
@@ -97,6 +130,11 @@ struct GNUNET_MESH_Multicast
      */
   struct GNUNET_PeerIdentity oid;
 
+  /**
+   * Unique ID of the payload message
+   */
+  uint64_t mid GNUNET_PACKED;
+
     /**
      * Payload follows
      */
@@ -104,53 +142,46 @@ struct GNUNET_MESH_Multicast
 
 
 /**
- * Message for mesh data traffic to a particular destination from origin.
+ * Message to acknowledge end-to-end data.
  */
-struct GNUNET_MESH_Unicast
+struct GNUNET_MESH_DataACK
 {
-    /**
-     * Type: GNUNET_MESSAGE_TYPE_MESH_UNICAST
-     */
+  /**
+   * Type: GNUNET_MESSAGE_TYPE_MESH_DATA_ACK
+   */
   struct GNUNET_MessageHeader header;
 
-    /**
-     * TID of the tunnel
-     */
+  /**
+   * TID of the tunnel
+   */
   uint32_t tid GNUNET_PACKED;
 
-    /**
-     * Number of hops to live
-     */
-  uint32_t ttl GNUNET_PACKED;
-
-    /**
-     * Unique ID of the packet
-     */
-  uint32_t pid GNUNET_PACKED;
-
-    /**
-     * OID of the tunnel
-     */
+  /**
+   * OID of the tunnel
+   */
   struct GNUNET_PeerIdentity oid;
 
-    /**
-     * Destination.
-     */
-  struct GNUNET_PeerIdentity destination;
-
-    /**
-     * Payload follows
-     */
+  /**
+   * Last message ID received.
+   */
+  uint64_t mid GNUNET_PACKED;
+
+  /**
+   * Bitfield of already-received newer messages // TODO implement and use
+   * pid +  1 @ LSB
+   * pid + 32 @ MSB
+   */
+  uint32_t futures GNUNET_PACKED;
 };
 
 
 /**
- * Message for mesh data traffic from a tunnel participant to origin.
+ * Message to acknowledge mesh data traffic.
  */
-struct GNUNET_MESH_ToOrigin
+struct GNUNET_MESH_ACK
 {
     /**
-     * Type: GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN
+     * Type: GNUNET_MESSAGE_TYPE_MESH_ACK
      */
   struct GNUNET_MessageHeader header;
 
@@ -165,16 +196,38 @@ struct GNUNET_MESH_ToOrigin
   struct GNUNET_PeerIdentity oid;
 
     /**
-     * Sender of the message.
-     */
-  struct GNUNET_PeerIdentity sender;
-
-    /**
-     * Payload follows
+     * Maximum packet ID authorized.
      */
+  uint32_t pid GNUNET_PACKED;
 };
 
 
+/**
+ * Message to query a peer about its Flow Control status regarding a tunnel.
+ */
+struct GNUNET_MESH_Poll
+{
+  /**
+   * Type: GNUNET_MESSAGE_TYPE_MESH_POLL
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * TID of the tunnel
+   */
+  uint32_t tid GNUNET_PACKED;
+
+  /**
+   * OID of the tunnel
+   */
+  struct GNUNET_PeerIdentity oid;
+
+  /**
+   * Last packet sent.
+   */
+  uint32_t pid GNUNET_PACKED;
+};
+
 /**
  * Message for ack'ing a path
  */
@@ -200,6 +253,11 @@ struct GNUNET_MESH_PathACK
      */
   struct GNUNET_PeerIdentity peer_id;
 
+    /**
+     * Initial ACK value for payload.
+     */
+  uint32_t ack GNUNET_PACKED;
+
   /* TODO: signature */
 };
 
@@ -263,36 +321,28 @@ struct GNUNET_MESH_TunnelDestroy
 
 
 /**
- * Message for mesh flow control
+ * Message to destroy a tunnel
  */
-struct GNUNET_MESH_SpeedNotify
+struct GNUNET_MESH_TunnelKeepAlive
 {
-    /**
-     * Type: GNUNET_MESSAGE_TYPE_DATA_SPEED_NOTIFY
-     */
+  /**
+   * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_KEEPALIVE
+   */
   struct GNUNET_MessageHeader header;
-
-    /**
-     * TID of the tunnel
-     */
+  
+  /**
+   * TID of the tunnel
+   */
   uint32_t tid GNUNET_PACKED;
-
-    /**
-     * OID of the tunnel
-     */
+  
+  /**
+   * OID of the tunnel
+   */
   struct GNUNET_PeerIdentity oid;
+};
 
-    /**
-     * Is the speed limited by the slowest peer?.
-     */
-  int16_t speed_min;
 
-    /**
-     * Is the buffering allowed?.
-     */
-  int16_t buffering;
 
-};
 GNUNET_NETWORK_STRUCT_END
 
 #if 0                           /* keep Emacsens' auto-indent happy */