// conversion constructors
template <class PacketType>
- Packet(ConcretePacket<PacketType> packet); ///< Copy-construct Packet from ConcretePacket
+ Packet(ConcretePacket<PacketType> const & packet);
+ ///< Copy-construct Packet from ConcretePacket
/**< This constructor allows to convert an arbitrary
ConcretePacket into a general Packet, loosing the
protocol specific interface. */
exists */
template <class OtherPacket> OtherPacket next(NoThrow_t) const;
///< Get next packet in chain and cast to \a OtherPacket
- /**< \throws std::bad_cast if the next() packet is not of
- type \a OtherPacket
- \returns in - valid() packet if no next packet
- exists */
+ /**< \returns in - valid() packet if no next packet
+ exists or if next() packet is not of
+ type \a OtherPacket */
template <class OtherPacket> OtherPacket find() const;
///< Search chain forward for packet of type \a OtherPacket
/**< The search will start with the current packet.
packet exists */
template <class OtherPacket> OtherPacket prev(NoThrow_t) const;
///< Get previous packet in chain and cast to \a OtherPacket
- /**< \throws std::bad_cast, if the previous packet is not of
- type \a OtherPacket
- \returns in - valid() packet if no previous packet
- exists */
+ /**< \returns in - valid() packet if no previous packet
+ exists or if the previous packet is not of
+ type \a OtherPacket */
template <class OtherPacket> OtherPacket rfind() const;
///< Search chain backwards for packet of type \a OtherPacket
/**< The search will start with the current packet.
Packet first() const; ///< Return first packet in chain
- template <class OtherPacket> OtherPacket first() const;
+ template <class OtherPacket> OtherPacket first() const;
///< Return first packet in chain and cast
/**< \throws std::bad_cast if the first() packet is not of
type \a OtherPacket */
before.
\throws std::bad_cast if the current packet is not of
type \a OtherPacket */
+ template <class OtherPacket> OtherPacket as(NoThrow_t) const;
+ ///< Cast current packet to the given type
+ /**< This operations returns a handle to the same packet
+ header/interpreter however upcast to the given
+ ConcretePacket type which have been instantiated
+ before.
+ \warning You must make absolutely sure that the packet
+ is of the given type. If not, calling this member
+ crashes your program in a unkindly way. */
Packet append(Packet const & packet) const; ///< Append the given packet to \c this packet
/**< This operation will replace the payload section of \c
the packet chain after \c this packet with a clone of
\a packet and will replace the raw data of the payload
of \c this with the raw data of \a packet. \c this
- packet will not share any date with \a packet.
+ packet will not share any data with \a packet.
\returns Packet handle to the cloned \a packet, placed
after \c this in the packet/header/interpreter
chain. */
///@}
protected:
- explicit Packet(PacketInterpreterBase::ptr packet);
+ explicit Packet(PacketInterpreterBase::ptr const & packet);
- PacketInterpreterBase::ptr ptr() const;
+ PacketInterpreterBase::ptr const & ptr() const;
private:
- Packet checkNext() const;
- Packet checkLast() const;
+ Packet getNext() const;
+ Packet getLast() const;
PacketInterpreterBase::ptr packet_;
\li The create() family of constructors will create completely new packets.
\li The createAfter() family of constructors will create new packets (with new data for the
- packet) \e after a given existing packet.
- \li The createBefore() family of constructors will create new packets (again with new data)
- \e before a given existing packet.
+ packet) \e after a given existing packet <em>thereby destroying and overwriting any
+ possibly existing packets and data after the given packet</em>.
+ \li The createBefore() family of constructors will create new packets (again with new data)
+ \e before a given existing packet <em>thereby destroying and overwriting any possibly
+ existing packets and data before the given packet</em>.
+ \li The createInsertBefore() family of constructors will create new packets \e before a
+ given packet \e inserting them into the packet chain after any existing packets before
+ the given packet.
Whereas create() will create a completely new packet with it's own chain and data storage,
- createAfter() and createBefore() extend a packet with additional
+ createAfter(), createBefore() and createInsertBefore() extend a packet with additional
headers/interpreters. createAfter() will set the payload of the given packet to the new
- packet whereas createBefore() will create a new packet with the existing packet as it's
- payload.
+ packet whereas createBefore() and createInsertBefore() will create a new packet with the
+ existing packet as it's payload.
createAfter() differs from Packet::parseNextAs() in that the former creates a new packet \e
replacing any possibly existing data whereas the latter will interpret the already \e
into the packet representation. The data will \e not be
validated in any way.
- \param[in] range <a href="http://www.boost.org/libs/range/index.html">Boost.Range</a>
+ \param[in] range <a href="http://www.boost.org/doc/libs/release/libs/range/index.html">Boost.Range</a>
of data to construct packet from. */
#endif
header/interpreter after \a packet in that packets
interpreter chain.
\param[in] packet Packet to append new packet to.
- \param[in] range <a href="http://www.boost.org/libs/range/index.html">Boost.Range</a>
+ \param[in] range <a href="http://www.boost.org/doc/libs/release/libs/range/index.html">Boost.Range</a>
of data to construct packet from. */
#endif
state. It will be prepended as previous
header/interpreter before \a packet in that packets
interpreter chain.
+ \warning This constructor will destroy any existing
+ headers before \a packet and replace them with the
+ new header.
\param[in] packet Packet to prepend new packet to. */
static ConcretePacket createBefore(Packet const & packet, senf::NoInit_t);
///< Create uninitialized empty packet before \a packet
/**< Creates a completely empty and uninitialized packet. It
will be prepended as previous header/interpreter before
\a packet in that packets interpreter chain.
+ \warning This constructor will destroy any existing
+ headers before \a packet and replace them with the
+ new header.
\param[in] packet Packet to prepend new packet to. */
static ConcretePacket createInsertBefore(Packet const & packet);
+ ///< Insert default initialized packet before \a packet
+ /**< The new packet header will be initialized to it' s
+ default empty state. It will be inserted into the
+ packet chain before \a packet.
+ \param[in] packet Packet before which to insert the new
+ packet */
static ConcretePacket createInsertBefore(Packet const & packet, senf::NoInit_t);
+ ///< Insert uninitialized empty packet before \a packet
+ /**< Inserts a completely empty and unitialized packet
+ before \a packet into the header/interpreter chain.
+ \param[in] packet Packet before which to insert the new
+ packet */
// Create a clone of the current packet
private:
typedef PacketInterpreter<PacketType> interpreter;
- ConcretePacket(typename interpreter::ptr packet_);
+ ConcretePacket(typename interpreter::ptr const & packet_);
typename interpreter::ptr ptr() const;
projects / senf.git / blobdiff