X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Packets%2FPacketData.hh;h=96db5b14fb4fe1ef3a6e233e116cd7903c41ee5a;hb=ef4c5558d6a52367bd7040530d40c7616f6f5b71;hp=8d94d9c687b1c522147a3bbf4c6a4fc2327a7ea1;hpb=2d6585ff852e9d282c17003ba1db0b73eb3a8500;p=senf.git diff --git a/Packets/PacketData.hh b/Packets/PacketData.hh index 8d94d9c..96db5b1 100644 --- a/Packets/PacketData.hh +++ b/Packets/PacketData.hh @@ -1,6 +1,8 @@ -// 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 // // This program is free software; you can redistribute it and/or modify @@ -28,7 +30,8 @@ #include #include #include -#include "Utils/SafeBool.hh" +#include "../Utils/safe_bool.hh" +#include "../Utils/Exception.hh" #include "PacketTypes.hh" //#include "PacketData.mpp" @@ -95,12 +98,19 @@ namespace senf { ///\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 random access iterator referring to the + first byte of the packet data. */ + iterator end() const; ///< Return iterator to end + /**< Returns an random access iterator 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 @@ -109,13 +119,18 @@ namespace senf { // 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 void insert(iterator pos, InputIterator f, InputIterator l, typename boost::disable_if< boost::is_convertible >::type * = 0); +# else + template + 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); @@ -140,30 +155,57 @@ namespace senf { class PacketParserBase; - struct TruncatedPacketException : public std::exception - { virtual char const * what() const throw() { return "truncated packet"; } }; + /** \brief Invalid packet data access + + 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"){} }; + /** \brief Re-validating data iterator + + This class is a wrapper around a PacketData::iterator instance. It will revalidate the + iterator on every access. This keeps the iterator valid even when the data container is + resized and thereby possibly relocated. The iterator will always point to the byte at the + same offset from the packets beginning. If data is inserted before this iterators position, + the data pointed to will of course change. + + For this to work, the safe_data_iterator must be initialized with the container to which the + iterator belongs. After this initialization it can be used like any other iterator. + */ class safe_data_iterator : public boost::iterator_facade< safe_data_iterator, PacketData::value_type, boost::random_access_traversal_tag >, - public ComparableSafeBool + public comparable_safe_bool { public: typedef PacketData::size_type size_type; - safe_data_iterator(); - explicit safe_data_iterator(PacketData & data); + safe_data_iterator(); ///< Make uninitialized iterator + explicit safe_data_iterator(PacketData & data); + ///< Construct iterator only setting the data container safe_data_iterator(PacketData & data, PacketData::iterator i); + ///< Initialize iterator to given position explicit safe_data_iterator(PacketParserBase const & parser); + ///< Initialize iterator from parser + /**< The iterator will point to the parsers start + position. */ - safe_data_iterator & operator=(PacketData::iterator i); + safe_data_iterator & operator=(PacketData::iterator i); ///< Assign iterator + /**< The iteator \a i must be from the container wo which \c + this iterator has been initialized. */ safe_data_iterator & operator=(PacketParserBase const & parser); - operator PacketData::iterator() const; + ///< Assign iterator from parser + /**< The iterator will point to the parser start + position. */ + + operator PacketData::iterator() const; ///< Convert to iterator - bool boolean_test() const; + bool boolean_test() const; ///< Check, if iterator is initialized - PacketData & data() const; + PacketData & data() const; ///< Access data container private: friend class boost::iterator_core_access; @@ -186,7 +228,7 @@ namespace senf { ///////////////////////////////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" @@ -204,7 +246,3 @@ namespace senf { // 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