-// Copyright (C) 2007
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// $Id$
+//
+// 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
#include <boost/utility.hpp>
#include <boost/type_traits.hpp>
#include <boost/iterator/iterator_facade.hpp>
-#include "Utils/SafeBool.hh"
+#include "../Utils/safe_bool.hh"
+#include "../Utils/Exception.hh"
#include "PacketTypes.hh"
//#include "PacketData.mpp"
///\name Sequence interface to raw data
///@{
- iterator begin() const;
- iterator end() const;
- size_type size() const;
- bool empty() const;
- byte operator[](size_type n) const;
- byte & operator[](size_type n);
+ 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
+ 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() */
+ byte operator[](size_type n) const; ///< Access byte in the packet data
+ byte & operator[](size_type n); ///< Access byte in the packet data
// Modifying the raw packet data
void erase(iterator pos);
void erase(iterator first, iterator last);
- void clear();
+ 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);
This exception is signaled whenever an operation tries to access an out-of-bounds data
byte. If the packet has been implemented correctly, this signals a malformed packet.
*/
- struct TruncatedPacketException : public std::exception
- { virtual char const * what() const throw() { return "truncated packet"; } };
+ struct TruncatedPacketException : public senf::Exception
+ { TruncatedPacketException() : senf::Exception("truncated packet"){} };
/** \brief Re-validating data iterator
: public boost::iterator_facade< safe_data_iterator,
PacketData::value_type,
boost::random_access_traversal_tag >,
- public ComparableSafeBool<safe_data_iterator>
+ public comparable_safe_bool<safe_data_iterator>
{
public:
typedef PacketData::size_type size_type;
///////////////////////////////hh.e////////////////////////////////////////
#endif
-#if !defined(SENF_PACKETS_DECL_ONLY) && !defined(HH_PacketData_i_)
+#if !defined(HH_Packets__decls_) && !defined(HH_PacketData_i_)
#define HH_PacketData_i_
#include "PacketData.cci"
//#include "PacketData.ct"