X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Packets%2FPacket.hh;h=dd913d6a59087cddf7e4f40c4b912c6f5097778c;hb=9a988902090d28007578e93bffd809f6bd913155;hp=2511c8a974da73a1c153acf3a6556987ad744507;hpb=ac6a813d9d99f7add4e13aff7a4bcd314d5604a6;p=senf.git diff --git a/Packets/Packet.hh b/Packets/Packet.hh index 2511c8a..dd913d6 100644 --- a/Packets/Packet.hh +++ b/Packets/Packet.hh @@ -1,6 +1,6 @@ // $Id$ // -// Copyright (C) 2006 +// Copyright (C) 2006 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS) // Kompetenzzentrum fuer Satelitenkommunikation (SatCom) // Stefan Bund @@ -20,25 +20,25 @@ // Free Software Foundation, Inc., // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -// TODO: Implement assign() method akin to reinterpret(). However, -// instead of using the data already present, assign() will replace -// the date of the current packet with the given Packet. +/** \file + \brief Main packet interface -// TODO: Implement wrapping-constructor. Somehow we want to have a -// constructor, which allows creating a chain of packet interpreters -// with as little overhead as possible. + \todo Implement assign() method akin to reinterpret(). However, + instead of using the data already present, assign() will replace + the date of the current packet with the given Packet. -// TODO: Document the additional concrete Packet facade requirements -// explicitly and not only within the Parser requirements (check(), -// bytes() and min_bytes() members ...) + \todo Implement wrapping-constructor. Somehow we want to have a + constructor, which allows creating a chain of packet interpreters + with as little overhead as possible. -// TODO: Implement special container replacing vector which manages -// some headroom to allow efficient insertion of elements at the -// beginning. This really is just another type of deque -// implementation. + \todo Document the additional concrete Packet facade requirements + explicitly and not only within the Parser requirements (check(), + bytes() and min_bytes() members ...) -/** \file - \brief Main packet interface + \todo Implement special container replacing vector which manages + some headroom to allow efficient insertion of elements at the + beginning. This really is just another type of dequeue + implementation. */ #ifndef HH_Packet_ @@ -57,18 +57,18 @@ // ////////////////////////////hh.p//////////////////////////////////////// namespace senf { - + namespace impl { template class PkReg_EntryImpl; } namespace impl { class PacketImpl; } /** \brief Basic interface to all packet facades \section packet_overview Overview - + This class is the base class of all Packets. It implements the generic Packet interface and provides the packet management framework. senf::Packet manages the necessary memory - resources and controlls the chain of packet interpreters. + resources and controls the chain of packet interpreters. The Packet user always interfaces with the pkf via a Packet derived class. This is the only external entity ever held by a @@ -76,16 +76,16 @@ namespace senf { counted smart pointer, so resource management is quasi automatic. - \image html "../../structure.png" Overview - + \image html structure.png Overview + Internally, every Packet references a PacketImpl instance which manages the raw packet data and the interpreter list. This raw data is interpreted by the concrete Packet derived class - according to the definition of that derived class's packet + according to the definition of that derived classes packet type (i.e. EthernetPacket or UDPPacket). Packet provides several interfaces: - + - Creation of Packet instances: create() - Access to the chain of interpreters: next(), prev(), head(), @@ -115,8 +115,8 @@ namespace senf { - You must implement a static check() method which validates a byte region as your new Packet - \code - class ExamplePacket + \code + class ExamplePacket : public senf::Packet { public: @@ -157,7 +157,7 @@ namespace senf { senf:PacketRegistry, it must not take any additional constructor parameters. - After having implemented the bare framework, the most comman + After having implemented the bare framework, the most common way to implement access to the packets specific data is to use the parser framework by additionally inheriting a corresponding parser. This also automatically implements the @@ -174,7 +174,7 @@ namespace senf { { // check does not need to be implemented here, it is - // inherited from the parser + // inherited from the parser private: template @@ -224,9 +224,9 @@ namespace senf { The Packet interface is implemented to minimize overhead as far as possible without getting to complex. One area for - improvement ist the container class used to hold the raw + improvement is the container class used to hold the raw data. This currently is an \a std::vector. This could be - imporved by either allocating some headroom/tailroom in the + improved by either allocating some headroom/tailroom in the vector and using this when inserting data at the beginning or end. Alternatively, a new container class (like the senf::deque_list) could be used to support zero-copy @@ -241,7 +241,7 @@ namespace senf { we cannot construct the \a writev() data structures. The interpreter list managed by Packet is lazy, meaning packet - interpreter facades are added only when requestd by next(), + interpreter facades are added only when requested by next(), last() or find_next(). v_nextInterpreter() is called if necessary by these methods to complete the interpreter chain. @@ -255,11 +255,13 @@ namespace senf { interpreter list to the Packet facades must not be counted. They are therefore implemented differently ( boost::shared_ptr vs. boost::intrusive_ptr). The choice of - boost::intrusive_ptr for the externaly visible smart pointer + boost::intrusive_ptr for the externally visible smart pointer for all Packet facades is taken to reduce the overhead (an intrusive_ptr is only the size of an ordinary pointer, a smart_ptr has the size of two pointers). + \fixme Make all data mutators protected + \nosubgrouping */ class Packet : boost::noncopyable @@ -290,9 +292,9 @@ namespace senf { /////////////////////////////////////////////////////////////////////////// ///\name Types ///@{ - + /** \brief smart pointer template for all Packet classes - + This struct is just a template typedef. It defines the smart pointer used for all Packet classes. */ @@ -302,11 +304,11 @@ namespace senf { Every derived class \e must redeclare this member for it's derived type: - \code + \code typedef ptr_t::ptr ptr \endcode */ - typedef ptr_t::ptr ptr; + typedef ptr_t::ptr ptr; typedef raw_container::iterator iterator; //!< raw data iterator typedef raw_container::size_type size_type; typedef raw_container::difference_type difference_type; @@ -319,7 +321,7 @@ namespace senf { ///@{ /** \brief create new Packet - + This method is used to create a new Packet. All Packet instances are created via this method, they are \e never created directly from the Packet derived class. @@ -331,7 +333,7 @@ namespace senf { \param e corresponding end iterator \return smart pointer to new packet \throws TruncatedPacketException The data cannot be parsed - securely (the data might be trunctated or just + securely (the data might be truncated or just plain invalid) */ template @@ -347,7 +349,7 @@ namespace senf { ///\name Interpreter chain ///@{ - + /** \brief get next packet from the interpreter chain \return smart pointer to next packet or 0 if last packet */ ptr next() const; @@ -360,7 +362,7 @@ namespace senf { /** \brief get last packet of the interpreter chain \return smart pointer to last packet */ ptr last() const; - + /** \brief first packet of given type after the current packet \return smart pointer to first following packet of type \a OtherPacket or 0, if no such packet exists */ @@ -379,28 +381,28 @@ namespace senf { OtherPacket. \e Assert's, that a packet of this type exists */ template typename ptr_t::ptr get_prev() const; - /** \brief check, wether the packet is of the given type - \return true, if packt is of type \a OtherPacket, false + /** \brief check, whether the packet is of the given type + \return true, if packet is of type \a OtherPacket, false otherwise */ - template bool is() const; + template bool is() const; /** \brief cast packet pointer to the given type \return a properly cast smart pointer if packet is of type \a OtherPacket. Otherwise return 0 */ - template typename ptr_t::ptr as(); + template typename ptr_t::ptr as(); /** \brief replace current packet interpreter This method will \e replace the current packet facade in the interpreter list with a new interpreter given by \a - OtherPacket. + OtherPacket. \attention This invalidates the packet instance \e - this. You must ensure, not to use the Packet instance - any further after this call + this. You must ensure, not to use the Packet instance any + further after this call \return smart pointer to a \e new packet facade \throws TruncatedPacketException there is not enough data - to savely interpret the packet as the given type. The + to safely interpret the packet as the given type. The original packet is \e not invalidated */ template @@ -411,8 +413,8 @@ namespace senf { ///\name Raw packet data ///@{ - /** \brief begin interator of raw packet data - + /** \brief begin iterator of raw packet data + This iterator allows access to the raw data interpreted by the packet facade. This \e includes any header possibly interpreted by the derived packet instance. To access the @@ -422,7 +424,7 @@ namespace senf { data */ iterator begin() const; /** \brief past-the-end iterator of raw packet data - + This iterator allows access to the raw data interpreted by the packet facade. This \e includes any header possibly interpreted by the derived packet instance. To access the @@ -439,8 +441,6 @@ namespace senf { // Modifying the raw packet data - // FIXME: Make all data mutators protected - typedef enum { AUTO, BEFORE, INSIDE, OUTSIDE, AFTER } Whence; /** \brief insert single byte \a v before pos @@ -463,7 +463,7 @@ namespace senf { derived packet instance. This method is mostly to be used by the derived class implementation and their helper classes. */ - template + template void insert(iterator pos, InputIterator f, InputIterator l, Whence whence = AUTO); /** \brief erase single byte @@ -490,7 +490,7 @@ namespace senf { ///@{ /** \brief create new interpreter facade for an existing packet - + This constructor is called, when a new interpreter is to be added to the interpreter chain. The constructor is called indirectly from registerInterpreter() or @@ -500,7 +500,7 @@ namespace senf { template Packet(Operation const & arg); virtual ~Packet(); - + private: /** \brief create next packet interpreter @@ -526,10 +526,10 @@ namespace senf { This method is called by the packet framework to let the interpreter facade do some final calculations/packet cleanup before the packet is sent out or digested in some - other way. This is the place to calcaulate checksums and + other way. This is the place to calculate checksums and such. - This method is autmatically called for all interpreters on + This method is automatically called for all interpreters on the interpreter chain. */ virtual void v_finalize() = 0; @@ -571,16 +571,16 @@ namespace senf { bool release(); bool unlink(); - struct PacketOp_register; - friend class PacketOp_register; + struct PacketOp_register; + friend class PacketOp_register; void i_registerInterpreter(Packet * p) const; - struct PacketOp_replace; - friend class PacketOp_replace; + struct PacketOp_replace; + friend class PacketOp_replace; void i_replaceInterpreter(Packet * p); - struct PacketOp_set; - friend class PacketOp_set; + struct PacketOp_set; + friend class PacketOp_set; void i_setInterpreter(impl::PacketImpl * i); private: @@ -624,5 +624,8 @@ namespace senf { // Local Variables: // mode: c++ +// fill-column: 100 // c-file-style: "senf" +// indent-tabs-mode: nil +// ispell-local-dictionary: "american" // End: