Separated structs used in network protocol into new file, as recommended in HACKING...

diff --git a/src/mesh/gnunet-service-mesh.c b/src/mesh/gnunet-service-mesh.c
index 14b74905a7de33d35b081890646a273be8b95971..faed1ac01759a3a831eabf0ea45ae8111fb5942c 100644 (file)
--- a/src/mesh/gnunet-service-mesh.c
+++ b/src/mesh/gnunet-service-mesh.c
@@ -24,7 +24,6 @@
  * @author Bartlomiej Polot
  *
  * STRUCTURE:
- * - MESH NETWORK MESSAGES
  * - DATA STRUCTURES
  * - GLOBAL VARIABLES
  * - MESH NETWORK HANDLES
@@ -47,162 +46,9 @@
 #include "gnunet_protocols.h"
 
 #include "mesh.h"
+#include "mesh_protocol.h"
 #include "gnunet_dht_service.h"
 
-/******************************************************************************/
-/********************      MESH NETWORK MESSAGES     **************************/
-/******************************************************************************/
-
-/**
- * Message for mesh path management
- */
-struct GNUNET_MESH_ManipulatePath
-{
-    /**
-     * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_[CREATE|CHANGE|ADD|DEL]
-     *
-     * Size: sizeof(struct GNUNET_MESH_ManipulatePath) +
-     *       path_length * sizeof (struct GNUNET_PeerIdentity)
-     */
-    struct GNUNET_MessageHeader header;
-
-    /**
-     * Global id of the tunnel this path belongs to,
-     * unique in conjunction with the origin.
-     */
-    uint32_t tid GNUNET_PACKED;
-
-    /**
-     * Information about speed requirements.  If the tunnel cannot sustain the 
-     * minimum bandwidth, packets are to be dropped.
-     */
-    uint32_t speed_min GNUNET_PACKED;
-
-    /**
-     * 64-bit alignment.
-     */
-    uint32_t reserved GNUNET_PACKED;
-
-    /**
-     * path_length structs defining the *whole* path from the origin [0] to the
-     * final destination [path_length-1].
-     */
-    /* struct GNUNET_PeerIdentity peers[path_length]; */
-};
-
-/**
- * Message for mesh data traffic to all tunnel targets.
- */
-struct GNUNET_MESH_OriginMulticast
-{
-    /**
-     * Type: GNUNET_MESSAGE_TYPE_DATA_MULTICAST
-     */
-    struct GNUNET_MessageHeader header;
-
-    /**
-     * TID of the tunnel
-     */
-    uint32_t tid GNUNET_PACKED;
-
-    /**
-     * OID of the tunnel
-     */
-    struct GNUNET_PeerIdentity oid;
-
-    /**
-     * Payload follows
-     */
-};
-
-
-/**
- * Message for mesh data traffic to a particular destination from origin.
- */
-struct GNUNET_MESH_DataMessageFromOrigin
-{
-    /**
-     * Type: GNUNET_MESSAGE_TYPE_DATA_MESSAGE_FROM_ORIGIN
-     */
-    struct GNUNET_MessageHeader header;
-
-    /**
-     * TID of the tunnel
-     */
-    uint32_t tid GNUNET_PACKED;
-
-    /**
-     * OID of the tunnel
-     */
-    struct GNUNET_PeerIdentity oid;
-
-    /**
-     * Destination.
-     */
-    struct GNUNET_PeerIdentity destination;
-
-    /**
-     * Payload follows
-     */
-};
-
-
-/**
- * Message for mesh data traffic from a tunnel participant to origin.
- */
-struct GNUNET_MESH_DataMessageToOrigin
-{
-    /**
-     * Type: GNUNET_MESSAGE_TYPE_DATA_MESSAGE_TO_ORIGIN
-     */
-    struct GNUNET_MessageHeader header;
-
-    /**
-     * TID of the tunnel
-     */
-    uint32_t tid GNUNET_PACKED;
-
-    /**
-     * OID of the tunnel
-     */
-    struct GNUNET_PeerIdentity oid;
-
-    /**
-     * Sender of the message.
-     */
-    struct GNUNET_PeerIdentity sender;
-
-    /**
-     * Payload follows
-     */
-};
-
-/**
- * Message for mesh flow control
- */
-struct GNUNET_MESH_SpeedNotify
-{
-    /**
-     * Type: GNUNET_MESSAGE_TYPE_DATA_SPEED_NOTIFY
-     */
-    struct GNUNET_MessageHeader header;
-
-    /**
-     * TID of the tunnel
-     */
-    uint32_t tid GNUNET_PACKED;
-
-    /**
-     * OID of the tunnel
-     */
-    struct GNUNET_PeerIdentity oid;
-
-    /**
-     * Slowest link down the path (above minimum speed requirement).
-     */
-    uint32_t speed_min;
-
-};
 
 /******************************************************************************/
 /************************      DATA STRUCTURES     ****************************/

