- Fixed #2105
[oweals/gnunet.git] / src / mesh / mesh.h
index dc90f781a65f747c70b6a236860df0b3f6929d1a..d8fc404e19462433a6a6180b523afaddb9810f5b 100644 (file)
 #define MESH_H_
 #include <stdint.h>
 
-#include <gnunet_mesh_service_new.h>
+#define MESH_DEBUG              GNUNET_YES
+
+
+#include "platform.h"
 #include "gnunet_common.h"
+#include "gnunet_util_lib.h"
+#include "gnunet_peer_lib.h"
+#include "gnunet_core_service.h"
+#include "gnunet_protocols.h"
+#include <gnunet_mesh_service.h>
 
 /******************************************************************************/
 /********************        MESH LOCAL MESSAGES      *************************/
@@ -36,7 +44,7 @@
 /*  Any API call should be documented in the folowing table under API CALL.
  *  Also, any message type should be documented in the following table, with the
  * associated event.
- * 
+ *
  * API CALL (GNUNET_MESH_*)             MESSAGE USED
  * ------------------------             ------------
  * connect                              GNUNET_MESH_ClientConnect
  * peer_request_connect_del             GNUNET_MESH_PeerControl
  * peer_request_connect_by_type         GNUNET_MESH_ConnectPeerByType
  *
- * notify_transmit_ready                GNUNET_MESH_TransmitReady
+ * notify_transmit_ready                *GNUNET_MESH_TransmitReady?*
  * notify_transmit_ready_cancel         None (clear of internal data structures)
- * 
- * 
- * 
+ *
+ *
+ *
  * EVENT                                MESSAGE USED
  * -----                                ------------
- * notify_transmit_ready reply          GNUNET_MESH_TransmitReady
- * notify_transmit_ready data           GNUNET_MESH_Data or
+ * data                                 GNUNET_MESH_Data OR
  *                                      GNUNET_MESH_DataBroadcast
  * new incoming tunnel                  GNUNET_MESH_PeerControl
  * peer connects to a tunnel            GNUNET_MESH_PeerControl
  * peer disconnects from a tunnel       GNUNET_MESH_PeerControl
  */
 
+/******************************************************************************/
+/**************************       CONSTANTS      ******************************/
+/******************************************************************************/
+
+#define GNUNET_MESH_LOCAL_TUNNEL_ID_CLI 0x80000000
+#define GNUNET_MESH_LOCAL_TUNNEL_ID_SERV 0xB0000000
+
+#define CORE_QUEUE_SIZE         10
+#define LOCAL_QUEUE_SIZE        100
+
+/******************************************************************************/
+/**************************        MESSAGES      ******************************/
+/******************************************************************************/
+
+GNUNET_NETWORK_STRUCT_BEGIN
+
 /**
  * Message for a client to register to the service
  */
