-// $Id: UDPPacket.hh 308 2007-07-14 22:31:20Z g0dil $
+// $Id$
//
// Copyright (C) 2006
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
-// Stefan Bund <stefan.bund@fokus.fraunhofer.de>
+// 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
// it under the terms of the GNU General Public License as published by
// Free Software Foundation, Inc.,
// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+/** \file
+ \brief UDPPacket public header */
+
#ifndef HH_UDPPacket_
#define HH_UDPPacket_ 1
// Custom includes
-#include "Packets/PacketType.hh"
-#include "Packets/ParseInt.hh"
-#include "Packets/PacketRegistry.hh"
-#include "Packets/PacketParser.hh"
+#include "../../Packets/Packets.hh"
//#include "UDPPacket.mpp"
///////////////////////////////hh.p////////////////////////////////////////
namespace senf {
- ///\addtogroup protocolbundle_default
- ///@{
+ /** \brief Parse a UDP packet
+
+ Parser implementing the UDP header. The fields implemented are:
- // See RFC768
- struct Parse_UDP : public PacketParserBase
+ \see UDPPacketType \n
+ <a href="http://tools.ietf.org/html/rfc768">RFC 768</a>
+ */
+ struct UDPPacketParser : public PacketParserBase
{
- SENF_PACKET_PARSER_INIT(Parse_UDP);
+# include SENF_FIXED_PARSER()
+
+ SENF_PARSER_FIELD( source, senf::UInt16Parser );
+ SENF_PARSER_FIELD( destination, senf::UInt16Parser );
+ SENF_PARSER_FIELD( length, senf::UInt16Parser );
+ SENF_PARSER_FIELD( checksum, senf::UInt16Parser );
- ///////////////////////////////////////////////////////////////////////////
+ SENF_PARSER_FINALIZE(UDPPacketParser);
- typedef Parse_UInt16 Parse_16bit;
+ boost::uint16_t calcChecksum() const;
- SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS(
- ((Field)( source, Parse_16bit ))
- ((Field)( destination, Parse_16bit ))
- ((Field)( length, Parse_16bit ))
- ((Field)( crc, Parse_16bit )) );
+ bool validateChecksum() const {
+ return checksum() == 0u || checksum() == calcChecksum();
+ }
};
+ /** \brief UDP packet
+
+ \par Packet type (typedef):
+ \ref UDPPacket
+
+ \par Fields:
+ \ref UDPPacketParser
+
+ \par Finalize action:
+ Set \a length from payload size\n
+ Calculate \a checksum
+
+ \ingroup protocolbundle_default
+ */
struct UDPPacketType
: public PacketTypeBase,
public PacketTypeMixin<UDPPacketType>
{
+#ifndef DOXYGEN
typedef PacketTypeMixin<UDPPacketType> mixin;
typedef ConcretePacket<UDPPacketType> packet;
- typedef Parse_UDP parser;
-
+ typedef UDPPacketParser parser;
+#endif
using mixin::nextPacketRange;
using mixin::initSize;
using mixin::init;
static void dump(packet p, std::ostream & os);
- };
- typedef UDPPacketType::packet UDPPacket;
+ static void finalize(packet p);
+ };
- ///@}
+ /** \brief UDP packet typedef */
+ typedef ConcretePacket<UDPPacketType> UDPPacket;
}
///////////////////////////////hh.e////////////////////////////////////////
+#endif
+#ifndef SENF_PACKETS_DECL_ONLY
//#include UDPPacket.cci"
//#include "UDPPacket.ct"
//#include "UDPPacket.cti"