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 #define MESH_DEBUG GNUNET_YES
34 #include "gnunet_common.h"
35 #include "gnunet_util_lib.h"
36 #include "gnunet_peer_lib.h"
37 #include "gnunet_core_service.h"
38 #include "gnunet_protocols.h"
39 #include <gnunet_mesh_service.h>
41 /******************************************************************************/
42 /******************** MESH LOCAL MESSAGES *************************/
43 /******************************************************************************/
44 /* Any API call should be documented in the folowing table under API CALL.
45 * Also, any message type should be documented in the following table, with the
48 * API CALL (GNUNET_MESH_*) MESSAGE USED
49 * ------------------------ ------------
50 * connect GNUNET_MESH_ClientConnect
51 * disconnect None (network level disconnect)
53 * tunnel_create GNUNET_MESH_TunnelMessage
54 * tunnel_destroy GNUNET_MESH_TunnelMessage
56 * peer_request_connect_add GNUNET_MESH_PeerControl
57 * peer_request_connect_del GNUNET_MESH_PeerControl
58 * peer_request_connect_by_type GNUNET_MESH_ConnectPeerByType
60 * notify_transmit_ready *GNUNET_MESH_TransmitReady?*
61 * notify_transmit_ready_cancel None (clear of internal data structures)
67 * data GNUNET_MESH_Data OR
68 * GNUNET_MESH_DataBroadcast
69 * new incoming tunnel GNUNET_MESH_PeerControl
70 * peer connects to a tunnel GNUNET_MESH_PeerControl
71 * peer disconnects from a tunnel GNUNET_MESH_PeerControl
74 /******************************************************************************/
75 /************************** CONSTANTS ******************************/
76 /******************************************************************************/
78 #define GNUNET_MESH_LOCAL_TUNNEL_ID_CLI 0x80000000
79 #define GNUNET_MESH_LOCAL_TUNNEL_ID_SERV 0xB0000000
81 #define CORE_QUEUE_SIZE 1
82 #define LOCAL_QUEUE_SIZE 100
84 /******************************************************************************/
85 /************************** MESSAGES ******************************/
86 /******************************************************************************/
88 GNUNET_NETWORK_STRUCT_BEGIN
91 * Message for a client to register to the service
93 struct GNUNET_MESH_ClientConnect
96 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
98 * Size: sizeof(struct GNUNET_MESH_ClientConnect) +
99 * sizeof(MESH_ApplicationType) * applications +
100 * sizeof(uint16_t) * types
102 struct GNUNET_MessageHeader header;
103 uint16_t applications GNUNET_PACKED;
104 uint16_t types GNUNET_PACKED;
105 /* uint16_t list_apps[applications] */
106 /* uint16_t list_types[types] */
111 * Type for tunnel numbering.
112 * - Local tunnel numbers given by the service (incoming) are >= 0xB0000000
113 * - Local tunnel numbers given by the client (created) are >= 0x80000000
114 * - Global tunnel numbers are < 0x80000000
116 typedef uint32_t MESH_TunnelNumber;
119 * Message for a client to create and destroy tunnels.
121 struct GNUNET_MESH_TunnelMessage
124 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
125 * GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[MAX|MIN]
127 * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
129 struct GNUNET_MessageHeader header;
132 * ID of a tunnel controlled by this client.
134 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
139 * Message for the service to let a client know about created tunnels.
141 struct GNUNET_MESH_TunnelNotification
144 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE
146 * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
148 struct GNUNET_MessageHeader header;
151 * ID of a tunnel controlled by this client.
153 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
156 * Peer at the other end, if any
158 struct GNUNET_PeerIdentity peer;
163 * - request adding and deleting peers from a tunnel
164 * - notify the client that peers have connected:
166 * -- unrequested (new incoming tunnels)
167 * - notify the client that peers have disconnected
169 struct GNUNET_MESH_PeerControl
173 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_[ADD|DEL|[UN]BLACKLIST]
174 * (client to service, client created tunnel)
175 * GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_[CONNECTED|DISCONNECTED]
176 * (service to client)
178 * Size: sizeof(struct GNUNET_MESH_PeerControl)
180 struct GNUNET_MessageHeader header;
183 * ID of a tunnel controlled by this client.
185 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
188 * Peer to connect/disconnect.
190 struct GNUNET_PeerIdentity peer;
195 * Message for connecting to peers offering a service, by service number.
197 struct GNUNET_MESH_ConnectPeerByType
200 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE |
201 * GNUNET_MESSAGE_TYPE_MESH_LOCAL_DISCONNECT_PEER_BY_TYPE
203 struct GNUNET_MessageHeader header;
206 * ID of a tunnel controlled by this client.
208 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
213 GNUNET_MESH_ApplicationType type GNUNET_PACKED;
218 * Message for connecting to peers offering a service, by service string.
220 struct GNUNET_MESH_ConnectPeerByString
223 * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING
225 struct GNUNET_MessageHeader header;
228 * ID of a tunnel controlled by this client.
230 MESH_TunnelNumber tunnel_id GNUNET_PACKED;
232 /* String describing the service */
234 GNUNET_NETWORK_STRUCT_END
236 /******************************************************************************/
237 /************************ ENUMERATIONS ****************************/
238 /******************************************************************************/
241 * All the states a peer participating in a tunnel can be in.
246 * Uninitialized status, should never appear in operation.
251 * Peer is the root and owner of the tree
256 * Peer only retransmits traffic, is not a final destination
261 * Path to the peer not known yet
266 * Request sent, not yet answered.
271 * Peer connected and ready to accept data
276 * Peer connected previosly but not responding
278 MESH_PEER_RECONNECTING