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_SENF_Packets_Packet_
  27 #define HH_SENF_Packets_Packet_ 1
  28
  29 // Custom includes
  30 #include <boost/operators.hpp>
  31 #include <boost/utility.hpp>
  32 #include <boost/type_traits/is_integral.hpp>
  33 #include "../Utils/Exception.hh"
  34 #include "../Utils/Tags.hh"
  35 #include "../Utils/safe_bool.hh"
  36 #include "PacketInterpreter.hh"
  37
  38 //#include "Packet.mpp"
  39 ///////////////////////////////hh.p////////////////////////////////////////
  40
  41 namespace senf {
  42
  43     /** \defgroup packet_module Packet Handling
  44
  45         The basic groundwork of the %Packet library is the packet handling:
  46
  47         \li The packet classes provide access to a chain of packet headers (more generically called
  48             interpreters).
  49         \li They automatically manage the required memory resources and the shared packet data.
  50
  51         \section packet_module_chain The Interpreter Chain
  52
  53         The central data structure for a packet is the interpreter chain
  54
  55         \image html structure.png The Interpreter Chain
  56
  57         This image depicts a packet with several headers. Each interpreter is responsible for a
  58         specific sub-range of the complete packet. This range always \e includes the packets payload
  59         (This is, why we call the data structure interpreter and not header: The interpreter is
  60         responsible for interpreting a range of the packet according to a specific protocol), the
  61         packet interpreters are nested inside each other.
  62
  63         For each interpreter, this structure automatically divides the packet into three areas (each
  64         of which are optional): The header, the payload and the trailer. Every packet will have
  65         either a header or a payload section while most don't have a trailer.
  66
  67         As user of the library you always interact with the chain through one (or more) of the
  68         interpreters. The interpreter provides methods to traverse to the following or preceding
  69         header (interpreter) and provides two levels of access to the packet data: Generic low-level
  70         access in the form of an STL compatible sequence and access to the parsed fields which are
  71         provided by the parser associated with the concrete packet type.
  72
  73         \section packet_module_management Resource Management
  74
  75         The interface to the packet library is provided using a handle class (\ref Packet for
  76         generic, protocol agnostic access and \ref ConcretePacket derived from \ref Packet to access
  77         a specific protocol). This handle automatically manages the resources associated with the
  78         packet (the interpreter chain and the data storage holding the packet data). The resources
  79         are automatically released when the last packet handle referencing a specific packet is
  80         destroyed.
  81
  82         \implementation The packet chain is provided on two levels: The internal representation \ref
  83             PacketInterpreterBase and \ref PacketInterpreter which are referenced by the Handle
  84             classes \ref Packet and \ref ConcretePacket. \n
  85             The internal representation classes are pertinent in the sense, that they exist
  86             regardless of the existence of a handle referencing them (as long as the packet
  87             exists). Still the interpreter chain is lazy and packet interpreters beside the first
  88             are only created dynamically when accessed (this is implemented in the handle not in the
  89             internal representation). \n
  90             The packet interpreters make use of a pool allocator. This provides extremely efficient
  91             creation and destruction of packet interpreter's and removes the dynamic memory
  92             management overhead from the packet interpreter management. The packet implementation
  93             class (\ref PacketImpl which holds the packet data itself) however is still dynamically
  94             managed (however there is only a single instance for each packet).
  95      */
  96
  97     template <class PackeType> class ConcretePacket;
  98
  99     ///\addtogroup packet_module
 100     ///@{
 101
 102     /** \brief Main %Packet class
 103
 104         %Packet is the main externally visible class of the packet library. %Packet is a handle into
 105         the internal packet representation. From %Packet you may access the data of that specific
 106         sub-packet/header/interpreter and navigate to the neighboring
 107         sub-packets/headers/interpreters.
 108
 109         %Packet is protocol agnostic. This class only provides non-protocol dependent members. To
 110         access the protocol specific features of a packet (like header fields) the ConcretePacket
 111         class extending %Packet is provided.
 112
 113         \section packet_semantics Semantics
 114
 115         All operations accessing the data of \c this packet in some way will ignore any preceding
 116         packets/headers/interpreters in the chain. It does not matter, whether a given packet is
 117         taken from the middle or the beginning of the chain, all operations (except those explicitly
 118         accessing the chain of course) should work the same.
 119
 120         This especially includes members like clone() or append(): clone() will clone \e only from
 121         \c this packet until the end of the chain, append() will append the given packet \e ignoring
 122         any possibly preceding packets/headers/interpreters.
 123
 124         In the same way, the data() member provides an STL-sequence compatible view of the packet
 125         data. This only includes the data which is part of \c this packet including header, trailer
 126         \e and payload but \e not the headers or trailers of packets \e before \c this packet in the
 127         packet/header/interpreter chain (nonetheless, this data overlaps with the data of other
 128         packets).
 129
 130         Several members are member templates taking an \a OtherPacket template parameter. This
 131         parameter must be the ConcretePacket instantiation associated with some concrete packet type
 132         (protocol). For each implemented protocol, typedefs should be provided for these
 133         instantiations (Example: \ref EthernetPacket is a typedef for
 134         \ref ConcretePacket < \ref EthernetPacketType >).
 135
 136         \see
 137             \ref ConcretePacket for the %type specific interface\n
 138             \ref PacketData for the sequence interface\n
 139             \ref packetparser for a specification of the parser interface
 140      */
 141     class Packet
 142         : public safe_bool<Packet>,
 143           public boost::equality_comparable<Packet>
 144     {
 145     public:
 146         ///////////////////////////////////////////////////////////////////////////
 147         // Types
 148
 149         typedef void type;              ///< Type of the packet.
 150         typedef senf::detail::packet::size_type size_type;
 151         ///< Unsigned type to represent packet size
 152         typedef PacketInterpreterBase::factory_t factory_t; ///< Packet factory type (see below)
 153
 154         ///////////////////////////////////////////////////////////////////////////
 155         ///\name Structors and default members
 156         ///@{
 157
 158         // default copy constructor
 159         // default copy assignment
 160         // default destructor
 161
 162         Packet();                       ///< Create uninitialized packet handle
 163                                         /**< An uninitialized handle is in - valid(). It does not
 164                                              allow any operation except assignment and checking for
 165                                              validity. */
 166         Packet clone() const;           ///< Create copy packet
 167                                         /**< clone() will create a complete copy of \c this
 168                                              packet. The returned packet will have the same data and
 169                                              packet chain. It does however not share any data with
 170                                              the original packet. */
 171
 172         // conversion constructors
 173
 174         template <class PacketType>
 175         Packet(ConcretePacket<PacketType> packet); ///< Copy-construct Packet from ConcretePacket
 176         /**< This constructor allows to convert an arbitrary
 177              ConcretePacket into a general Packet, loosing the
 178              protocol specific interface. */
 179
 180         ///@}
 181         ///////////////////////////////////////////////////////////////////////////
 182
 183         ///\name Interpreter chain access
 184         ///@{
 185
 186         Packet      next() const;
 187         ///< Get next packet in chain
 188         /**< \throws InvalidPacketChainException if no next packet
 189              exists */
 190         Packet      next(NoThrow_t) const;
 191         ///< Get next packet in chain
 192         /**< \returns in - valid() packet if no next packet
 193              exists */
 194         template <class OtherPacket> OtherPacket next() const;
 195         ///< Get next packet in chain and cast to \a OtherPacket
 196         /**< \throws std::bad_cast if the next() packet is not of
 197              type \a OtherPacket
 198              \throws InvalidPacketChainException if no next packet
 199                  exists */
 200         template <class OtherPacket> OtherPacket next(NoThrow_t) const;
 201         ///< Get next packet in chain and cast to \a OtherPacket
 202         /**< \throws std::bad_cast if the next() packet is not of
 203              type \a OtherPacket
 204              \returns in - valid() packet if no next packet
 205                  exists */
 206         template <class OtherPacket> OtherPacket find() const;
 207         ///< Search chain forward for packet of type \a OtherPacket
 208         /**< The search will start with the current packet.
 209              \throws InvalidPacketChainException if no packet of
 210                  type \a OtherPacket can be found. */
 211         template <class OtherPacket> OtherPacket find(NoThrow_t) const;
 212         ///< Search chain forward for packet of type \a OtherPacket
 213         /**< The search will start with the current packet.
 214              \returns in - valid() packet if no packet of type \a
 215                  OtherPacket can be found. */
 216
 217         Packet      prev() const;
 218         ///< Get previous packet in chain
 219         /**< \throws InvalidPacketChainException if no previous
 220              packet exists */
 221         Packet      prev(NoThrow_t) const;
 222         ///< Get previous packet in chain
 223         /**< \returns in - valid() packet if no previous packet
 224              exists */
 225         template <class OtherPacket> OtherPacket prev() const;
 226         ///< Get previous packet in chain and cast to \a OtherPacket
 227         /**< \throws std::bad_cast, if the previous packet is not of
 228              type \a OtherPacket
 229              \throws InvalidPacketChainException if no previous
 230                  packet exists */
 231         template <class OtherPacket> OtherPacket prev(NoThrow_t) const;
 232         ///< Get previous packet in chain and cast to \a OtherPacket
 233         /**< \throws std::bad_cast, if the previous packet is not of
 234              type \a OtherPacket
 235              \returns in - valid() packet if no previous packet
 236                  exists */
 237         template <class OtherPacket> OtherPacket rfind() const;
 238         ///< Search chain backwards for packet of type \a OtherPacket
 239         /**< The search will start with the current packet.
 240              \throws InvalidPacketChainException if no packet of
 241                  type \a OtherPacket can be found. */
 242         template <class OtherPacket> OtherPacket rfind(NoThrow_t) const;
 243         ///< Search chain backwards for packet of type \a OtherPacket
 244         /**< The search will start with the current packet.
 245              \returns in - valid() packet if no packet of type \a
 246                  OtherPacket can be found. */
 247
 248
 249         Packet      first() const;
 250         ///< Return first packet in chain
 251         template <class OtherPacket> OtherPacket first() const;
 252         ///< Return first packet in chain and cast
 253         /**< \throws std::bad_cast if the first() packet is not of
 254              type \a OtherPacket */
 255
 256         Packet      last() const;
 257         ///< Return last packet in chain
 258         template <class OtherPacket> OtherPacket last() const;
 259         ///< Return last packet in chain and cast
 260         /**< \throws std::bad_cast if the last() packet is not of
 261              type \a OtherPacket  */
 262
 263
 264         template <class OtherPacket> OtherPacket parseNextAs() const;
 265         ///< Interpret payload of \c this as \a OtherPacket
 266         /**< parseNextAs() will throw away the packet chain after
 267              the current packet if necessary. It will then parse the
 268              payload section of \c this packet as given by \a
 269              OtherPacket. The new packet is added to the chain after
 270              \c this.
 271              \returns new packet instance sharing the same data and
 272                  placed after \c this packet in the chain. */
 273         Packet      parseNextAs(factory_t factory) const;
 274         ///< Interpret payload of \c this as \a factory type packet
 275         /**< parseNextAs() will throw away the packet chain after
 276              the current packet if necessary. It will then parse the
 277              payload section of \c this packet as given by \a
 278              factory. The new packet is added to the chain after
 279              \c this.
 280              \returns new packet instance sharing the same data and
 281                  placed after \c this packet in the chain. */
 282
 283         template <class OtherPacket> bool        is() const;
 284         ///< Check, whether \c this packet is of the given type
 285         template <class OtherPacket> OtherPacket as() const;
 286         ///< Cast current packet to the given type
 287         /**< This operations returns a handle to the same packet
 288              header/interpreter however cast to the given
 289              ConcretePacket type.
 290              \throws std::bad_cast if the current packet is not of
 291                  type \a OtherPacket */
 292
 293         Packet append(Packet const & packet) const; ///< Append the given packet to \c this packet
 294         /**< This operation will replace the payload section of \c
 295              this packet with \a packet. This operation will replace
 296              the packet chain after \c this packet with a clone of
 297              \a packet and will replace the raw data of the payload
 298              of \c this with the raw data of \a packet. \c this
 299              packet will not share any date with \a packet.
 300              \returns Packet handle to the cloned \a packet, placed
 301                  after \c this in the packet/header/interpreter
 302                  chain. */
 303
 304         ///@}
 305
 306         ///\name Data access
 307         ///@{
 308
 309         PacketData & data() const;      ///< Access the packets raw data container
 310         size_type size() const;         ///< Return size of packet in bytes
 311                                         /**< This size does \e not include the size of any preceding
 312                                              headers/packets/interpreters. It does however include
 313                                              \c this packets payload. */
 314
 315         ///@}
 316
 317         ///\name Annotations
 318         ///@{
 319
 320         template <class Annotation>
 321         Annotation & annotation();      ///< Get packet annotation
 322                                         /**< This member will retrieve an arbitrary packet
 323                                              annotation. Every annotation is identified by a unique
 324                                              \a Annotation type. This type should \e always be a \c
 325                                              struct.
 326
 327                                              \code
 328                                                  struct MyAnnotation {
 329                                                  int value;
 330                                                  };
 331
 332                                              senf::Packet p (...);
 333
 334                                              p.annotation<MyAnnotation>().value = 1;
 335                                              \endcode
 336
 337                                              Annotations are shared by all headers / interpreters
 338                                              within a single packet chain.
 339
 340                                              If an annotation is \e not a POD type (more
 341                                              specifically, if it's constructor or destructor is not
 342                                              trivial including base classes and members), the \a
 343                                              Annotation type \e must inherit from
 344                                              senf::ComplexAnnotation. Failing to follow this rule
 345                                              will result in undefined behavior and will probably
 346                                              lead to a program crash.
 347
 348                                              \code
 349                                                  struct MyStringAnnotation : senf::ComplexAnnotation {
 350                                                  std::string value;
 351                                                  };
 352                                              \endcode
 353                                                  (This type is not POD since \c std::string is not POD)
 354
 355                                              \see \ref packet_usage_annotation
 356
 357                                              \implementation The annotation system is implemented
 358                                                  quite efficiently since annotations are stored
 359                                                  within a packet embedded vector of fixed size (the
 360                                                  size is determined automatically at runtime by the
 361                                                  number of different annotations
 362                                                  used). Additionally, non-complex small annotations
 363                                                  require no additional memory management (\c new /
 364                                                  \c delete).
 365
 366                                              \idea Pool the annotation vectors: In the destructor
 367                                                  swap the vector into a vector graveyard (swapping
 368                                                  two vectors is an O(1) no allocation operation). In
 369                                                  the constructor, if there is a vector in the
 370                                                  graveyard, swap it in from there. Of course, it
 371                                                  would be better to do away with the vector and just
 372                                                  allocate the space together with the packet but
 373                                                  that looks quite complicated to do ... especially
 374                                                  considering that the packetimpl itself uses a pool.
 375                                           */
 376
 377         ///@}
 378
 379         template <class Annotation>
 380         Annotation const & annotation() const; ///< Get packet annotation
 381                                         /**< \see annotation() */
 382
 383         ///\name Other methods
 384         ///@{
 385
 386         bool operator==(Packet const & other) const; ///< Check for packet identity
 387         /**< Two packet handles compare equal if they really are the
 388              same packet header in the same packet chain. */
 389         bool boolean_test() const;      ///< Check, whether the packet is valid()
 390                                         /**< \see valid() */
 391         bool valid() const;             ///< Check, whether the packet is valid()
 392                                         /**< An in - valid() packet does not allow any operation
 393                                              except checking for validity and assignment. in -
 394                                              valid() packets serve the same role as 0-pointers.
 395
 396                                              This is an alias for boolean_test() which is called
 397                                              when using a packet in a boolean context. */
 398
 399         void finalizeThis();            ///< Update calculated fields
 400                                         /**< The finalize() fammily of members will update
 401                                              calculated packet fields: checksums, size fields and so
 402                                              on. This includes any field, which can be set from
 403                                              other information in the packet. Each concrete packet
 404                                              type should document, which fields are set by
 405                                              finalize().
 406
 407                                              finalizeThis() will \e only process the current
 408                                              header. Even if only changing fields in this protocol,
 409                                              depending on the protocol it may not be enough to
 410                                              finalize this header only. See the packet type
 411                                              documentation. */
 412
 413         template <class Other>
 414         void finalizeTo();              ///< Update calculated fields
 415                                         /**< The finalize() fammily of members will update
 416                                              calculated packet fields: checksums, size fields and so
 417                                              on. This includes any field, which can be set from
 418                                              other information in the packet. Each concrete packet
 419                                              type should document, which fields are set by
 420                                              finalize().
 421
 422                                              finalizeTo() will automatically process all
 423                                              packets/headers/interpreters from the \e first
 424                                              occurrence of packet type \a Other (beginning at \c
 425                                              this packet searching forward towards deeper nested
 426                                              packets) backwards up to \c this.
 427
 428                                              This call is equivalent to
 429                                              \code
 430                                                  p.finalizeTo(p.next<Other>())
 431                                              \endcode */
 432
 433         void finalizeTo(Packet const & other);  ///< Update calculated fields
 434         /**< The finalize() fammily of members will update
 435              calculated packet fields: checksums, size fields and so
 436              on. This includes any field, which can be set from
 437              other information in the packet. Each concrete packet
 438              type should document, which fields are set by
 439              finalize().
 440
 441              finalizeTo(other) will automatically process all
 442              packets/headers/interpreters beginning at \a other
 443              backwards towards outer packets up to \c this. */
 444
 445         void finalizeAll();             ///< Update calculated fields
 446                                         /**< The finalize() fammily of members will update
 447                                              calculated packet fields: checksums, size fields and so
 448                                              on. This includes any field, which can be set from
 449                                              other information in the packet. Each concrete packet
 450                                              type should document, which fields are set by
 451                                              finalize().
 452
 453                                              finalizeAll() will automatically process all
 454                                              packets/headers/interpreters from the end of the chain
 455                                              (the most inner packet) backwards up to \c this.
 456
 457                                              This call is equivalent to
 458                                              \code
 459                                                  p.finalizeTo(p.last())
 460                                              \endcode
 461
 462                                              Beware, that finalizeAll() will \e not finalize any
 463                                              headers before \c this, it will \e only process inner
 464                                              headers. */
 465
 466         void dump(std::ostream & os) const; ///< Write out a printable packet representation
 467         /**< This method is provided mostly to help debugging packet
 468              problems. Each concrete packet should implement a dump
 469              method writing out all fields of the packet in a
 470              readable representation. dump() will call this member
 471              for each packet/header/interpreter in the chain from \c
 472              this packet up to the end of the chain. */
 473
 474         TypeIdValue typeId() const;     ///< Get id of \c this packet
 475         /**< This value is used e.g. in the packet registry to
 476              associate packet types with other information.
 477              \returns A type holding the same information as a
 478                  type_info object, albeit assignable */
 479         factory_t factory() const;      ///< Return factory instance of \c this packet
 480         /**< The returned factory instance can be used to create new
 481              packets of the given type without knowing the concrete
 482              type of the packet. The value may be stored away for
 483              later use if needed. */
 484
 485         ///@}
 486
 487     protected:
 488         explicit Packet(PacketInterpreterBase::ptr packet);
 489
 490         PacketInterpreterBase::ptr ptr() const;
 491
 492     private:
 493         Packet checkNext() const;
 494         Packet checkLast() const;
 495
 496         PacketInterpreterBase::ptr packet_;
 497
 498         template <class PacketType>
 499         friend class ConcretePacket;
 500         friend class PacketParserBase;
 501     };
 502
 503     /** \brief Protocol specific packet handle
 504
 505         The ConcretePacket template class extends Packet to provide protocol/packet type specific
 506         aspects. These are packet constructors and access to the parsed packet fields.
 507
 508         The \c PacketType template argument to ConcretePacket is a protocol specific and internal
 509         policy class which defines the protocol specific behavior. To access a specific type of
 510         packet, the library provides corresponding typedefs of ConcretePacket < \a SomePacketType >
 511         (e.g. \ref EthernetPacket as typedef for \ref ConcretePacket < \ref EthernetPacketType >).
 512
 513         The new members provided by ConcretePacket over packet are mostly comprised of the packet
 514         constructors. These come in three major flavors:
 515
 516         \li The create() family of constructors will create completely new packets.
 517         \li The createAfter() family of constructors will create new packets (with new data for the
 518             packet) \e after a given existing packet.
 519         \li The createBefore()  family of constructors will create new packets (again with new data)
 520             \e before a given existing packet.
 521
 522         Whereas create() will create a completely new packet with it's own chain and data storage,
 523         createAfter() and createBefore() extend a packet with additional
 524         headers/interpreters. createAfter() will set the payload of the given packet to the new
 525         packet whereas createBefore() will create a new packet with the existing packet as it's
 526         payload.
 527
 528         createAfter() differs from Packet::parseNextAs() in that the former creates a new packet \e
 529         replacing any possibly existing data whereas the latter will interpret the already \e
 530         existing data as given by the type argument.
 531
 532         \see \ref PacketTypeBase for a specification of the interface to be provided by the \a
 533             PacketType policy class.
 534      */
 535     template <class PacketType>
 536     class ConcretePacket
 537         : public Packet
 538     {
 539     public:
 540         ///////////////////////////////////////////////////////////////////////////
 541         // Types
 542
 543         typedef PacketType type;
 544         typedef typename PacketType::parser Parser;
 545
 546         ///////////////////////////////////////////////////////////////////////////
 547         ///\name Structors and default members
 548         ///@{
 549
 550         // default copy constructor
 551         // default copy assignment
 552         // default destructor
 553         // no conversion constructors
 554
 555         ConcretePacket();               ///< Create uninitialized packet handle
 556         /**< An uninitialized handle is not valid(). It does not
 557              allow any operation except assignment and checking for
 558              validity. */
 559
 560         static factory_t factory();     ///< Return factory for packets of specific type
 561         /**< This \e static member is like Packet::factory() for a
 562              specific packet of type \a PacketType */
 563
 564         // Create completely new packet
 565
 566         static ConcretePacket create(); ///< Create default initialized packet
 567         /**< The packet will be initialized to it's default empty
 568              state. */
 569         static ConcretePacket create(senf::NoInit_t); ///< Create uninitialized empty packet
 570         /**< This will create a completely empty and uninitialized
 571              packet with <tt>size() == 0</tt>.
 572              \param[in] senf::noinit This parameter must always have the
 573                  value \c senf::noinit. */
 574         static ConcretePacket create(size_type size); ///< Create default initialized packet
 575         /**< This member will create a default initialized packet
 576              with the given size. If the size parameter is smaller
 577              than the minimum allowed packet size an exception will
 578              be thrown.
 579              \param[in] size Size of the packet to create in bytes.
 580              \throws TruncatedPacketException if \a size is smaller
 581                  than the smallest permissible size for this type of
 582                  packet. */
 583         static ConcretePacket create(size_type size, senf::NoInit_t);
 584         ///< Create uninitialized packet
 585         /**< Creates an uninitialized (all-zero) packet of the exact
 586              given size.
 587              \param[in] size Size of the packet to create in bytes
 588              \param[in] senf::noinit This parameter must always have the
 589                  value \c senf::noinit. */
 590 #ifndef DOXYGEN
 591         template <class ForwardReadableRange>
 592         static ConcretePacket create(
 593             ForwardReadableRange const & range,
 594             typename boost::disable_if< boost::is_integral<ForwardReadableRange> >::type * = 0);
 595 #else
 596         template <class ForwardReadableRange>
 597         static ConcretePacket create(ForwardReadableRange const & range);
 598         ///< Create packet from given data
 599         /**< The packet will be created from a copy of the given
 600              data. The data from the range will be copied directly
 601              into the packet representation. The data will \e not be
 602              validated in any way.
 603              \param[in] range <a
 604                  href="http://www.boost.org/libs/range/index.html">Boost.Range</a>
 605                  of data to construct packet from. */
 606 #endif
 607
 608         // Create packet as new packet after a given packet
 609
 610         static ConcretePacket createAfter(Packet const & packet);
 611         ///< Create default initialized packet after \a packet
 612         /**< The packet will be initialized to it's default empty
 613              state. It will be appended as next header/interpreter
 614              after \a packet in that packets interpreter chain.
 615              \param[in] packet Packet to append new packet to. */
 616         static ConcretePacket createAfter(Packet const & packet, senf::NoInit_t);
 617         ///< Create uninitialized empty packet after\a packet
 618         /**< This will create a completely empty and uninitialized
 619              packet with <tt>size() == 0</tt>. It will be appended
 620              as next header/interpreter after \a packet in that
 621              packets interpreter chain.
 622              \param[in] packet Packet to append new packet to.
 623              \param[in] senf::noinit This parameter must always have the
 624                  value \c senf::noinit. */
 625         static ConcretePacket createAfter(Packet const & packet, size_type size);
 626         ///< Create default initialized packet after \a packet
 627         /**< This member will create a default initialized packet
 628              with the given size. If the size parameter is smaller
 629              than the minimum allowed packet size an exception will
 630              be thrown. It will be appended as next
 631              header/interpreter after \a packet in that packets
 632              interpreter chain.
 633              \param[in] packet Packet to append new packet to.
 634              \param[in] size Size of the packet to create in bytes.
 635              \throws TruncatedPacketException if \a size is smaller
 636                  than the smallest permissible size for this type of
 637                  packet. */
 638         static ConcretePacket createAfter(Packet const & packet, size_type size, senf::NoInit_t);
 639         ///< Create uninitialized packet after \a packet
 640         /**< Creates an uninitialized (all-zero) packet of the exact
 641              given size.  It will be appended as next
 642              header/interpreter after \a packet in that packets
 643              interpreter chain.
 644              \param[in] packet Packet to append new packet to.
 645              \param[in] size Size of the packet to create in bytes
 646              \param[in] senf::noinit This parameter must always have the
 647                  value \c senf::noinit. */
 648 #ifndef DOXYGEN
 649         template <class ForwardReadableRange>
 650         static ConcretePacket createAfter(
 651             Packet const & packet,
 652             ForwardReadableRange const & range,
 653             typename boost::disable_if< boost::is_integral<ForwardReadableRange> >::type * = 0);
 654 #else
 655         template <class ForwardReadableRange>
 656         static ConcretePacket createAfter(Packet const & packet,
 657                                           ForwardReadableRange const & range);
 658         ///< Create packet from given data after \a packet
 659         /**< The packet will be created from a copy of the given
 660              data. The data from the range will be copied directly
 661              into the packet representation. The data will \e not be
 662              validated in any way.  It will be appended as next
 663              header/interpreter after \a packet in that packets
 664              interpreter chain.
 665              \param[in] packet Packet to append new packet to.
 666              \param[in] range <a
 667                  href="http://www.boost.org/libs/range/index.html">Boost.Range</a>
 668                  of data to construct packet from. */
 669 #endif
 670
 671         // Create packet as new packet (header) before a given packet
 672
 673         static ConcretePacket createBefore(Packet const & packet);
 674         ///< Create default initialized packet before \a packet
 675         /**< The packet will be initialized to it's default empty
 676              state. It will be prepended as previous
 677              header/interpreter before \a packet in that packets
 678              interpreter chain.
 679              \param[in] packet Packet to prepend new packet to. */
 680         static ConcretePacket createBefore(Packet const & packet, senf::NoInit_t);
 681         ///< Create uninitialized empty packet before \a packet
 682         /**< Creates a completely empty and uninitialized packet. It
 683              will be prepended as previous header/interpreter before
 684              \a packet in that packets interpreter chain.
 685              \param[in] packet Packet to prepend new packet to. */
 686
 687         // Create a clone of the current packet
 688
 689         ConcretePacket clone() const;
 690
 691         ///@}
 692         ///////////////////////////////////////////////////////////////////////////
 693
 694         // Field access
 695
 696         struct ParserProxy
 697         {
 698             ParserProxy(Parser const & p) : p_ (p) {}
 699             Parser * operator->() { return &p_; }
 700             Parser p_;
 701         };
 702
 703         ParserProxy operator->() const;    ///< Access packet fields
 704                                         /**< This operator allows to access the parsed fields of the
 705                                              packet using the notation <tt>packet->field()</tt>. The
 706                                              fields of the packet are specified by the PacketType's
 707                                              \c parser member.
 708
 709                                              The members are not strictly restricted to simple field
 710                                              access. The parser class may have any member which is
 711                                              needed for full packet access (e.g. checksum validation
 712                                              / recreation ...)
 713                                              \see \ref packetparser for the parser interface. */
 714
 715         Parser parser() const;          ///< Access packet field parser directly
 716                                         /**< Access the parser of the packet. This is the same
 717                                              object returned by the operator->() operator. The
 718                                              operator however does not allow to access this object
 719                                              itself, only it's members.
 720                                              \see \ref packetparser for the parser interface */
 721
 722     protected:
 723
 724     private:
 725         typedef PacketInterpreter<PacketType> interpreter;
 726
 727         ConcretePacket(typename interpreter::ptr packet_);
 728
 729         typename interpreter::ptr ptr() const;
 730
 731         friend class Packet;
 732         friend class PacketInterpreter<PacketType>;
 733     };
 734
 735     /** \brief Generic parser copying
 736
 737         This operator allows to copy the value of identical parsers. This operation does \e not
 738         depend on the parsers detailed implementation, it will just replace the data bytes of the
 739         target parser with those from the source packet.
 740      */
 741     template <class PacketType, class Parser>
 742     Parser operator<<(Parser target, ConcretePacket<PacketType> const & packet);
 743
 744     ///@}
 745
 746 }
 747
 748 ///////////////////////////////hh.e////////////////////////////////////////
 749 #endif
 750 #if !defined(HH_SENF_Packets_Packets__decls_) && !defined(HH_SENF_Packets_Packet_i_)
 751 #define HH_SENF_Packets_Packet_i_
 752 #include "Packet.cci"
 753 #include "Packet.ct"
 754 #include "Packet.cti"
 755 #endif
 756
 757 \f
 758 // Local Variables:
 759 // mode: c++
 760 // fill-column: 100
 761 // c-file-style: "senf"
 762 // indent-tabs-mode: nil
 763 // ispell-local-dictionary: "american"
 764 // compile-command: "scons -u test"
 765 // comment-column: 40
 766 // End:
 767