2 This file is part of GNUnet.
3 (C) 2001 - 2011 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @author Bartlomiej Polot
30 #include <gnunet_mesh_service_new.h>
31 #include "gnunet_common.h"
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
40 * API CALL (GNUNET_MESH_*) MESSAGE USED
41 * ------------------------ ------------
42 * connect GNUNET_MESH_ClientConnect
43 * disconnect None (network level disconnect)
45 * tunnel_create GNUNET_MESH_TunnelMessage
46 * tunnel_destroy GNUNET_MESH_TunnelMessage
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
52 * notify_transmit_ready GNUNET_MESH_TransmitReady
53 * notify_transmit_ready_cancel None (clear of internal data structures)
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
67 /******************************************************************************/
68 /************************** CONSTANTS ******************************/
69 /******************************************************************************/
71 #define GNUNET_MESH_LOCAL_TUNNEL_ID_MARK 0x80000000
74 /******************************************************************************/
75 /************************** MESSAGES ******************************/
76 /******************************************************************************/
79 * Message for a client to register to the service
81 struct GNUNET_MESH_ClientConnect {
83 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
85 * Size: sizeof(struct GNUNET_MESH_ClientConnect) +
86 * sizeof(uint16_t) * types +
87 * sizeof(MESH_ApplicationType) * applications
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] */
98 * Type for tunnel numbering.
99 * - Local tunnel numbers are >= 0x80000000
100 * - Global tunnel numbers are < 0x80000000
102 typedef uint32_t MESH_TunnelNumber;
105 * Message for a client to create and destroy tunnels.
107 struct GNUNET_MESH_TunnelMessage {
109 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
111 * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
113 struct GNUNET_MessageHeader header;
116 * ID of a tunnel controlled by this client.
118 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
123 * - request adding and deleting peers from a tunnel
124 * - notify the client that peers have connected:
126 * -- unrequested (new incoming tunnels)
127 * - notify the client that peers have disconnected
129 struct GNUNET_MESH_PeerControl {
132 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_[ADD|DEL]
133 * (client to service, client created tunnel)
134 * GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_[CONNECTED|DISCONNECTED]
135 * (service to client)
137 * Size: sizeof(struct GNUNET_MESH_PeerControl)
139 struct GNUNET_MessageHeader header;
142 * ID of a tunnel controlled by this client.
144 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
147 * Peer to connect/disconnect.
149 struct GNUNET_PeerIdentity peer;
154 * Message for connecting to peers offering a certain service.
156 struct GNUNET_MESH_ConnectPeerByType {
158 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE
160 struct GNUNET_MessageHeader header;
163 * ID of a tunnel controlled by this client.
165 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
170 GNUNET_MESH_ApplicationType type GNUNET_PACKED;
175 * Message for notifying the service that the client wants to send data or
176 * notifying a client that the service is ready to accept data.
178 struct GNUNET_MESH_TransmitReady {
180 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_REQUEST_TRANSMIT_READY
181 * GNUNET_MESSAGE_TYPE_MESH_LOCAL_NOTIFY_TRANSMIT_READY
183 struct GNUNET_MessageHeader header;
186 * ID of a tunnel controlled by this client.
188 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
191 * Size of message we would like to transmit to this tunnel
193 uint32_t msg_size GNUNET_PACKED;
198 * Message to encapsulate data transmitted to/from the service
200 struct GNUNET_MESH_Data {
202 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA
203 * (client to service, or service to client)
204 * Size: sizeof(struct GNUNET_MESH_Data) + sizeof (data)
206 struct GNUNET_MessageHeader header;
209 * ID of a tunnel in which this client participates.
211 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
214 * Source or destination of the message (depending on direction).
216 struct GNUNET_PeerIdentity peer_id;
222 * Message to encapsulate broadcast data transmitted to the service
224 struct GNUNET_MESH_DataBroadcast {
226 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA_BROADCAST
227 * (client to service only, client created tunnel)
228 * Size: sizeof(struct GNUNET_MESH_DataBroadcast) + sizeof (data)
230 struct GNUNET_MessageHeader header;
233 * ID of a tunnel controlled by this client.
235 MESH_TunnelNumber tunnel_id GNUNET_PACKED;