src/mesh/mesh.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001 - 2011 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @author Bartlomiej Polot
  23  * @file mesh/mesh.h
  24  */
  25
  26 #ifndef MESH_H_
  27 #define MESH_H_
  28 #include <stdint.h>
  29
  30 #define MESH_DEBUG              GNUNET_YES
  31
  32
  33 #include "platform.h"
  34 #include "gnunet_common.h"
  35 #include "gnunet_util_lib.h"
  36 #include "gnunet_peer_lib.h"
  37 #include "gnunet_core_service.h"
  38 #include "gnunet_protocols.h"
  39 #include <gnunet_mesh_service.h>
  40
  41 /******************************************************************************/
  42 /********************        MESH LOCAL MESSAGES      *************************/
  43 /******************************************************************************/
  44 /*  Any API call should be documented in the folowing table under API CALL.
  45  *  Also, any message type should be documented in the following table, with the
  46  * associated event.
  47  *
  48  * API CALL (GNUNET_MESH_*)             MESSAGE USED
  49  * ------------------------             ------------
  50  * connect                              GNUNET_MESH_ClientConnect
  51  * disconnect                           None (network level disconnect)
  52  *
  53  * tunnel_create                        GNUNET_MESH_TunnelMessage
  54  * tunnel_destroy                       GNUNET_MESH_TunnelMessage
  55  *
  56  * peer_request_connect_add             GNUNET_MESH_PeerControl
  57  * peer_request_connect_del             GNUNET_MESH_PeerControl
  58  * peer_request_connect_by_type         GNUNET_MESH_ConnectPeerByType
  59  *
  60  * notify_transmit_ready                *GNUNET_MESH_TransmitReady?*
  61  * notify_transmit_ready_cancel         None (clear of internal data structures)
  62  *
  63  *
  64  *
  65  * EVENT                                MESSAGE USED
  66  * -----                                ------------
  67  * data                                 GNUNET_MESH_Data OR
  68  *                                      GNUNET_MESH_DataBroadcast
  69  * new incoming tunnel                  GNUNET_MESH_PeerControl
  70  * peer connects to a tunnel            GNUNET_MESH_PeerControl
  71  * peer disconnects from a tunnel       GNUNET_MESH_PeerControl
  72  */
  73
  74 /******************************************************************************/
  75 /**************************       CONSTANTS      ******************************/
  76 /******************************************************************************/
  77
  78 #define GNUNET_MESH_LOCAL_TUNNEL_ID_CLI 0x80000000
  79 #define GNUNET_MESH_LOCAL_TUNNEL_ID_SERV 0xB0000000
  80
  81 #define CORE_QUEUE_SIZE         10
  82 #define LOCAL_QUEUE_SIZE        100
  83
  84 /******************************************************************************/
  85 /**************************        MESSAGES      ******************************/
  86 /******************************************************************************/
  87
  88 /**
  89  * Message for a client to register to the service
  90  */
  91 struct GNUNET_MESH_ClientConnect
  92 {
  93     /**
  94      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
  95      *
  96      * Size: sizeof(struct GNUNET_MESH_ClientConnect) +
  97      *       sizeof(MESH_ApplicationType) * applications +
  98      *       sizeof(uint16_t) * types
  99      */
 100   struct GNUNET_MessageHeader header;
 101   uint16_t applications GNUNET_PACKED;
 102   uint16_t types GNUNET_PACKED;
 103   /* uint16_t                 list_apps[applications]     */
 104   /* uint16_t                 list_types[types]           */
 105 };
 106
 107
 108 /**
 109  * Type for tunnel numbering.
 110  * - Local tunnel numbers given by the service (incoming) are >= 0xB0000000
 111  * - Local tunnel numbers given by the client (created) are >= 0x80000000
 112  * - Global tunnel numbers are < 0x80000000
 113  */
 114 typedef uint32_t MESH_TunnelNumber;
 115
 116 /**
 117  * Message for a client to create and destroy tunnels.
 118  */
 119 struct GNUNET_MESH_TunnelMessage
 120 {
 121     /**
 122      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
 123      *
 124      * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
 125      */
 126   struct GNUNET_MessageHeader header;
 127
 128     /**
 129      * ID of a tunnel controlled by this client.
 130      */
 131   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 132 };
 133
 134
 135 /**
 136  * Message for the service to let a client know about created tunnels.
 137  */
 138 struct GNUNET_MESH_TunnelNotification
 139 {
 140     /**
 141      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE
 142      *
 143      * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
 144      */
 145   struct GNUNET_MessageHeader header;
 146
 147     /**
 148      * ID of a tunnel controlled by this client.
 149      */
 150   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 151
 152     /**
 153      * Peer at the other end, if any
 154      */
 155   struct GNUNET_PeerIdentity peer;
 156 };
 157
 158 /**
 159  * Message for:
 160  * - request adding and deleting peers from a tunnel
 161  * - notify the client that peers have connected:
 162  *   -- requested
 163  *   -- unrequested (new incoming tunnels)
 164  * - notify the client that peers have disconnected
 165  */
 166 struct GNUNET_MESH_PeerControl
 167 {
 168
 169   /**
 170    * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_[ADD|DEL]
 171    *       (client to service, client created tunnel)
 172    *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_[CONNECTED|DISCONNECTED]
 173    *       (service to client)
 174    *
 175    * Size: sizeof(struct GNUNET_MESH_PeerControl)
 176    */
 177   struct GNUNET_MessageHeader header;
 178
 179   /**
 180    * ID of a tunnel controlled by this client.
 181    */
 182   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 183
 184   /**
 185    * Peer to connect/disconnect.
 186    */
 187   struct GNUNET_PeerIdentity peer;
 188 };
 189
 190
 191 /**
 192  * Message for connecting to peers offering a certain service.
 193  */
 194 struct GNUNET_MESH_ConnectPeerByType
 195 {
 196     /**
 197      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE |
 198      *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_DISCONNECT_PEER_BY_TYPE
 199      */
 200   struct GNUNET_MessageHeader header;
 201
 202   /**
 203    * ID of a tunnel controlled by this client.
 204    */
 205   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 206
 207   /**
 208    * Type specification
 209    */
 210   GNUNET_MESH_ApplicationType type GNUNET_PACKED;
 211 };
 212
 213
 214 /******************************************************************************/
 215 /************************        ENUMERATIONS      ****************************/
 216 /******************************************************************************/
 217
 218 /**
 219  * All the states a peer participating in a tunnel can be in.
 220  */
 221 enum MeshPeerState
 222 {
 223     /**
 224      * Peer is the root and owner of the tree
 225      */
 226   MESH_PEER_ROOT,
 227
 228     /**
 229      * Peer only retransmits traffic, is not a final destination
 230      */
 231   MESH_PEER_RELAY,
 232
 233     /**
 234      * Path to the peer not known yet
 235      */
 236   MESH_PEER_SEARCHING,
 237
 238     /**
 239      * Request sent, not yet answered.
 240      */
 241   MESH_PEER_WAITING,
 242
 243     /**
 244      * Peer connected and ready to accept data
 245      */
 246   MESH_PEER_READY,
 247
 248     /**
 249      * Peer connected previosly but not responding
 250      */
 251   MESH_PEER_RECONNECTING
 252 };
 253
 254
 255
 256 #endif