diff --git a/src/mesh/mesh_protocol.h b/src/mesh/mesh_protocol.h
new file mode 100644 (file)
index 0000000..50bb50b
--- /dev/null
+++ b/src/mesh/mesh_protocol.h
@@ -0,0 +1,201 @@
+/*
+     This file is part of GNUnet.
+     (C) 2001 - 2011 Christian Grothoff (and other contributing authors)
+
+     GNUnet is free software; you can redistribute it and/or modify
+     it under the terms of the GNU General Public License as published
+     by the Free Software Foundation; either version 3, or (at your
+     option) any later version.
+
+     GNUnet is distributed in the hope that it will be useful, but
+     WITHOUT ANY WARRANTY; without even the implied warranty of
+     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+     General Public License for more details.
+
+     You should have received a copy of the GNU General Public License
+     along with GNUnet; see the file COPYING.  If not, write to the
+     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+     Boston, MA 02111-1307, USA.
+*/
+
+/**
+ * @author Bartlomiej Polot
+ * @file mesh/mesh_protocol.h
+ */
+
+#ifndef MESH_PROTOCOL_H_
+#define MESH_PROTOCOL_H_
+
+#ifdef __cplusplus
+extern "C"
+{
+#if 0                           /* keep Emacsens' auto-indent happy */
+}
+#endif
+#endif
+
+/******************************************************************************/
+/********************      MESH NETWORK MESSAGES     **************************/
+/******************************************************************************/
+
+/**
+ * Message for mesh path management
+ */
+struct GNUNET_MESH_ManipulatePath
+{
+    /**
+     * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_[CREATE|CHANGE|ADD|DEL]
+     *
+     * Size: sizeof(struct GNUNET_MESH_ManipulatePath) +
+     *       path_length * sizeof (struct GNUNET_PeerIdentity)
+     */
+    struct GNUNET_MessageHeader header;
+
+    /**
+     * Global id of the tunnel this path belongs to,
+     * unique in conjunction with the origin.
+     */
+    uint32_t tid GNUNET_PACKED;
+
+    /**
+     * Information about speed requirements.  If the tunnel cannot sustain the 
+     * minimum bandwidth, packets are to be dropped.
+     */
+    uint32_t speed_min GNUNET_PACKED;
+
+    /**
+     * 64-bit alignment.
+     */
+    uint32_t reserved GNUNET_PACKED;
+
+    /**
+     * path_length structs defining the *whole* path from the origin [0] to the
+     * final destination [path_length-1].
+     */
+    /* struct GNUNET_PeerIdentity peers[path_length]; */
+};
+
+/**
+ * Message for mesh data traffic to all tunnel targets.
+ */
+struct GNUNET_MESH_OriginMulticast
+{
+    /**
+     * Type: GNUNET_MESSAGE_TYPE_DATA_MULTICAST
+     */
+    struct GNUNET_MessageHeader header;
+
+    /**
+     * TID of the tunnel
+     */
+    uint32_t tid GNUNET_PACKED;
+
+    /**
+     * OID of the tunnel
+     */
+    struct GNUNET_PeerIdentity oid;
+
+    /**
+     * Payload follows
+     */
+};
+
+
+/**
+ * Message for mesh data traffic to a particular destination from origin.
+ */
+struct GNUNET_MESH_DataMessageFromOrigin
+{
+    /**
+     * Type: GNUNET_MESSAGE_TYPE_DATA_MESSAGE_FROM_ORIGIN
+     */
+    struct GNUNET_MessageHeader header;
+
+    /**
+     * TID of the tunnel
+     */
+    uint32_t tid GNUNET_PACKED;
+
+    /**
+     * OID of the tunnel
+     */
+    struct GNUNET_PeerIdentity oid;
+
+    /**
+     * Destination.
+     */
+    struct GNUNET_PeerIdentity destination;
+
+    /**
+     * Payload follows
+     */
+};
+
+
+/**
+ * Message for mesh data traffic from a tunnel participant to origin.
+ */
+struct GNUNET_MESH_DataMessageToOrigin
+{
+    /**
+     * Type: GNUNET_MESSAGE_TYPE_DATA_MESSAGE_TO_ORIGIN
+     */
+    struct GNUNET_MessageHeader header;
+
+    /**
+     * TID of the tunnel
+     */
+    uint32_t tid GNUNET_PACKED;
+
+    /**
+     * OID of the tunnel
+     */
+    struct GNUNET_PeerIdentity oid;
+
+    /**
+     * Sender of the message.
+     */
+    struct GNUNET_PeerIdentity sender;
+
+    /**
+     * Payload follows
+     */
+};
+
+/**
+ * Message for mesh flow control
+ */
+struct GNUNET_MESH_SpeedNotify
+{
+    /**
+     * Type: GNUNET_MESSAGE_TYPE_DATA_SPEED_NOTIFY
+     */
+    struct GNUNET_MessageHeader header;
+
+    /**
+     * TID of the tunnel
+     */
+    uint32_t tid GNUNET_PACKED;
+
+    /**
+     * OID of the tunnel
+     */
+    struct GNUNET_PeerIdentity oid;
+
+    /**
+     * Slowest link down the path (above minimum speed requirement).
+     */
+    uint32_t speed_min;
+
+};
+
+#if 0                           /* keep Emacsens' auto-indent happy */
+{
+#endif
+#ifdef __cplusplus
+}
+#endif
+
+/* ifndef MES_PROTOCOL_H */
+#endif
+/* end of mesh_protocol.h */