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                              None (Header + [types])
  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  * notify_transmit_ready reply          GNUNET_MESH_TransmitReady
  60  * notify_transmit_ready data           GNUNET_MESH_Data or
  61  *                                      GNUNET_MESH_DataBroadcast
  62  * new incoming tunnel                  GNUNET_MESH_PeerControl
  63  * peer connects to a tunnel            GNUNET_MESH_PeerControl
  64  * peer disconnects from a tunnel       GNUNET_MESH_PeerControl
  65  */
  66
  67 /**
  68  * Type for tunnel numbering.
  69  * - Local tunnel numbers are >= 0x80000000
  70  * - Global tunnel numbers are < 0x80000000
  71  */
  72 typedef uint32_t MESH_TunnelID;
  73
  74 /**
  75  * Message for a client to create and destroy tunnels.
  76  */
  77 struct GNUNET_MESH_TunnelMessage {
  78     /**
  79      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
  80      *
  81      * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
  82      */
  83     struct GNUNET_MessageHeader header;
  84
  85     /**
  86      * ID of a tunnel controlled by this client.
  87      */
  88     MESH_TunnelID               tunnel_id GNUNET_PACKED;
  89 };
  90
  91 /**
  92  * Message for:
  93  * - request adding and deleting peers from a tunnel
  94  * - notify the client that peers have connected:
  95  *   -- requested
  96  *   -- unrequested (new incoming tunnels)
  97  * - notify the client that peers have disconnected
  98  */
  99 struct GNUNET_MESH_PeerControl {
 100
 101   /**
 102    * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_[ADD|DEL]
 103    *       (client to service, client created tunnel)
 104    *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_[CONNECTED|DISCONNECTED]
 105    *       (service to client)
 106    *
 107    * Size: sizeof(struct GNUNET_MESH_PeerControl)
 108    */
 109   struct GNUNET_MessageHeader   header;
 110
 111   /**
 112    * ID of a tunnel controlled by this client.
 113    */
 114    MESH_TunnelID                tunnel_id GNUNET_PACKED;
 115
 116   /**
 117    * Peer to connect/disconnect.
 118    */
 119   struct GNUNET_PeerIdentity    peer;
 120 };
 121
 122
 123 /**
 124  * Message for connecting to peers offering a certain service.
 125  */
 126 struct GNUNET_MESH_ConnectPeerByType {
 127     /**
 128      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE
 129      */
 130     struct GNUNET_MessageHeader header;
 131
 132   /**
 133    * ID of a tunnel controlled by this client.
 134    */
 135    MESH_TunnelID                tunnel_id GNUNET_PACKED;
 136
 137   /**
 138    * Type specification
 139    */
 140     GNUNET_MESH_ApplicationType type GNUNET_PACKED;
 141 };
 142
 143
 144 /**
 145  *  Message for notifying the service that the client wants to send data or
 146  * notifying a client that the service is ready to accept data.
 147  */
 148 struct GNUNET_MESH_TransmitReady {
 149     /**
 150      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_REQUEST_TRANSMIT_READY
 151      *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_NOTIFY_TRANSMIT_READY
 152      */
 153     struct GNUNET_MessageHeader header;
 154
 155     /**
 156      * ID of a tunnel controlled by this client.
 157      */
 158     MESH_TunnelID               tunnel_id GNUNET_PACKED;
 159
 160     /**
 161      * Size of message we would like to transmit to this tunnel
 162      */
 163     uint32_t                    msg_size GNUNET_PACKED;
 164 };
 165
 166
 167 /**
 168  * Message to encapsulate data transmitted to/from the service
 169  */
 170 struct GNUNET_MESH_Data {
 171     /**
 172      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA
 173      *       (client to service, or service to client)
 174      * Size: sizeof(struct GNUNET_MESH_Data) + sizeof (data)
 175      */
 176     struct GNUNET_MessageHeader header;
 177
 178     /**
 179      * ID of a tunnel controlled by this client.
 180      */
 181     MESH_TunnelID               tunnel_id GNUNET_PACKED;
 182
 183     /**
 184      * Source or destination of the message (depending on direction).
 185      */
 186     struct GNUNET_PeerIdentity  peer_id;
 187
 188     /* uint8_t data[] */
 189 };
 190
 191 /**
 192  * Message to encapsulate broadcast data transmitted to the service
 193  */
 194 struct GNUNET_MESH_DataBroadcast {
 195     /**
 196      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA_BROADCAST
 197      *       (client to service only, client created tunnel)
 198      * Size: sizeof(struct GNUNET_MESH_DataBroadcast) + sizeof (data)
 199      */
 200     struct GNUNET_MessageHeader header;
 201
 202     /**
 203      * ID of a tunnel controlled by this client.
 204      */
 205     MESH_TunnelID               tunnel_id GNUNET_PACKED;
 206
 207     /* uint8_t data[] */
 208 };
 209
 210
 211 #endif