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
23 * @file mesh/mesh_protocol.h
26 #ifndef MESH_PROTOCOL_H_
27 #define MESH_PROTOCOL_H_
33 /* keep Emacsens' auto-indent happy */
38 #define MESH_TUNNEL_OPT_SPEED_MIN 0x1
39 #define MESH_TUNNEL_OPT_NOBUFFER 0x2
42 /******************************************************************************/
43 /******************** MESH NETWORK MESSAGES **************************/
44 /******************************************************************************/
46 GNUNET_NETWORK_STRUCT_BEGIN
49 * Message for mesh path management
51 struct GNUNET_MESH_ManipulatePath
54 * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_[CREATE|CHANGE|ADD|DESTROY]
56 * Size: sizeof(struct GNUNET_MESH_ManipulatePath) +
57 * path_length * sizeof (struct GNUNET_PeerIdentity)
59 struct GNUNET_MessageHeader header;
62 * Global id of the tunnel this path belongs to,
63 * unique in conjunction with the origin.
65 uint32_t tid GNUNET_PACKED;
68 * Tunnel options (MESH_TUNNEL_OPT_*).
70 uint32_t opt GNUNET_PACKED;
73 * 64 bit alignment padding.
75 uint32_t reserved GNUNET_PACKED;
78 * path_length structs defining the *whole* path from the origin [0] to the
79 * final destination [path_length-1].
81 /* struct GNUNET_PeerIdentity peers[path_length]; */
85 * Message for mesh data traffic to all tunnel targets.
87 struct GNUNET_MESH_Multicast
90 * Type: GNUNET_MESSAGE_TYPE_MESH_MULTICAST
92 struct GNUNET_MessageHeader header;
97 uint32_t tid GNUNET_PACKED;
100 * Number of hops to live
102 uint32_t ttl GNUNET_PACKED;
105 * Unique ID of the packet
107 uint32_t pid GNUNET_PACKED;
112 struct GNUNET_PeerIdentity oid;
121 * Message for mesh data traffic to a particular destination from origin.
123 struct GNUNET_MESH_Unicast
126 * Type: GNUNET_MESSAGE_TYPE_MESH_UNICAST
128 struct GNUNET_MessageHeader header;
133 uint32_t tid GNUNET_PACKED;
136 * Number of hops to live
138 uint32_t ttl GNUNET_PACKED;
141 * Unique ID of the packet
143 uint32_t pid GNUNET_PACKED;
148 struct GNUNET_PeerIdentity oid;
153 struct GNUNET_PeerIdentity destination;
162 * Message for mesh data traffic from a tunnel participant to origin.
164 struct GNUNET_MESH_ToOrigin
167 * Type: GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN
169 struct GNUNET_MessageHeader header;
174 uint32_t tid GNUNET_PACKED;
177 * Number of hops to live
179 uint32_t ttl GNUNET_PACKED;
182 * Unique ID of the packet
184 uint32_t pid GNUNET_PACKED;
189 struct GNUNET_PeerIdentity oid;
192 * Sender of the message.
194 struct GNUNET_PeerIdentity sender;
203 * Message to acknowledge mesh data traffic.
205 struct GNUNET_MESH_ACK
208 * Type: GNUNET_MESSAGE_TYPE_MESH_ACK
210 struct GNUNET_MessageHeader header;
215 uint32_t tid GNUNET_PACKED;
220 struct GNUNET_PeerIdentity oid;
223 * Maximum packet ID authorized.
230 * Message to query a peer about its Flow Control status regarding a tunnel.
232 struct GNUNET_MESH_Poll
235 * Type: GNUNET_MESSAGE_TYPE_MESH_POLL
237 struct GNUNET_MessageHeader header;
242 uint32_t tid GNUNET_PACKED;
247 struct GNUNET_PeerIdentity oid;
256 * Message for ack'ing a path
258 struct GNUNET_MESH_PathACK
261 * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_ACK
263 struct GNUNET_MessageHeader header;
268 uint32_t tid GNUNET_PACKED;
273 struct GNUNET_PeerIdentity oid;
278 struct GNUNET_PeerIdentity peer_id;
280 /* TODO: signature */
285 * Message for notifying a disconnection in a path
287 struct GNUNET_MESH_PathBroken
290 * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_BROKEN
292 struct GNUNET_MessageHeader header;
297 uint32_t tid GNUNET_PACKED;
302 struct GNUNET_PeerIdentity oid;
307 struct GNUNET_PeerIdentity peer1;
312 struct GNUNET_PeerIdentity peer2;
314 /* TODO: signature */
319 * Message to destroy a tunnel
321 struct GNUNET_MESH_TunnelDestroy
324 * Type: GNUNET_MESSAGE_TYPE_MESH_TUNNEL_DESTROY
326 struct GNUNET_MessageHeader header;
331 uint32_t tid GNUNET_PACKED;
336 struct GNUNET_PeerIdentity oid;
338 /* TODO: signature */
343 * Message to destroy a tunnel
345 struct GNUNET_MESH_TunnelKeepAlive
348 * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_KEEPALIVE
350 struct GNUNET_MessageHeader header;
355 uint32_t tid GNUNET_PACKED;
360 struct GNUNET_PeerIdentity oid;
365 GNUNET_NETWORK_STRUCT_END
367 #if 0 /* keep Emacsens' auto-indent happy */
374 /* ifndef MESH_PROTOCOL_H */
376 /* end of mesh_protocol.h */