Packets: Fix VariantParser invalid parser access bug
[senf.git] / Packets / DataPacket.hh
index 0d4b615..fc8cd04 100644 (file)
@@ -1,6 +1,8 @@
-// Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// $Id$
+//
+// Copyright (C) 2007
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
 //     Stefan Bund <g0dil@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
@@ -21,8 +23,8 @@
 /** \file
     \brief DataPacket public header */
 
-#ifndef HH_DataPacket_
-#define HH_DataPacket_ 1
+#ifndef HH_SENF_Packets_DataPacket_
+#define HH_SENF_Packets_DataPacket_ 1
 
 // Custom includes
 #include "PacketType.hh"
 ///////////////////////////////hh.p////////////////////////////////////////
 
 namespace senf {
-    
+
+    /** \brief Generic payload-only packet
+
+        \par Packet type (typedef):
+            \ref DataPacket
+
+        DataPacket is a simple generic packet with just a payload of uninterpreted data. This is the
+        packet used whenever no more specific packet type can be found for a sub-packet (e.g. as the
+        payload data of a UDP packet)
+
+        \ingroup packet_module
+     */
     struct DataPacketType : public PacketTypeBase
-    {};
+    {
+        typedef ConcretePacket<DataPacketType> packet;
+        static void dump(packet p, std::ostream & os);
+    };
 
+    /** \brief Generic payload-only packet typedef */
     typedef ConcretePacket<DataPacketType> DataPacket;
 }
 
 ///////////////////////////////hh.e////////////////////////////////////////
 #endif
-#if !defined(SENF_PACKETS_DECL_ONLY) && !defined(HH_DataPacket_impl_)
-#define HH_DataPacket_impl_
+#if !defined(HH_SENF_Packets_Packets__decls_) && !defined(HH_SENF_Packets_DataPacket_impl_)
+#define HH_SENF_Packets_DataPacket_impl_
 //#include "DataPacket.cci"
 //#include "DataPacket.ct"
 //#include "DataPacket.cti"
@@ -58,3 +75,4 @@ namespace senf {
 // ispell-local-dictionary: "american"
 // compile-command: "scons -u test"
 // End:
+