-// 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"
namespace senf {
- /** \brief
+ /** \brief Packet data STL-sequence view
+
+ The PacketData class provides an STL-sequence compatible view of the raw packet data. Each
+ packet/header/interpreter in the chain references the same storage area, presenting a
+ different (but nested/overlapping) section of the data.
+
+ 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.
+
+ \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
+ packet is not validated in any way, you bypass all parsers.
+
+ All public members are those of an STL random-access sequence.
- PacketData only exists to separate out the container interface from PacketInterpreter.
+ \implementation This class is very tightly integrated with PacketInterpreterBase /
+ PacketInterpreter. It is separated out of those classes primarily to provide a clean
+ sequence interface to the library user and not for implementation reasons (it would have
+ been simpler to implement all these members in PacketInterpreterBase).
+
+ \ingroup packet_module
*/
class PacketData
: boost::noncopyable
///////////////////////////////////////////////////////////////////////////
// Types
- typedef senf::detail::packet::smart_pointer<PacketData>::ptr_t ptr;
-
typedef senf::detail::packet::iterator iterator;
typedef senf::detail::packet::const_iterator const_iterator;
typedef senf::detail::packet::size_type size_type;
///\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);
///@}
- bool valid();
-
protected:
PacketData(size_type b, size_type e);
+ /// Need to make this protected so we can change it in the derived class
detail::PacketImpl * impl_;
detail::PacketImpl & impl() const;
+ bool valid();
+
private:
size_type begin_;
size_type end_;
class PacketParserBase;
- struct TruncatedPacketException : public std::exception
- { virtual char const * what() const throw() { return "truncated packet"; } };
+ /** \brief Invalid packet data access
- 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;
+ 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"){} };
- bool boolean_test() const;
-
- 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(HH_PacketData_DeclOnly) &&!defined(HH_PacketData_def)
-#define HH_PacketData_def
+#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"
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// comment-column: 40
// End:
+
projects / senf.git / blobdiff