//
// 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
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation; either version 2 of the License, or
-// (at your option) any later version.
+// The contents of this file are subject to the Fraunhofer FOKUS Public License
+// Version 1.0 (the "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+// http://senf.berlios.de/license.html
//
-// This program 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.
+// The Fraunhofer FOKUS Public License Version 1.0 is based on,
+// but modifies the Mozilla Public License Version 1.1.
+// See the full license text for the amendments.
//
-// You should have received a copy of the GNU General Public License
-// along with this program; if not, write to the
-// Free Software Foundation, Inc.,
-// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+// Software distributed under the License is distributed on an "AS IS" basis,
+// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+// for the specific language governing rights and limitations under the License.
+//
+// The Original Code is Fraunhofer FOKUS code.
+//
+// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
+// (registered association), Hansastraße 27 c, 80686 Munich, Germany.
+// All Rights Reserved.
+//
+// Contributor(s):
+// Stefan Bund <g0dil@berlios.de>
/** \file
\brief Packet public header */
#include "PacketInterpreter.hh"
//#include "Packet.mpp"
-///////////////////////////////hh.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
namespace senf {
template <class PackeType> class ConcretePacket;
///\addtogroup packet_module
- ///@{
+ //\{
/** \brief Main %Packet class
public boost::equality_comparable<Packet>
{
public:
- ///////////////////////////////////////////////////////////////////////////
+ //-////////////////////////////////////////////////////////////////////////
// Types
typedef void type; ///< Type of the packet.
///< Unsigned type to represent packet size
typedef PacketInterpreterBase::factory_t factory_t; ///< Packet factory type (see below)
- ///////////////////////////////////////////////////////////////////////////
+ //-////////////////////////////////////////////////////////////////////////
///\name Structors and default members
- ///@{
+ //\{
// default copy constructor
// default copy assignment
validity. */
Packet clone() const; ///< Create copy packet
/**< clone() will create a complete copy of \c this
- packet. The returned packet will have the same data and
- packet chain. It does however not share any data with
- the original packet. */
+ packet. The returned packet will have the same data,
+ annotations and packet chain. It does however not
+ share any data with the original packet. */
// conversion constructors
ConcretePacket into a general Packet, loosing the
protocol specific interface. */
- ///@}
- ///////////////////////////////////////////////////////////////////////////
+ //\}
+ //-////////////////////////////////////////////////////////////////////////
///\name Interpreter chain access
- ///@{
+ //\{
Packet next() const; ///< Get next packet in chain
/**< \throws InvalidPacketChainException if no next packet
/**< This member will throw away the packet chain after the
current packet. The payload will be reparsed
automatically when calling next() */
- ///@}
+ //\}
///\name Data access
- ///@{
+ //\{
PacketData & data() const; ///< Access the packets raw data container
size_type size() const; ///< Return size of packet in bytes
/**< This size does \e not include the size of any preceding
headers/packets/interpreters. It does however include
\c this packets payload. */
- ///@}
+ //\}
///\name Annotations
- ///@{
+ //\{
template <class Annotation>
Annotation & annotation(); ///< Get packet annotation
the annotations equates to a new created %packet.
\warning all references to existing complex
annotations become invalid. */
- ///@}
+ //\}
///\name Other methods
- ///@{
+ //\{
bool operator==(Packet const & other) const; ///< Check for packet identity
/**< Two packet handles compare equal if they really are the
backwards towards outer packets up to \c this. */
void finalizeAll(); ///< Update calculated fields
- /**< The finalize() fammily of members will update
+ /**< The finalize() family of members will update
calculated packet fields: checksums, size fields and so
on. This includes any field, which can be set from
other information in the packet. Each concrete packet
/**< This method returns true if there is any other packet
handle pointing to any header in the packet chain. */
- ///@}
+ //\}
protected:
explicit Packet(PacketInterpreterBase::ptr const & packet);
: public Packet
{
public:
- ///////////////////////////////////////////////////////////////////////////
+ //-////////////////////////////////////////////////////////////////////////
// Types
typedef PacketType type;
typedef typename PacketType::parser Parser;
- ///////////////////////////////////////////////////////////////////////////
+ //-////////////////////////////////////////////////////////////////////////
///\name Structors and default members
- ///@{
+ //\{
// default copy constructor
// default copy assignment
packet */
static ConcretePacket createInsertBefore(Packet const & packet, senf::NoInit_t);
///< Insert uninitialized empty packet before \a packet
- /**< Inserts a completely empty and unitialized packet
+ /**< Inserts a completely empty and uninitialized packet
before \a packet into the header/interpreter chain.
\param[in] packet Packet before which to insert the new
packet */
ConcretePacket clone() const;
- ///@}
- ///////////////////////////////////////////////////////////////////////////
+ //\}
+ //-////////////////////////////////////////////////////////////////////////
// Field access
template <class PacketType, class Parser>
Parser operator<<(Parser target, ConcretePacket<PacketType> const & packet);
- ///@}
+ //\}
}
-///////////////////////////////hh.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
#endif
#if !defined(HH_SENF_Packets_Packets__decls_) && !defined(HH_SENF_Packets_Packet_i_)
#define HH_SENF_Packets_Packet_i_
projects / senf.git / blobdiff