-struct GNUNET_MESH_ClientConnect {
+struct GNUNET_MESH_ClientConnect
+{
     /**
      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
      *
      * Size: sizeof(struct GNUNET_MESH_ClientConnect) +
-     *       sizeof(uint16_t) * types +
-     *       sizeof(MESH_ApplicationType) * applications
+     *       sizeof(MESH_ApplicationType) * applications +
+     *       sizeof(uint16_t) * types
      */
-    struct GNUNET_MessageHeader header;
-    uint16_t                    types;
-    uint16_t                    applications;
+  struct GNUNET_MessageHeader header;
+  uint16_t applications GNUNET_PACKED;
+  uint16_t types GNUNET_PACKED;
+  /* uint16_t                 list_apps[applications]     */
+  /* uint16_t                 list_types[types]           */
 };
 
 
 /**
  * Type for tunnel numbering.
- * - Local tunnel numbers are >= 0x80000000
+ * - Local tunnel numbers given by the service (incoming) are >= 0xB0000000
+ * - Local tunnel numbers given by the client (created) are >= 0x80000000
  * - Global tunnel numbers are < 0x80000000
  */
-typedef uint32_t MESH_TunnelID;
+typedef uint32_t MESH_TunnelNumber;
 
 /**
  * Message for a client to create and destroy tunnels.
  */
-struct GNUNET_MESH_TunnelMessage {
+struct GNUNET_MESH_TunnelMessage
+{
     /**
      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
      *
      * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
      */
-    struct GNUNET_MessageHeader header;
+  struct GNUNET_MessageHeader header;
 
     /**
      * ID of a tunnel controlled by this client.
      */
-    MESH_TunnelID               tunnel_id GNUNET_PACKED;
+  MESH_TunnelNumber tunnel_id GNUNET_PACKED;
+};
+
+
+/**
+ * Message for the service to let a client know about created tunnels.
+ */
+struct GNUNET_MESH_TunnelNotification
+{
+    /**
+     * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE
+     *
+     * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
+     */
+  struct GNUNET_MessageHeader header;
+
+    /**
+     * ID of a tunnel controlled by this client.
+     */
+  MESH_TunnelNumber tunnel_id GNUNET_PACKED;
+
+    /**
+     * Peer at the other end, if any
+     */
+  struct GNUNET_PeerIdentity peer;
 };
 
 /**
@@ -113,116 +165,99 @@ struct GNUNET_MESH_TunnelMessage {
  *   -- unrequested (new incoming tunnels)
  * - notify the client that peers have disconnected
  */
-struct GNUNET_MESH_PeerControl {
+struct GNUNET_MESH_PeerControl
+{
 
   /**
    * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_[ADD|DEL]
    *       (client to service, client created tunnel)
    *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_[CONNECTED|DISCONNECTED]
    *       (service to client)
-   * 
-   * Size: sizeof(struct GNUNET_MESH_PeerControl) 
+   *
+   * Size: sizeof(struct GNUNET_MESH_PeerControl)
    */
-  struct GNUNET_MessageHeader   header;
+  struct GNUNET_MessageHeader header;
 
   /**
    * ID of a tunnel controlled by this client.
    */
-   MESH_TunnelID                tunnel_id GNUNET_PACKED;
-  
+  MESH_TunnelNumber tunnel_id GNUNET_PACKED;
+
   /**
    * Peer to connect/disconnect.
    */
-  struct GNUNET_PeerIdentity    peer;
+  struct GNUNET_PeerIdentity peer;
 };
 
 
 /**
  * Message for connecting to peers offering a certain service.
  */
-struct GNUNET_MESH_ConnectPeerByType {
+struct GNUNET_MESH_ConnectPeerByType
+{
     /**
-     * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE
+     * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE |
+     *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_DISCONNECT_PEER_BY_TYPE
      */
-    struct GNUNET_MessageHeader header;
+  struct GNUNET_MessageHeader header;
 
   /**
    * ID of a tunnel controlled by this client.
    */
-   MESH_TunnelID                tunnel_id GNUNET_PACKED;
+  MESH_TunnelNumber tunnel_id GNUNET_PACKED;
+
   /**
-   * Type specification 
+   * Type specification
    */
-    GNUNET_MESH_ApplicationType type GNUNET_PACKED;
+  GNUNET_MESH_ApplicationType type GNUNET_PACKED;
 };
+GNUNET_NETWORK_STRUCT_END
 
+/******************************************************************************/
+/************************        ENUMERATIONS      ****************************/
+/******************************************************************************/
 
 /**
- *  Message for notifying the service that the client wants to send data or
- * notifying a client that the service is ready to accept data.
+ * All the states a peer participating in a tunnel can be in.
  */
-struct GNUNET_MESH_TransmitReady {
+enum MeshPeerState
+{
     /**
-     * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_REQUEST_TRANSMIT_READY
-     *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_NOTIFY_TRANSMIT_READY
+     * Uninitialized status, should never appear in operation.
      */
-    struct GNUNET_MessageHeader header;
+  MESH_PEER_INVALID,
 
     /**
-     * ID of a tunnel controlled by this client.
+     * Peer is the root and owner of the tree
      */
-    MESH_TunnelID               tunnel_id GNUNET_PACKED;
+  MESH_PEER_ROOT,
 
     /**
-     * Size of message we would like to transmit to this tunnel
+     * Peer only retransmits traffic, is not a final destination
      */
-    uint32_t                    msg_size GNUNET_PACKED; 
-};
-
-
-/**
- * Message to encapsulate data transmitted to/from the service
- */
-struct GNUNET_MESH_Data {
-    /**
-     * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA
-     *       (client to service, or service to client)
-     * Size: sizeof(struct GNUNET_MESH_Data) + sizeof (data)
-     */
-    struct GNUNET_MessageHeader header;
+  MESH_PEER_RELAY,
 
     /**
-     * ID of a tunnel controlled by this client.
+     * Path to the peer not known yet
      */
-    MESH_TunnelID               tunnel_id GNUNET_PACKED;
+  MESH_PEER_SEARCHING,
 
     /**
-     * Source or destination of the message (depending on direction).
+     * Request sent, not yet answered.
      */
-    struct GNUNET_PeerIdentity  peer_id;
-
-    /* uint8_t data[] */
-};
+  MESH_PEER_WAITING,
 
-/**
- * Message to encapsulate broadcast data transmitted to the service
- */
-struct GNUNET_MESH_DataBroadcast {
     /**
-     * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA_BROADCAST
-     *       (client to service only, client created tunnel)
-     * Size: sizeof(struct GNUNET_MESH_DataBroadcast) + sizeof (data)
+     * Peer connected and ready to accept data
      */
-    struct GNUNET_MessageHeader header;
+  MESH_PEER_READY,
 
     /**
-     * ID of a tunnel controlled by this client.
+     * Peer connected previosly but not responding
      */
-    MESH_TunnelID               tunnel_id GNUNET_PACKED;
-
-    /* uint8_t data[] */
+  MESH_PEER_RECONNECTING
 };
 
 
+
 #endif