senf/Packets/DataPacket.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Stefan Bund <g0dil@berlios.de>
  27
  28 /** \file
  29     \brief DataPacket public header */
  30
  31 #ifndef HH_SENF_Packets_DataPacket_
  32 #define HH_SENF_Packets_DataPacket_ 1
  33
  34 // Custom includes
  35 #include "PacketType.hh"
  36 #include "Packet.hh"
  37
  38 //#include "DataPacket.mpp"
  39 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  40
  41 namespace senf {
  42
  43     /** \brief Generic payload-only packet
  44
  45         \par Packet type (typedef):
  46             \ref DataPacket
  47
  48         DataPacket is a simple generic packet with just a payload of uninterpreted data. This is the
  49         packet used whenever no more specific packet type can be found for a sub-packet (e.g. as the
  50         payload data of a UDP packet)
  51
  52         \ingroup packet_module
  53      */
  54     struct DataPacketType : public PacketTypeBase
  55     {
  56         typedef ConcretePacket<DataPacketType> packet;
  57         static void dump(packet p, std::ostream & os);
  58     };
  59
  60     /** \brief Generic payload-only packet typedef */
  61     typedef ConcretePacket<DataPacketType> DataPacket;
  62 }
  63
  64 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  65 #endif
  66 #if !defined(HH_SENF_Packets_Packets__decls_) && !defined(HH_SENF_Packets_DataPacket_impl_)
  67 #define HH_SENF_Packets_DataPacket_impl_
  68 //#include "DataPacket.cci"
  69 //#include "DataPacket.ct"
  70 //#include "DataPacket.cti"
  71 #endif
  72
  73 \f
  74 // Local Variables:
  75 // mode: c++
  76 // fill-column: 100
  77 // comment-column: 40
  78 // c-file-style: "senf"
  79 // indent-tabs-mode: nil
  80 // ispell-local-dictionary: "american"
  81 // compile-command: "scons -u test"
  82 // End:
  83