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 None (Header + [types])
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
68 * Type for tunnel numbering.
69 * - Local tunnel numbers are >= 0x80000000
70 * - Global tunnel numbers are < 0x80000000
72 typedef uint32_t MESH_TunnelID;
75 * Message for a client to create and destroy tunnels.
77 struct GNUNET_MESH_TunnelMessage {
79 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
81 struct GNUNET_MessageHeader header;
84 * ID of a tunnel controlled by this client.
86 MESH_TunnelID tunnel_id GNUNET_PACKED;
91 * - request adding and deleting peers from a tunnel
92 * - notify the client that peers have connected:
94 * -- unrequested (new incoming tunnels)
95 * - notify the client that peers have disconnected
97 struct GNUNET_MESH_PeerControl {
100 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_[ADD|DEL]
101 * (client to service, client created tunnel)
102 * GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_[CONNECTED|DISCONNECTED]
103 * (service to client)
105 * Size: sizeof(struct GNUNET_MESH_PeerControl)
107 struct GNUNET_MessageHeader header;
110 * ID of a tunnel controlled by this client.
112 MESH_TunnelID tunnel_id GNUNET_PACKED;
115 * Peer to connect/disconnect.
117 struct GNUNET_PeerIdentity peer;
122 * Message for connecting to peers offering a certain service.
124 struct GNUNET_MESH_ConnectPeerByType {
126 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE
128 struct GNUNET_MessageHeader header;
131 * ID of a tunnel controlled by this client.
133 MESH_TunnelID tunnel_id GNUNET_PACKED;
138 GNUNET_MESH_ApplicationType type GNUNET_PACKED;
143 * Message for notifying the service that the client wants to send data or
144 * notifying a client that the service is ready to accept data.
146 struct GNUNET_MESH_TransmitReady {
148 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_REQUEST_TRANSMIT_READY
149 * GNUNET_MESSAGE_TYPE_MESH_LOCAL_NOTIFY_TRANSMIT_READY
151 struct GNUNET_MessageHeader header;
154 * ID of a tunnel controlled by this client.
156 MESH_TunnelID tunnel_id GNUNET_PACKED;
159 * Size of message we would like to transmit to this tunnel
161 uint32_t msg_size GNUNET_PACKED;
166 * Message to encapsulate data transmitted to/from the service
168 struct GNUNET_MESH_Data {
170 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA
171 * (client to service, or service to client)
172 * Size: sizeof(struct GNUNET_MESH_Data) + sizeof (data)
174 struct GNUNET_MessageHeader header;
177 * ID of a tunnel controlled by this client.
179 MESH_TunnelID tunnel_id GNUNET_PACKED;
182 * Source or destination of the message (depending on direction).
184 struct GNUNET_PeerIdentity peer_id;
190 * Message to encapsulate broadcast data transmitted to the service
192 struct GNUNET_MESH_DataBroadcast {
194 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA_BROADCAST
195 * (client to service only, client created tunnel)
196 * Size: sizeof(struct GNUNET_MESH_DataBroadcast) + sizeof (data)
198 struct GNUNET_MessageHeader header;
201 * ID of a tunnel controlled by this client.
203 MESH_TunnelID tunnel_id GNUNET_PACKED;