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      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
  83      *
  84      * Size: sizeof(struct GNUNET_MESH_ClientConnect) +
  85      *       sizeof(uint16_t) * types +
  86      *       sizeof(MESH_ApplicationType) * applications
  87      */
  88     struct GNUNET_MessageHeader header;
  89     uint16_t                    types           GNUNET_PACKED;
  90     uint16_t                    applications    GNUNET_PACKED;
  91     /* uint16_t                 list_types[types]           */
  92     /* uint16_t                 list_apps[applications]     */
  93 };
  94
  95
  96 /**
  97  * Type for tunnel numbering.
  98  * - Local tunnel numbers are >= 0x80000000
  99  * - Global tunnel numbers are < 0x80000000
 100  */
 101 typedef uint32_t MESH_TunnelNumber;
 102
 103 /**
 104  * Message for a client to create and destroy tunnels.
 105  */
 106 struct GNUNET_MESH_TunnelMessage {
 107     /**
 108      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
 109      *
 110      * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
 111      */
 112     struct GNUNET_MessageHeader header;
 113
 114     /**
 115      * ID of a tunnel controlled by this client.
 116      */
 117     MESH_TunnelNumber           tunnel_id GNUNET_PACKED;
 118 };
 119
 120 /**
 121  * Message for:
 122  * - request adding and deleting peers from a tunnel
 123  * - notify the client that peers have connected:
 124  *   -- requested
 125  *   -- unrequested (new incoming tunnels)
 126  * - notify the client that peers have disconnected
 127  */
 128 struct GNUNET_MESH_PeerControl {
 129
 130   /**
 131    * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_[ADD|DEL]
 132    *       (client to service, client created tunnel)
 133    *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_[CONNECTED|DISCONNECTED]
 134    *       (service to client)
 135    *
 136    * Size: sizeof(struct GNUNET_MESH_PeerControl)
 137    */
 138   struct GNUNET_MessageHeader   header;
 139
 140   /**
 141    * ID of a tunnel controlled by this client.
 142    */
 143    MESH_TunnelNumber            tunnel_id GNUNET_PACKED;
 144
 145   /**
 146    * Peer to connect/disconnect.
 147    */
 148   struct GNUNET_PeerIdentity    peer;
 149 };
 150
 151
 152 /**
 153  * Message for connecting to peers offering a certain service.
 154  */
 155 struct GNUNET_MESH_ConnectPeerByType {
 156     /**
 157      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE
 158      */
 159     struct GNUNET_MessageHeader header;
 160
 161   /**
 162    * ID of a tunnel controlled by this client.
 163    */
 164    MESH_TunnelNumber            tunnel_id GNUNET_PACKED;
 165
 166   /**
 167    * Type specification
 168    */
 169     GNUNET_MESH_ApplicationType type GNUNET_PACKED;
 170 };
 171
 172 #endif