Packets/Packet.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief Packet public header */
  25
  26 #ifndef HH_Packet_
  27 #define HH_Packet_ 1
  28
  29 // Custom includes
  30 #include <boost/operators.hpp>
  31
  32 #include "../Utils/Exception.hh"
  33 #include "../Utils/safe_bool.hh"
  34 #include "PacketInterpreter.hh"
  35
  36 //#include "Packet.mpp"
  37 ///////////////////////////////hh.p////////////////////////////////////////
  38
  39 namespace senf {
  40
  41     /** \defgroup packet_module Packet Handling
  42
  43         The basic groundwork of the Packet library is the packet handling:
  44
  45         \li The packet classes provide access to a chain of packet headers (more generically called
  46             interpreters).
  47         \li They automatically manage the required memory resources and the shared packet data.
  48
  49         \section packet_module_chain The Interpreter Chain
  50
  51         The central data structure for a packet is the interpreter chain
  52
  53         \image html structure.png The Interpreter Chain
  54
  55         This image depicts a packet with several headers. Each interpreter is responsible for a
  56         specific sub-range of the complete packet. This range always \e includes the packets payload
  57         (This is, why we call the data structure interpreter and not header: The interpreter is
  58         responsible for interpreting a range of the packet according to a specific protocol), the
  59         packet interpreters are nested inside each other.
  60
  61         For each interpreter, this structure automatically divides the packet into three areas (each
  62         of which are optional): The header, the payload and the trailer. Every packet will have
  63         either a header or a payload section while most don't have a trailer.
  64
  65         As user of the library you always interact with the chain through one (or more) of the
  66         interpreters. The interpreter provides methods to traverse to the following or preceding
  67         header (interpreter) and provides two levels of access to the packet data: Generic low-level
  68         access in the form of an STL compatible sequence and access to the parsed fields which are
  69         provided by the parser associated with the concrete packet type.
  70
  71         \section packet_module_management Resource Management
  72
  73         The interface to the packet library is provided using a handle class (\ref Packet for
  74         generic, protocol agnostic access and \ref ConcretePacket derived from \ref Packet to access
  75         a specific protocol). This handle automatically manages the resources associated with the
  76         packet (the interpreter chain and the data storage holding the packet data). The resources
  77         are automatically released when the last packet handle referencing a specific packet is
  78         destroyed.
  79
  80         \implementation The packet chain is provided on two levels: The internal representation \ref
  81             PacketInterpreterBase and \ref PacketInterpreter which are referenced by the Handle
  82             classes \ref Packet and \ref ConcretePacket. \n
  83             The internal representation classes are pertinent in the sense, that they exist
  84             regardless of the existence of a handle referencing them (as long as the packet
  85             exists). Still the interpreter chain is lazy and packet interpreters beside the first
  86             are only created dynamically when accessed (this is implemented in the handle not in the
  87             internal representation). \n
  88             The packet interpreters make use of a pool allocator. This provides extremely efficient
  89             creation and destruction of packet interpreter's and removes the dynamic memory
  90             management overhead from the packet interpreter management. The packet implementation
  91             class (\ref PacketImpl which holds the packet data itself) however is still dynamically
  92             managed (however there is only a single instance for each packet).
  93      */
  94
  95     template <class PackeType> class ConcretePacket;
  96
  97     ///\addtogroup packet_module
  98     ///@{
  99
 100     /** \brief Main Packet class
 101
 102         Packet is the main externally visible class of the packet library. Packet is a handle into
 103         the internal packet representation. From Packet you may access the data of that specific
 104         sub-packet/header/interpreter and navigate to the neighboring
 105         sub-packets/headers/interpreters.
 106
 107         Packet is protocol agnostic. This class only provides non-protocol dependent members. To
 108         access the protocol specific features of a packet (like header fields) the ConcretePacket
 109         class extending Packet is provided.
 110
 111         \section packet_semantics Semantics
 112
 113         All operations accessing the data of \c this packet in some way will ignore any preceding
 114         packets/headers/interpreters in the chain. It does not matter, whether a given packet is
 115         taken from the middle or the beginning of the chain, all operations (except those explicitly
 116         accessing the chain of course) should work the same.
 117
 118         This especially includes members like clone() or append(): clone() will clone \e only from
 119         \c this packet until the end of the chain, append() will append the given packet \e ignoring
 120         any possibly preceding packets/headers/interpreters.
 121
 122         In the same way, the data() member provides an STL-sequence compatible view of the packet
 123         data. This only includes the data which is part of \c this packet including header, trailer
 124         \e and payload but \e not the headers or trailers of packets \e before \c this packet in the
 125         packet/header/interpreter chain (nonetheless, this data overlaps with the data of other
 126         packets).
 127
 128         Several members are member templates taking an \a OtherPacket template parameter. This
 129         parameter must be the ConcretePacket instantiation associated with some concrete packet type
 130         (protocol). For each implemented protocol, typedefs should be provided for these
 131         instantiations (Example: \ref EthernetPacket is a typedef for
 132         \ref ConcretePacket < \ref EthernetPacketType >).
 133
 134         \see
 135             \ref ConcretePacket for the type specific interface\n
 136             \ref PacketData for the sequence interface\n
 137             \ref packetparser for a specification of the parser interface
 138       */
 139     class Packet
 140         : public safe_bool<Packet>,
 141           public boost::equality_comparable<Packet>
 142     {
 143     public:
 144         ///////////////////////////////////////////////////////////////////////////
 145         // Types
 146
 147         typedef void type;              ///< Type of the packet.
 148         typedef senf::detail::packet::size_type size_type; ///< Unsigned type to represent packet size
 149         typedef PacketInterpreterBase::factory_t factory_t; ///< Packet factory type (see below)
 150
 151                                         /// Special argument flag
 152                                         /** Used in some ConcretePacket constructors */
 153         enum NoInit_t { noinit };
 154
 155         ///////////////////////////////////////////////////////////////////////////
 156         ///\name Structors and default members
 157         ///@{
 158
 159         // default copy constructor
 160         // default copy assignment
 161         // default destructor
 162
 163         Packet();                       ///< Create uninitialized packet handle
 164                                         /**< An uninitialized handle is not valid(). It does not
 165                                              allow any operation except assignment and checking for
 166                                              validity. */
 167         Packet clone() const;           ///< Create copy packet
 168                                         /**< clone() will create a complete copy the packet. The
 169                                              returned packet will have the same data and packet
 170                                              chain. It does however not share any data with the
 171                                              original packet. */
 172
 173         // conversion constructors
 174
 175         template <class PacketType>
 176         Packet(ConcretePacket<PacketType> packet); ///< Copy-construct Packet from ConcretePacket
 177                                         /**< This constructor allows to convert an arbitrary
 178                                              ConcretePacket into a general Packet, loosing the
 179                                              protocol specific interface. */
 180
 181         ///@}
 182         ///////////////////////////////////////////////////////////////////////////
 183
 184         ///\name Interpreter chain access
 185         ///@{
 186
 187                                      Packet      next() const;
 188                                         ///< Get next packet in chain
 189                                         /**< \returns in - valid() packet, if no next packet
 190                                              exists */
 191         template <class OtherPacket> OtherPacket next() const;
 192                                         ///< Get next packet of given type in chain
 193                                         /**< \throws InvalidPacketChainException if no such packet
 194                                              is found */
 195         template <class OtherPacket> OtherPacket next(NoThrow_t) const;
 196                                         ///< Get next packet of given type in chain
 197                                         /**< \param[in] nothrow This argument always has the value
 198                                              \c senf::nothrow
 199                                              \returns in - valid() packet, if no such packet is
 200                                              found */
 201         template <class OtherPacket> OtherPacket findNext() const;
 202                                         ///< Find next packet of given type in chain
 203                                         /**< findNext() is like next(), it will however return \c
 204                                              *this if it is of the given type.
 205                                              \throws InvalidPacketChainException if no such packet
 206                                                  is found */
 207         template <class OtherPacket> OtherPacket findNext(NoThrow_t) const;
 208                                         ///< Find next packet of given type in chain
 209                                         /**< findNext() is like next(), it will however return \c
 210                                              *this if it is of the given type.
 211                                              \param[in] nothrow This argument always has the value
 212                                              \c senf::nothrow
 213                                              \returns in - valid() packet, if no such packet is
 214                                              found */
 215
 216
 217                                      Packet      prev() const;
 218                                         ///< Get previous packet in chain
 219                                         /**< \returns in - valid() packet, if no previous packet
 220                                              exists */
 221         template <class OtherPacket> OtherPacket prev() const;
 222                                         ///< Get previous packet of given type in chain
 223                                         /**< \throws InvalidPacketChainException if no such packet
 224                                              is found */
 225         template <class OtherPacket> OtherPacket prev(NoThrow_t) const;
 226                                         ///< Get previous packet of given type in chain
 227                                         /**< \param[in] nothrow This argument always has the value
 228                                              \c senf::nothrow
 229                                              \returns in - valid() packet, if no such packet is
 230                                              found */
 231         template <class OtherPacket> OtherPacket findPrev() const;
 232                                         ///< Find previous packet of given type in chain
 233                                         /**< findPrev() is like prev(), it will however return \c
 234                                              *this if it is of the type
 235                                              \throws InvalidPacketChainException if no such packet
 236                                                  is found */
 237         template <class OtherPacket> OtherPacket findPrev(NoThrow_t) const;
 238                                         ///< Find previous packet of given type in chain
 239                                         /**< findPrev() is like prev(), it will however return \c
 240                                              *this if it is of the type
 241                                              \param[in] nothrow This argument always has the value
 242                                              \c senf::nothrow
 243                                              \returns in - valid() packet, if no such packet is
 244                                              found */
 245
 246
 247                                      Packet      first() const;
 248                                         ///< Return first packet in chain
 249         template <class OtherPacket> OtherPacket first() const;
 250                                         ///< Return first packet of given type in chain
 251                                         /**< \throws InvalidPacketChainException if no such packet
 252                                              is found */
 253         template <class OtherPacket> OtherPacket first(NoThrow_t) const;
 254                                         ///< Return first packet of given type in chain
 255                                         /**< \param[in] nothrow This argument always has the value
 256                                              \c senf::nothrow
 257                                              \returns in - valid() packet, if no such packet is
 258                                              found */
 259
 260                                      Packet      last() const;
 261                                         ///< Return last packet in chain
 262         template <class OtherPacket> OtherPacket last() const;
 263                                         ///< Return last packet of given type in chain
 264                                         /**< \throws InvalidPacketChainException if no such packet
 265                                              is found */
 266         template <class OtherPacket> OtherPacket last(NoThrow_t) const;
 267                                         ///< Return last packet of given type in chain
 268                                         /**< \param[in] nothrow This argument always has the value
 269                                              \c senf::nothrow
 270                                              \returns in - valid() packet, if no such packet is
 271                                              found */
 272
 273
 274         template <class OtherPacket> OtherPacket parseNextAs() const;
 275                                         ///< Parse payload as given by \a OtherPacket and add packet
 276                                         /**< parseNextAs() will throw away the packet chain after
 277                                              the current packet if necessary. It will then parse the
 278                                              payload section of \c this packet as given by \a
 279                                              OtherPacket. The new packet is added to the chain after
 280                                              \c this.
 281                                              \returns new packet instance sharing the same data and
 282                                                  placed after \c this packet in the chain. */
 283                                      Packet      parseNextAs(factory_t factory) const;
 284                                         ///< Parse payload as given by \a factory and add packet
 285                                         /**< parseNextAs() will throw away the packet chain after
 286                                              the current packet if necessary. It will then parse the
 287                                              payload section of \c this packet as given by \a
 288                                              OtherPacket. The new packet is added to the chain after
 289                                              \c this.
 290                                              \returns new packet instance sharing the same data and
 291                                                  placed after \c this packet in the chain. */
 292         template <class OtherPacket> bool        is() const;
 293                                         ///< Check, whether \c this packet is of the given type
 294         template <class OtherPacket> OtherPacket as() const;
 295                                         ///< Cast current packet to the given type
 296                                         /**< This operations returns a handle to the same packet
 297                                              header/interpreter however cast to the given
 298                                              ConcretePacket type. <b>This conversion is
 299                                              unchecked</b>. If the packet really is of a different
 300                                              type, this will wreak havoc with the packet
 301                                              data-structures. You can validate whether the
 302                                              conversion is valid using is(). */
 303
 304         Packet append(Packet packet) const; ///< Append the given packet to \c this packet
 305                                         /**< This operation will replace the payload section of \c
 306                                              this packet with \a packet. This operation will replace
 307                                              the packet chain after \c this packet with a clone of
 308                                              \a packet and will replace the raw data of the payload
 309                                              of \c this with the raw data if \a packet.
 310                                              \returns Packet handle to the cloned \a packet, placed
 311                                                  after \c this in the packet/header/interpreter
 312                                                  chain. */
 313
 314         ///@}
 315
 316         ///\name Data access
 317         ///@{
 318
 319         PacketData & data() const;      ///< Access the packets raw data container
 320         size_type size() const;         ///< Return size of packet in bytes
 321                                         /**< This size does \e not include the size of any preceding
 322                                              headers/packets/interpreters. It does however include
 323                                              \c this packets payload. */
 324
 325         ///@}
 326
 327         ///\name Other methods
 328         ///@{
 329
 330         bool operator==(Packet other) const; ///< Check for packet identity
 331                                         /**< Two packet handles compare equal if they really are the
 332                                              same packet header in the same packet chain. */
 333         bool boolean_test() const;      ///< Check, whether the packet is valid()
 334                                         /**< \see valid() */
 335         bool valid() const;             ///< Check, whether the packet is valid()
 336                                         /**< An in - valid() packet does not allow any operation
 337                                              except checking for validity and assignment. in -
 338                                              valid() packets serve the same role as 0-pointers.
 339
 340                                              This is an alias for boolean_test() which is called
 341                                              when using a packet in a boolean context. */
 342
 343         void finalize() const;          ///< Update calculated fields
 344                                         /**< This call will update all calculated fields of the
 345                                              packet after it has been created or changed. This
 346                                              includes checksums, payload size fields or other
 347                                              fields, which can be set from other information in the
 348                                              packet. Each concrete packet type should document,
 349                                              which fields are set by finalize().
 350
 351                                              finalize() will automatically process all
 352                                              packets/headers/interpreters from the end of the chain
 353                                              backwards up to \c this. */
 354
 355         void dump(std::ostream & os) const; ///< Write out a printable packet representation
 356                                         /**< This method is provided mostly to help debugging packet
 357                                              problems. Each concrete packet should implement a dump
 358                                              method writing out all fields of the packet in a
 359                                              readable representation. dump() will call this member
 360                                              for each packet/header/interpreter in the chain from \c
 361                                              this packet up to the end of the chain. */
 362
 363         TypeIdValue typeId() const;     ///< Get id of \c this packet
 364                                         /**< This value is used e.g. in the packet registry to
 365                                              associate packet types with other information.
 366                                              \returns A type holding the same information as a
 367                                                  type_info object, albeit assignable */
 368         factory_t factory() const;      ///< Return factory instance of \c this packet
 369                                         /**< The returned factory instance can be used to create new
 370                                              packets of the given type without knowing the concrete
 371                                              type of the packet. The value may be stored away for
 372                                              later use if needed. */
 373
 374         ///@}
 375
 376     protected:
 377         explicit Packet(PacketInterpreterBase::ptr packet);
 378
 379         PacketInterpreterBase::ptr ptr() const;
 380
 381     private:
 382         Packet checkNext() const;
 383         Packet checkLast() const;
 384
 385         PacketInterpreterBase::ptr packet_;
 386
 387         template <class PacketType>
 388         friend class ConcretePacket;
 389         friend class PacketParserBase;
 390     };
 391
 392     /** \brief Protocol specific packet handle
 393
 394         The ConcretePacket template class extends Packet to provide protocol/packet type specific
 395         aspects. These are packet constructors and access to the parsed packet fields.
 396
 397         The \c PacketType template argument to ConcretePacket is a protocol specific and internal
 398         policy class which defines the protocol specific behavior. To access a specific type of
 399         packet, the library provides corresponding typedefs of ConcretePacket < \a SomePacketType >
 400         (e.g. \ref EthernetPacket as typedef for \ref ConcretePacket < \ref EthernetPacketType >).
 401
 402         The new members provided by ConcretePacket over packet are mostly comprised of the packet
 403         constructors. These come in three major flavors:
 404
 405         \li The create() family of constructors will create completely new packets.
 406         \li The createAfter() family of constructors will create new packets (with new data for the
 407             packet) \e after a given existing packet.
 408         \li The createBefore()  family of constructors will create new packets (again with new data)
 409             \e before a given existing packet.
 410
 411         Whereas create() will create a completely new packet with it's own chain and data storage,
 412         createAfter() and createBefore() extend a packet with additional
 413         headers/interpreters. createAfter() will set the payload of the given packet to the new
 414         packet whereas createBefore() will create a new packet with the existing packet as it's
 415         payload.
 416
 417         createAfter() differs from Packet::parseNextAs() in that the former creates a new packet \e
 418         replacing any possibly existing data whereas the latter will interpret the already \e
 419         existing data as given by the type argument.
 420
 421         \see \ref PacketTypeBase for a specification of the interface to be provided by the \a
 422             PacketType policy class.
 423       */
 424     template <class PacketType>
 425     class ConcretePacket
 426         : public Packet
 427     {
 428     public:
 429         ///////////////////////////////////////////////////////////////////////////
 430         // Types
 431
 432         typedef PacketType type;
 433
 434         ///////////////////////////////////////////////////////////////////////////
 435         ///\name Structors and default members
 436         ///@{
 437
 438         // default copy constructor
 439         // default copy assignment
 440         // default destructor
 441         // no conversion constructors
 442
 443         ConcretePacket();               ///< Create uninitialized packet handle
 444                                         /**< An uninitialized handle is not valid(). It does not
 445                                              allow any operation except assignment and checking for
 446                                              validity. */
 447
 448         static factory_t factory();     ///< Return factory for packets of specific type
 449                                         /**< This \e static member is like Packet::factory() for a
 450                                              specific packet of type \a PacketType */
 451
 452         // Create completely new packet
 453
 454         static ConcretePacket create(); ///< Create default initialized packet
 455                                         /**< The packet will be initialized to it's default empty
 456                                              state. */
 457         static ConcretePacket create(NoInit_t); ///< Create uninitialized empty packet
 458                                         /**< This will create a completely empty and uninitialized
 459                                              packet with <tt>size() == 0</tt>.
 460                                              \param[in] noinit This parameter must always have the
 461                                                  value \c senf::noinit. */
 462         static ConcretePacket create(size_type size); ///< Create default initialized packet
 463                                         /**< This member will create a default initialized packet
 464                                              with the given size. If the size parameter is smaller
 465                                              than the minimum allowed packet size an exception will
 466                                              be thrown.
 467                                              \param[in] size Size of the packet to create in bytes.
 468                                              \throws TruncatedPacketException if \a size is smaller
 469                                                  than the smallest permissible size for this type of
 470                                                  packet. */
 471         static ConcretePacket create(size_type size, NoInit_t); ///< Create uninitialized packet
 472                                         /**< Creates an uninitialized (all-zero) packet of the exact
 473                                              given size.
 474                                              \param[in] size Size of the packet to create in bytes
 475                                              \param[in] noinit This parameter must always have the
 476                                                  value \c senf::noinit. */
 477         template <class ForwardReadableRange>
 478         static ConcretePacket create(ForwardReadableRange const & range);
 479                                         ///< Create packet from given data
 480                                         /**< The packet will be created from a copy of the given
 481                                              data. The data from the range will be copied directly
 482                                              into the packet representation. The data will \e not be
 483                                              validated in any way.
 484                                              \param[in] range <a
 485                                                  href="http://www.boost.org/libs/range/index.html">Boost.Range</a>
 486                                                  of data to construct packet from. */
 487
 488         // Create packet as new packet after a given packet
 489
 490         static ConcretePacket createAfter(Packet packet);
 491                                         ///< Create default initialized packet after \a packet
 492                                         /**< The packet will be initialized to it's default empty
 493                                              state. It will be appended as next header/interpreter
 494                                              after \a packet in that packets interpreter chain.
 495                                              \param[in] packet Packet to append new packet to. */
 496         static ConcretePacket createAfter(Packet packet, NoInit_t);
 497                                         ///< Create uninitialized empty packet after\a packet
 498                                         /**< This will create a completely empty and uninitialized
 499                                              packet with <tt>size() == 0</tt>. It will be appended
 500                                              as next header/interpreter after \a packet in that
 501                                              packets interpreter chain.
 502                                              \param[in] packet Packet to append new packet to.
 503                                              \param[in] noinit This parameter must always have the
 504                                                  value \c senf::noinit. */
 505         static ConcretePacket createAfter(Packet packet, size_type size);
 506                                         ///< Create default initialized packet after \a packet
 507                                         /**< This member will create a default initialized packet
 508                                              with the given size. If the size parameter is smaller
 509                                              than the minimum allowed packet size an exception will
 510                                              be thrown. It will be appended as next
 511                                              header/interpreter after \a packet in that packets
 512                                              interpreter chain.
 513                                              \param[in] packet Packet to append new packet to.
 514                                              \param[in] size Size of the packet to create in bytes.
 515                                              \throws TruncatedPacketException if \a size is smaller
 516                                                  than the smallest permissible size for this type of
 517                                                  packet. */
 518         static ConcretePacket createAfter(Packet packet, size_type size, NoInit_t);
 519                                         ///< Create uninitialized packet after \a packet
 520                                         /**< Creates an uninitialized (all-zero) packet of the exact
 521                                              given size.  It will be appended as next
 522                                              header/interpreter after \a packet in that packets
 523                                              interpreter chain.
 524                                              \param[in] packet Packet to append new packet to.
 525                                              \param[in] size Size of the packet to create in bytes
 526                                              \param[in] noinit This parameter must always have the
 527                                                  value \c senf::noinit. */
 528         template <class ForwardReadableRange>
 529         static ConcretePacket createAfter(Packet packet,
 530                                           ForwardReadableRange const & range);
 531                                         ///< Create packet from given data after \a packet
 532                                         /**< The packet will be created from a copy of the given
 533                                              data. The data from the range will be copied directly
 534                                              into the packet representation. The data will \e not be
 535                                              validated in any way.  It will be appended as next
 536                                              header/interpreter after \a packet in that packets
 537                                              interpreter chain.
 538                                              \param[in] packet Packet to append new packet to.
 539                                              \param[in] range <a
 540                                                  href="http://www.boost.org/libs/range/index.html">Boost.Range</a>
 541                                                  of data to construct packet from. */
 542
 543         // Create packet as new packet (header) before a given packet
 544
 545         static ConcretePacket createBefore(Packet packet);
 546                                         ///< Create default initialized packet before \a packet
 547                                         /**< The packet will be initialized to it's default empty
 548                                              state. It will be prepended as previous
 549                                              header/interpreter before \a packet in that packets
 550                                              interpreter chain.
 551                                              \param[in] packet Packet to prepend new packet to. */
 552         static ConcretePacket createBefore(Packet packet, NoInit_t);
 553                                         ///< Create uninitialized empty packet before \a packet
 554                                         /**< Creates a completely empty and uninitialized packet. It
 555                                              will be prepended as previous header/interpreter before
 556                                              \a packet in that packets interpreter chain.
 557                                              \param[in] packet Packet to prepend new packet to. */
 558
 559         // Create a clone of the current packet
 560
 561         ConcretePacket clone() const;
 562
 563         ///@}
 564         ///////////////////////////////////////////////////////////////////////////
 565
 566         // Field access
 567
 568         typename type::parser * operator->() const; ///< Access packet fields
 569                                         /**< This operator allows to access the parsed fields of the
 570                                              packet using the notation <tt>packet->field()</tt>. The
 571                                              fields of the packet are specified by the PacketType's
 572                                              \c parser member.
 573
 574                                              The members are not strictly restricted to simple field
 575                                              access. The parser class may have any member which is
 576                                              needed for full packet access (e.g. checksum validation
 577                                              / recreation ...)
 578                                              \see \ref packetparser for the parser interface. */
 579
 580     protected:
 581
 582     private:
 583         typedef PacketInterpreter<PacketType> interpreter;
 584
 585         ConcretePacket(typename interpreter::ptr packet_);
 586
 587         typename interpreter::ptr ptr() const;
 588
 589         friend class Packet;
 590         friend class PacketInterpreter<PacketType>;
 591     };
 592
 593     ///@}
 594
 595 }
 596
 597 ///////////////////////////////hh.e////////////////////////////////////////
 598 #endif
 599 #if !defined(HH_Packets__decls_) && !defined(HH_Packet_i_)
 600 #define HH_Packet_i_
 601 #include "Packet.cci"
 602 #include "Packet.ct"
 603 #include "Packet.cti"
 604 #endif
 605
 606 \f
 607 // Local Variables:
 608 // mode: c++
 609 // fill-column: 100
 610 // c-file-style: "senf"
 611 // indent-tabs-mode: nil
 612 // ispell-local-dictionary: "american"
 613 // compile-command: "scons -u test"
 614 // comment-column: 40
 615 // End:
 616