//
// 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 PacketData public header */
// Custom includes
#include <boost/utility.hpp>
#include <boost/type_traits.hpp>
-#include <senf/Utils/safe_bool.hh>
#include <senf/Utils/Exception.hh>
-#include "PacketTypes.hh"
//#include "PacketData.mpp"
-///////////////////////////////hh.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
namespace senf {
Whenever the data is manipulated through PacketData, the change is assumed to be within the
data range of that packet: All insertions take place \e inside \c this packet and \e outside
- any following packets in the packet chain.
+ any following packets in the packet chain.
\warning It is not permissible to change data belonging to a following
packet/header/interpreter even though this data is part of \c this sequence. Doing so
will corrupt the packet data.
-
+
\par
\warning When accessing packet data via the PacketData interface you are on your own: The
: boost::noncopyable
{
public:
- ///////////////////////////////////////////////////////////////////////////
+ //-////////////////////////////////////////////////////////////////////////
// Types
typedef senf::detail::packet::iterator iterator;
typedef byte * pointer;
typedef byte const * const_pointer;
- ///////////////////////////////////////////////////////////////////////////
+ //-////////////////////////////////////////////////////////////////////////
///\name Structors and default members
- ///@{
+ //\{
// no public constructors
// no conversion constructors
- ///@}
- ///////////////////////////////////////////////////////////////////////////
-
+ //\}
+ //-////////////////////////////////////////////////////////////////////////
+
///\name Sequence interface to raw data
- ///@{
+ //\{
iterator begin() const; ///< Return iterator to beginning
/**< Returns an <em>random access iterator</em> referring to the
first byte of the packet data. */
- iterator end() const; ///< Return iterator to end
- /**< Returns an <em>random access iterator</em> referring to the
+ iterator end() const; ///< Return iterator to end
+ /**< Returns an <em>random access iterator</em> referring to the
byte past the end of the packet data. */
size_type size() const; ///< Returns the number of bytes in the packet data.
bool empty() const; ///< Test whether the packet data is empty.
/**< Returns whether the packet data is empty, i.e. whether its size
- is 0. This function does not modify the content of the packet
- data in any way. To clear the content use clear() */
+ is 0. This function does not modify the content of the packet
+ data in any way. To clear the content use clear() */
byte operator[](size_type n) const; ///< Access byte in the packet data
byte & operator[](size_type n); ///< Access byte in the packet data
void erase(iterator pos);
void erase(iterator first, iterator last);
void clear(); ///< All bytes of the packet data dropped, leaving the container with a size of 0. */
-
+
void resize(size_type n, byte v=0);
void reserve(size_type n);
size_type capacity() const;
- ///@}
+ //\}
protected:
PacketData(size_type b, size_type e);
byte. If the packet has been implemented correctly, this signals a malformed packet.
*/
struct TruncatedPacketException : public senf::Exception
- { TruncatedPacketException() : senf::Exception("truncated packet"){} };
+ { TruncatedPacketException() : senf::Exception("truncated packet") {} };
}
-///////////////////////////////hh.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
#endif
#if !defined(HH_SENF_Packets_Packets__decls_) && !defined(HH_SENF_Packets_PacketData_i_)
#define HH_SENF_Packets_PacketData_i_
projects / senf.git / blobdiff