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_NOBUFFER 0x2
41 /******************************************************************************/
42 /******************** MESH NETWORK MESSAGES **************************/
43 /******************************************************************************/
45 GNUNET_NETWORK_STRUCT_BEGIN
48 * Message for mesh path creation.
50 struct GNUNET_MESH_CreateTunnel
53 * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_CREATE
55 * Size: sizeof(struct GNUNET_MESH_ManipulatePath) +
56 * path_length * sizeof (struct GNUNET_PeerIdentity)
58 struct GNUNET_MessageHeader header;
61 * Global id of the tunnel this path belongs to,
62 * unique in conjunction with the origin.
64 uint32_t tid GNUNET_PACKED;
67 * Tunnel options (MESH_TUNNEL_OPT_*).
69 uint32_t opt GNUNET_PACKED;
74 uint32_t port GNUNET_PACKED;
77 * FIXME do not add the first hop
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 path destruction.
87 struct GNUNET_MESH_DestroyTunnel
90 * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_DESTROY
92 * Size: sizeof(struct GNUNET_MESH_ManipulatePath) +
93 * path_length * sizeof (struct GNUNET_PeerIdentity)
95 struct GNUNET_MessageHeader header;
98 * Global id of the tunnel this path belongs to,
99 * unique in conjunction with the origin.
101 uint32_t tid GNUNET_PACKED;
106 * Message for mesh data traffic.
108 struct GNUNET_MESH_Data
111 * Type: GNUNET_MESSAGE_TYPE_MESH_UNICAST,
112 * GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN
114 struct GNUNET_MessageHeader header;
119 uint32_t tid GNUNET_PACKED;
122 * Number of hops to live
124 uint32_t ttl GNUNET_PACKED;
127 * Unique ID of the packet
129 uint32_t pid GNUNET_PACKED;
134 struct GNUNET_PeerIdentity oid;
143 * Message to acknowledge mesh data traffic.
145 struct GNUNET_MESH_ACK
148 * Type: GNUNET_MESSAGE_TYPE_MESH_ACK
150 struct GNUNET_MessageHeader header;
155 uint32_t tid GNUNET_PACKED;
160 struct GNUNET_PeerIdentity oid;
163 * Maximum packet ID authorized.
170 * Message to query a peer about its Flow Control status regarding a tunnel.
172 struct GNUNET_MESH_Poll
175 * Type: GNUNET_MESSAGE_TYPE_MESH_POLL
177 struct GNUNET_MessageHeader header;
182 uint32_t tid GNUNET_PACKED;
187 struct GNUNET_PeerIdentity oid;
191 * Message for ack'ing a path
193 struct GNUNET_MESH_PathACK
196 * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_ACK
198 struct GNUNET_MessageHeader header;
203 uint32_t tid GNUNET_PACKED;
208 struct GNUNET_PeerIdentity oid;
213 struct GNUNET_PeerIdentity peer_id;
216 * Initial ACK value for payload.
218 uint32_t ack GNUNET_PACKED;
220 /* TODO: signature */
225 * Message for notifying a disconnection in a path
227 struct GNUNET_MESH_PathBroken
230 * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_BROKEN
232 struct GNUNET_MessageHeader header;
237 uint32_t tid GNUNET_PACKED;
242 struct GNUNET_PeerIdentity oid;
247 struct GNUNET_PeerIdentity peer1;
252 struct GNUNET_PeerIdentity peer2;
254 /* TODO: signature */
259 * Message to destroy a tunnel
261 struct GNUNET_MESH_TunnelDestroy
264 * Type: GNUNET_MESSAGE_TYPE_MESH_TUNNEL_DESTROY
266 struct GNUNET_MessageHeader header;
271 uint32_t tid GNUNET_PACKED;
276 struct GNUNET_PeerIdentity oid;
278 /* TODO: signature */
283 * Message to destroy a tunnel
285 struct GNUNET_MESH_TunnelKeepAlive
288 * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_KEEPALIVE
290 struct GNUNET_MessageHeader header;
295 uint32_t tid GNUNET_PACKED;
300 struct GNUNET_PeerIdentity oid;
305 GNUNET_NETWORK_STRUCT_END
307 #if 0 /* keep Emacsens' auto-indent happy */
314 /* ifndef MESH_PROTOCOL_H */
316 /* end of mesh_protocol.h */