- add separate encryption enabled mesh to avoid breakage during developement
[oweals/gnunet.git] / src / mesh / mesh_protocol.h
index e835429441081c8bce16e6ba811ac5bb93571bd9..2d708eb6220b11144c963eac1b525937a790b92e 100644 (file)
@@ -35,10 +35,6 @@ extern "C"
 #endif
 #endif
 
-#define MESH_TUNNEL_OPT_SPEED_MIN       0x1
-#define MESH_TUNNEL_OPT_NOBUFFER        0x2
-
-
 /******************************************************************************/
 /********************      MESH NETWORK MESSAGES     **************************/
 /******************************************************************************/
@@ -46,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|DESTROY]
+     * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_CREATE
      *
      * Size: sizeof(struct GNUNET_MESH_ManipulatePath) +
      *       path_length * sizeof (struct GNUNET_PeerIdentity)
@@ -65,65 +61,32 @@ struct GNUNET_MESH_ManipulatePath
   uint32_t tid GNUNET_PACKED;
 
     /**
-     * Tunnel options (MESH_TUNNEL_OPT_*).
+     * Tunnel options (GNUNET_MESH_OPTION_*).
      */
   uint32_t opt GNUNET_PACKED;
 
     /**
-     * 64 bit alignment padding.
+     * Destination port.
      */
-  uint32_t reserved GNUNET_PACKED;
+  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].
      */
   /* struct GNUNET_PeerIdentity peers[path_length]; */
 };
 
-/**
- * Message for mesh data traffic to all tunnel targets.
- */
-struct GNUNET_MESH_Multicast
-{
-    /**
-     * Type: GNUNET_MESSAGE_TYPE_MESH_MULTICAST
-     */
-  struct GNUNET_MessageHeader header;
-
-    /**
-     * 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
-     */
-  struct GNUNET_PeerIdentity oid;
-
-    /**
-     * Payload follows
-     */
-};
-
 
 /**
- * Message for mesh data traffic to a particular destination from origin.
+ * Message for mesh data traffic.
  */
-struct GNUNET_MESH_Unicast
+struct GNUNET_MESH_Data
 {
     /**
-     * Type: GNUNET_MESSAGE_TYPE_MESH_UNICAST
+     * Type: GNUNET_MESSAGE_TYPE_MESH_UNICAST,
+     *       GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN
      */
   struct GNUNET_MessageHeader header;
 
@@ -138,7 +101,7 @@ struct GNUNET_MESH_Unicast
   uint32_t ttl GNUNET_PACKED;
 
     /**
-     * Unique ID of the packet
+     * ID of the packet
      */
   uint32_t pid GNUNET_PACKED;
 
@@ -147,10 +110,10 @@ struct GNUNET_MESH_Unicast
      */
   struct GNUNET_PeerIdentity oid;
 
-    /**
-     * Destination.
-     */
-  struct GNUNET_PeerIdentity destination;
+  /**
+   * Unique ID of the payload message
+   */
+  uint32_t mid GNUNET_PACKED;
 
     /**
      * Payload follows
@@ -159,43 +122,36 @@ struct GNUNET_MESH_Unicast
 
 
 /**
- * Message for mesh data traffic from a tunnel participant to origin.
+ * Message to acknowledge end-to-end data.
  */
-struct GNUNET_MESH_ToOrigin
+struct GNUNET_MESH_DataACK
 {
-    /**
-     * Type: GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN
-     */
+  /**
+   * 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;
 
-    /**
-     * Sender of the message.
-     */
-  struct GNUNET_PeerIdentity sender;
+  /**
+   * Bitfield of already-received newer messages
+   * pid +  1 @ LSB
+   * pid + 64 @ MSB
+   */
+  uint64_t futures GNUNET_PACKED;
 
-    /**
-     * Payload follows
-     */
+  /**
+   * Last message ID received.
+   */
+  uint32_t mid GNUNET_PACKED;
 };
 
 
@@ -222,10 +178,10 @@ struct GNUNET_MESH_ACK
     /**
      * Maximum packet ID authorized.
      */
-  uint32_t pid;
-
+  uint32_t pid GNUNET_PACKED;
 };
 
+
 /**
  * Message to query a peer about its Flow Control status regarding a tunnel.
  */
@@ -235,22 +191,21 @@ 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 ACK received.
+   * Last packet sent.
    */
-  uint32_t last_ack;
-  
+  uint32_t pid GNUNET_PACKED;
 };
 
 /**
@@ -278,6 +233,11 @@ struct GNUNET_MESH_PathACK
      */
   struct GNUNET_PeerIdentity peer_id;
 
+    /**
+     * Initial ACK value for payload.
+     */
+  uint32_t ack GNUNET_PACKED;
+
   /* TODO: signature */
 };
 
@@ -346,15 +306,15 @@ struct GNUNET_MESH_TunnelDestroy
 struct GNUNET_MESH_TunnelKeepAlive
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_KEEPALIVE
+   * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_(FWD|BCK)_KEEPALIVE
    */
   struct GNUNET_MessageHeader header;
-  
+
   /**
    * TID of the tunnel
    */
   uint32_t tid GNUNET_PACKED;
-  
+
   /**
    * OID of the tunnel
    */