-// 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
/** \file
\brief PacketData public header */
-#ifndef HH_PacketData_
-#define HH_PacketData_ 1
+#ifndef HH_SENF_Packets_PacketData_
+#define HH_SENF_Packets_PacketData_ 1
// Custom includes
#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
// only academic since what should an empty packet be good for ?
void insert(iterator pos, byte v);
void insert(iterator pos, size_type n, byte v);
+# ifndef DOXYGEN
template <class InputIterator>
void insert(iterator pos, InputIterator f, InputIterator l,
typename boost::disable_if< boost::is_convertible<InputIterator,size_type> >::type * = 0);
+# else
+ template <class InputIterator>
+ void insert(iterator pos, InputIterator f, InputIterator l);
+# endif
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);
+ void reserve(size_type n);
+ size_type capacity() const;
+
///@}
protected:
class PacketParserBase;
- struct TruncatedPacketException : public std::exception
- { virtual char const * what() const throw() { return "truncated packet"; } };
-
- class safe_data_iterator
- : public boost::iterator_facade< safe_data_iterator,
- PacketData::value_type,
- boost::random_access_traversal_tag >,
- public ComparableSafeBool<safe_data_iterator>
- {
- public:
- typedef PacketData::size_type size_type;
-
- safe_data_iterator();
- explicit safe_data_iterator(PacketData & data);
- safe_data_iterator(PacketData & data, PacketData::iterator i);
- explicit safe_data_iterator(PacketParserBase const & parser);
-
- safe_data_iterator & operator=(PacketData::iterator i);
- safe_data_iterator & operator=(PacketParserBase const & parser);
- operator PacketData::iterator() const;
+ /** \brief Invalid packet data access
- bool boolean_test() const;
+ 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 senf::Exception
+ { TruncatedPacketException() : senf::Exception("truncated packet"){} };
- PacketData & data() const;
-
- private:
- friend class boost::iterator_core_access;
-
- // iterator_facade interface
-
- value_type & dereference() const;
- bool equal(safe_data_iterator const & other) const;
- difference_type distance_to(safe_data_iterator const & other) const;
- void increment();
- void decrement();
- void advance(difference_type n);
-
- PacketData::iterator i() const;
-
- PacketData * data_;
- size_type i_;
- };
}
///////////////////////////////hh.e////////////////////////////////////////
#endif
-#if !defined(SENF_PACKETS_DECL_ONLY) && !defined(HH_PacketData_i_)
-#define HH_PacketData_i_
+#if !defined(HH_SENF_Packets_Packets__decls_) && !defined(HH_SENF_Packets_PacketData_i_)
+#define HH_SENF_Packets_PacketData_i_
#include "PacketData.cci"
//#include "PacketData.ct"
#include "PacketData.cti"
// comment-column: 40
// End:
-// LocalWords: Fraunhofer Institut fuer offene Kommunikationssysteme FOKUS de
-// LocalWords: Kompetenzzentrum Satelitenkommunikation SatCom Bund berlios dil
-// LocalWords: PacketData hh STL PacketInterpreterBase PacketInterpreter
-// LocalWords: ingroup Structors