senf/Packets/DataPacket.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief DataPacket public header */
  25
  26 #ifndef HH_SENF_Packets_DataPacket_
  27 #define HH_SENF_Packets_DataPacket_ 1
  28
  29 // Custom includes
  30 #include "PacketType.hh"
  31 #include "Packet.hh"
  32
  33 //#include "DataPacket.mpp"
  34 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  35
  36 namespace senf {
  37
  38     /** \brief Generic payload-only packet
  39
  40         \par Packet type (typedef):
  41             \ref DataPacket
  42
  43         DataPacket is a simple generic packet with just a payload of uninterpreted data. This is the
  44         packet used whenever no more specific packet type can be found for a sub-packet (e.g. as the
  45         payload data of a UDP packet)
  46
  47         \ingroup packet_module
  48      */
  49     struct DataPacketType : public PacketTypeBase
  50     {
  51         typedef ConcretePacket<DataPacketType> packet;
  52         static void dump(packet p, std::ostream & os);
  53     };
  54
  55     /** \brief Generic payload-only packet typedef */
  56     typedef ConcretePacket<DataPacketType> DataPacket;
  57 }
  58
  59 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  60 #endif
  61 #if !defined(HH_SENF_Packets_Packets__decls_) && !defined(HH_SENF_Packets_DataPacket_impl_)
  62 #define HH_SENF_Packets_DataPacket_impl_
  63 //#include "DataPacket.cci"
  64 //#include "DataPacket.ct"
  65 //#include "DataPacket.cti"
  66 #endif
  67
  68 \f
  69 // Local Variables:
  70 // mode: c++
  71 // fill-column: 100
  72 // comment-column: 40
  73 // c-file-style: "senf"
  74 // indent-tabs-mode: nil
  75 // ispell-local-dictionary: "american"
  76 // compile-command: "scons -u test"
  77 // End:
  78