summaryrefslogtreecommitdiff
path: root/src/mesh/mesh.h
blob: dc90f781a65f747c70b6a236860df0b3f6929d1a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
/*
     This file is part of GNUnet.
     (C) 2001 - 2011 Christian Grothoff (and other contributing authors)

     GNUnet is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published
     by the Free Software Foundation; either version 3, or (at your
     option) any later version.

     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     General Public License for more details.

     You should have received a copy of the GNU General Public License
     along with GNUnet; see the file COPYING.  If not, write to the
     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
     Boston, MA 02111-1307, USA.
*/

/**
 * @author Bartlomiej Polot
 * @file mesh/mesh.h
 */

#ifndef MESH_H_
#define MESH_H_
#include <stdint.h>

#include <gnunet_mesh_service_new.h>
#include "gnunet_common.h"

/******************************************************************************/
/********************        MESH LOCAL MESSAGES      *************************/
/******************************************************************************/
/*  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
 * disconnect                           None (network level disconnect)
 *
 * tunnel_create                        GNUNET_MESH_TunnelMessage
 * tunnel_destroy                       GNUNET_MESH_TunnelMessage
 *
 * peer_request_connect_add             GNUNET_MESH_PeerControl
 * peer_request_connect_del             GNUNET_MESH_PeerControl
 * peer_request_connect_by_type         GNUNET_MESH_ConnectPeerByType
 *
 * 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
 *                                      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
 */

/**
 * Message for a client to register to the service
 */
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
     */
    struct GNUNET_MessageHeader header;
    uint16_t                    types;
    uint16_t                    applications;
};


/**
 * Type for tunnel numbering.
 * - Local tunnel numbers are >= 0x80000000
 * - Global tunnel numbers are < 0x80000000
 */
typedef uint32_t MESH_TunnelID;

/**
 * Message for a client to create and destroy tunnels.
 */
struct GNUNET_MESH_TunnelMessage {
    /**
     * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
     *
     * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
     */
    struct GNUNET_MessageHeader header;

    /**
     * ID of a tunnel controlled by this client.
     */
    MESH_TunnelID               tunnel_id GNUNET_PACKED;
};

/**
 * Message for:
 * - request adding and deleting peers from a tunnel
 * - notify the client that peers have connected:
 *   -- requested
 *   -- unrequested (new incoming tunnels)
 * - notify the client that peers have disconnected
 */
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) 
   */
  struct GNUNET_MessageHeader   header;

  /**
   * ID of a tunnel controlled by this client.
   */
   MESH_TunnelID                tunnel_id GNUNET_PACKED;
  
  /**
   * Peer to connect/disconnect.
   */
  struct GNUNET_PeerIdentity    peer;
};


/**
 * Message for connecting to peers offering a certain service.
 */
struct GNUNET_MESH_ConnectPeerByType {
    /**
     * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE
     */
    struct GNUNET_MessageHeader header;

  /**
   * ID of a tunnel controlled by this client.
   */
   MESH_TunnelID                tunnel_id GNUNET_PACKED;
 
  /**
   * Type specification 
   */
    GNUNET_MESH_ApplicationType type GNUNET_PACKED;
};


/**
 *  Message for notifying the service that the client wants to send data or
 * notifying a client that the service is ready to accept data.
 */
struct GNUNET_MESH_TransmitReady {
    /**
     * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_REQUEST_TRANSMIT_READY
     *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_NOTIFY_TRANSMIT_READY
     */
    struct GNUNET_MessageHeader header;

    /**
     * ID of a tunnel controlled by this client.
     */
    MESH_TunnelID               tunnel_id GNUNET_PACKED;

    /**
     * Size of message we would like to transmit to this tunnel
     */
    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;

    /**
     * ID of a tunnel controlled by this client.
     */
    MESH_TunnelID               tunnel_id GNUNET_PACKED;

    /**
     * Source or destination of the message (depending on direction).
     */
    struct GNUNET_PeerIdentity  peer_id;

    /* uint8_t data[] */
};

/**
 * 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)
     */
    struct GNUNET_MessageHeader header;

    /**
     * ID of a tunnel controlled by this client.
     */
    MESH_TunnelID               tunnel_id GNUNET_PACKED;

    /* uint8_t data[] */
};


#endif