Allowed to destroy NULL paths
[oweals/gnunet.git] / src / mesh / mesh_protocol.h
index c18d56400e056bdaf3572f1a62718d2b30588c8b..e16f32093a7735b3c6b5f1c114b77540b748deb1 100644 (file)
@@ -29,7 +29,8 @@
 #ifdef __cplusplus
 extern "C"
 {
-#if 0                           /* keep Emacsens' auto-indent happy */
+#if 0
+  /* keep Emacsens' auto-indent happy */
 }
 #endif
 #endif
@@ -49,40 +50,40 @@ struct GNUNET_MESH_ManipulatePath
      * Size: sizeof(struct GNUNET_MESH_ManipulatePath) +
      *       path_length * sizeof (struct GNUNET_PeerIdentity)
      */
-    struct GNUNET_MessageHeader header;
+  struct GNUNET_MessageHeader header;
 
     /**
      * Global id of the tunnel this path belongs to,
      * unique in conjunction with the origin.
      */
-    uint32_t                    tid GNUNET_PACKED;
+  uint32_t tid GNUNET_PACKED;
 
     /**
      * path_length structs defining the *whole* path from the origin [0] to the
      * final destination [path_length-1].
      */
-    /* struct GNUNET_PeerIdentity peers[path_length]; */
+  /* struct GNUNET_PeerIdentity peers[path_length]; */
 };
 
 /**
  * Message for mesh data traffic to all tunnel targets.
  */
-struct GNUNET_MESH_DataMessageMulticast
+struct GNUNET_MESH_Multicast
 {
     /**
-     * Type: GNUNET_MESSAGE_TYPE_DATA_MULTICAST
+     * Type: GNUNET_MESSAGE_TYPE_MESH_MULTICAST
      */
-    struct GNUNET_MessageHeader header;
+  struct GNUNET_MessageHeader header;
 
     /**
      * TID of the tunnel
      */
-    uint32_t                    tid GNUNET_PACKED;
+  uint32_t tid GNUNET_PACKED;
 
     /**
      * OID of the tunnel
      */
-    struct GNUNET_PeerIdentity  oid;
+  struct GNUNET_PeerIdentity oid;
 
     /**
      * Payload follows
@@ -93,27 +94,27 @@ struct GNUNET_MESH_DataMessageMulticast
 /**
  * Message for mesh data traffic to a particular destination from origin.
  */
-struct GNUNET_MESH_DataMessageFromOrigin
+struct GNUNET_MESH_Unicast
 {
     /**
-     * Type: GNUNET_MESSAGE_TYPE_DATA_MESSAGE_FROM_ORIGIN
+     * Type: GNUNET_MESSAGE_TYPE_MESH_UNICAST
      */
-    struct GNUNET_MessageHeader header;
+  struct GNUNET_MessageHeader header;
 
     /**
      * TID of the tunnel
      */
-    uint32_t                    tid GNUNET_PACKED;
+  uint32_t tid GNUNET_PACKED;
 
     /**
      * OID of the tunnel
      */
-    struct GNUNET_PeerIdentity  oid;
+  struct GNUNET_PeerIdentity oid;
 
     /**
      * Destination.
      */
-    struct GNUNET_PeerIdentity  destination;
+  struct GNUNET_PeerIdentity destination;
 
     /**
      * Payload follows
@@ -124,33 +125,121 @@ struct GNUNET_MESH_DataMessageFromOrigin
 /**
  * Message for mesh data traffic from a tunnel participant to origin.
  */
-struct GNUNET_MESH_DataMessageToOrigin
+struct GNUNET_MESH_ToOrigin
 {
     /**
-     * Type: GNUNET_MESSAGE_TYPE_DATA_MESSAGE_TO_ORIGIN
+     * Type: GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN
      */
-    struct GNUNET_MessageHeader header;
+  struct GNUNET_MessageHeader header;
 
     /**
      * TID of the tunnel
      */
-    uint32_t                    tid GNUNET_PACKED;
+  uint32_t tid GNUNET_PACKED;
 
     /**
      * OID of the tunnel
      */
-    struct GNUNET_PeerIdentity  oid;
+  struct GNUNET_PeerIdentity oid;
 
     /**
      * Sender of the message.
      */
-    struct GNUNET_PeerIdentity  sender;
+  struct GNUNET_PeerIdentity sender;
 
     /**
      * Payload follows
      */
 };
 
+
+/**
+ * Message for ack'ing a path
+ */
+struct GNUNET_MESH_PathACK
+{
+    /**
+     * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_ACK
+     */
+  struct GNUNET_MessageHeader header;
+
+    /**
+     * TID of the tunnel
+     */
+  uint32_t tid GNUNET_PACKED;
+
+    /**
+     * OID of the tunnel
+     */
+  struct GNUNET_PeerIdentity oid;
+
+    /**
+     * ID of the endpoint
+     */
+  struct GNUNET_PeerIdentity peer_id;
+
+  /* TODO: signature */
+};
+
+
+/**
+ * Message for notifying a disconnection in a path
+ */
+struct GNUNET_MESH_PathBroken
+{
+    /**
+     * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_BROKEN
+     */
+  struct GNUNET_MessageHeader header;
+
+    /**
+     * TID of the tunnel
+     */
+  uint32_t tid GNUNET_PACKED;
+
+    /**
+     * OID of the tunnel
+     */
+  struct GNUNET_PeerIdentity oid;
+
+    /**
+     * ID of the endpoint
+     */
+  struct GNUNET_PeerIdentity peer1;
+  
+    /**
+     * ID of the endpoint
+     */
+  struct GNUNET_PeerIdentity peer2;
+
+  /* TODO: signature */
+};
+
+
+/**
+ * Message to destroy a tunnel
+ */
+struct GNUNET_MESH_TunnelDestroy
+{
+    /**
+     * Type: GNUNET_MESSAGE_TYPE_MESH_TUNNEL_DESTROY
+     */
+  struct GNUNET_MessageHeader header;
+
+    /**
+     * TID of the tunnel
+     */
+  uint32_t tid GNUNET_PACKED;
+
+    /**
+     * OID of the tunnel
+     */
+  struct GNUNET_PeerIdentity oid;
+
+  /* TODO: signature */
+};
+
+
 /**
  * Message for mesh flow control
  */
@@ -159,22 +248,22 @@ struct GNUNET_MESH_SpeedNotify
     /**
      * Type: GNUNET_MESSAGE_TYPE_DATA_SPEED_NOTIFY
      */
-    struct GNUNET_MessageHeader header;
+  struct GNUNET_MessageHeader header;
 
     /**
      * TID of the tunnel
      */
-    uint32_t                    tid GNUNET_PACKED;
+  uint32_t tid GNUNET_PACKED;
 
     /**
      * OID of the tunnel
      */
-    struct GNUNET_PeerIdentity  oid;
+  struct GNUNET_PeerIdentity oid;
 
     /**
      * Slowest link down the path (above minimum speed requirement).
      */
-    uint32_t                    speed_min;
+  uint32_t speed_min;
 
 };