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 #include <gnunet_mesh_service_new.h>
  31 #include "gnunet_common.h"
  32
  33 /******************************************************************************/
  34 /********************        MESH LOCAL MESSAGES      *************************/
  35 /******************************************************************************/
  36 /*  Any API call should be documented in the folowing table under API CALL.
  37  *  Also, any message type should be documented in the following table, with the
  38  * associated event.
  39  *
  40  * API CALL (GNUNET_MESH_*)             MESSAGE USED
  41  * ------------------------             ------------
  42  * connect                              GNUNET_MESH_ClientConnect
  43  * disconnect                           None (network level disconnect)
  44  *
  45  * tunnel_create                        GNUNET_MESH_TunnelMessage
  46  * tunnel_destroy                       GNUNET_MESH_TunnelMessage
  47  *
  48  * peer_request_connect_add             GNUNET_MESH_PeerControl
  49  * peer_request_connect_del             GNUNET_MESH_PeerControl
  50  * peer_request_connect_by_type         GNUNET_MESH_ConnectPeerByType
  51  *
  52  * notify_transmit_ready                *GNUNET_MESH_TransmitReady?*
  53  * notify_transmit_ready_cancel         None (clear of internal data structures)
  54  *
  55  *
  56  *
  57  * EVENT                                MESSAGE USED
  58  * -----                                ------------
  59  * data                                 GNUNET_MESH_Data OR
  60  *                                      GNUNET_MESH_DataBroadcast
  61  * new incoming tunnel                  GNUNET_MESH_PeerControl
  62  * peer connects to a tunnel            GNUNET_MESH_PeerControl
  63  * peer disconnects from a tunnel       GNUNET_MESH_PeerControl
  64  */
  65
  66 /******************************************************************************/
  67 /**************************       CONSTANTS      ******************************/
  68 /******************************************************************************/
  69
  70 #define GNUNET_MESH_LOCAL_TUNNEL_ID_MARK 0x80000000
  71
  72
  73 /******************************************************************************/
  74 /**************************        MESSAGES      ******************************/
  75 /******************************************************************************/
  76
  77 /**
  78  * Message for a client to register to the service
  79  */
  80 struct GNUNET_MESH_ClientConnect
  81 {
  82     /**
  83      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
  84      *
  85      * Size: sizeof(struct GNUNET_MESH_ClientConnect) +
  86      *       sizeof(uint16_t) * types +
  87      *       sizeof(MESH_ApplicationType) * applications
  88      */
  89   struct GNUNET_MessageHeader header;
  90   uint16_t types GNUNET_PACKED;
  91   uint16_t applications GNUNET_PACKED;
  92   /* uint16_t                 list_types[types]           */
  93   /* uint16_t                 list_apps[applications]     */
  94 };
  95
  96
  97 /**
  98  * Type for tunnel numbering.
  99  * - Local tunnel numbers are >= 0x80000000
 100  * - Global tunnel numbers are < 0x80000000
 101  */
 102 typedef uint32_t MESH_TunnelNumber;
 103
 104 /**
 105  * Message for a client to create and destroy tunnels.
 106  */
 107 struct GNUNET_MESH_TunnelMessage
 108 {
 109     /**
 110      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
 111      *
 112      * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
 113      */
 114   struct GNUNET_MessageHeader header;
 115
 116     /**
 117      * ID of a tunnel controlled by this client.
 118      */
 119   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 120 };
 121
 122 /**
 123  * Message for:
 124  * - request adding and deleting peers from a tunnel
 125  * - notify the client that peers have connected:
 126  *   -- requested
 127  *   -- unrequested (new incoming tunnels)
 128  * - notify the client that peers have disconnected
 129  */
 130 struct GNUNET_MESH_PeerControl
 131 {
 132
 133   /**
 134    * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_[ADD|DEL]
 135    *       (client to service, client created tunnel)
 136    *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_[CONNECTED|DISCONNECTED]
 137    *       (service to client)
 138    *
 139    * Size: sizeof(struct GNUNET_MESH_PeerControl)
 140    */
 141   struct GNUNET_MessageHeader header;
 142
 143   /**
 144    * ID of a tunnel controlled by this client.
 145    */
 146   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 147
 148   /**
 149    * When should this request time out (the service abort trying to find
 150    * a matching peer)?  The request should naturally also be aborted
 151    * if the corresponding client disconnects.
 152    */
 153   struct GNUNET_TIME_AbsoluteNBO timeout;
 154
 155   /**
 156    * Peer to connect/disconnect.
 157    */
 158   struct GNUNET_PeerIdentity peer;
 159 };
 160
 161
 162 /**
 163  * Message for connecting to peers offering a certain service.
 164  */
 165 struct GNUNET_MESH_ConnectPeerByType
 166 {
 167     /**
 168      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE
 169      */
 170   struct GNUNET_MessageHeader header;
 171
 172   /**
 173    * ID of a tunnel controlled by this client.
 174    */
 175   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 176
 177   /**
 178    * When should this request time out (the service abort trying to find
 179    * a matching peer)?  The request should naturally also be aborted
 180    * if the corresponding client disconnects.
 181    */
 182   struct GNUNET_TIME_AbsoluteNBO timeout;
 183
 184   /**
 185    * Type specification
 186    */
 187   GNUNET_MESH_ApplicationType type GNUNET_PACKED;
 188 };
 189
 190 #endif