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.
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
after \c this in the packet/header/interpreter
chain. */
+ void reparse() const; ///< Reparse the payload the packet
+ /**< This member will throw away the packet chain after the
+ current packet. The payload will be reparsed
+ automatically when calling next() */
///@}
///\name Data access
/**< This size does \e not include the size of any preceding
headers/packets/interpreters. It does however include
\c this packets payload. */
-
///@}
///\name Annotations
considering that the packetimpl itself uses a pool.
*/
- ///@}
-
template <class Annotation>
Annotation const & annotation() const; ///< Get packet annotation
/**< \see annotation() */
+ void clearAnnotations(); ///< Clear all packet annotations
+ /**< All packet annotations will be cleared. Afterwards
+ the annotations equates to a new created %packet.
+ \warning all references to existing complex
+ annotations become invalid. */
+ ///@}
+
///\name Other methods
///@{
when using a packet in a boolean context. */
void finalizeThis(); ///< Update calculated fields
- /**< The finalize() fammily of members will update
+ /**< The finalize() family of members will update
calculated packet fields: checksums, size fields and so
on. This includes any field, which can be set from
other information in the packet. Each concrete packet
template <class Other>
void finalizeTo(); ///< Update calculated fields
- /**< The finalize() fammily of members will update
+ /**< The finalize() family of members will update
calculated packet fields: checksums, size fields and so
on. This includes any field, which can be set from
other information in the packet. Each concrete packet
\endcode */
void finalizeTo(Packet const & other); ///< Update calculated fields
- /**< The finalize() fammily of members will update
+ /**< The finalize() family of members will update
calculated packet fields: checksums, size fields and so
on. This includes any field, which can be set from
other information in the packet. Each concrete packet
unsigned long id() const; ///< Unique packet id
/**< Get a unique packet id. If two packets have the same
- id, they share the internal data representation.. */
+ id, they share the internal data representation. */
+
+ bool is_shared() const; ///< check if this packet shares data with any another packet handle.
+ /**< This method returns true if there is any other packet
+ handle pointing to any header in the packet chain. */
///@}
access. The parser class may have any member which is
needed for full packet access (e.g. checksum validation
/ recreation ...)
- \see \ref packetparser for the parser interface. */
+ \see \ref packetparser for the %parser interface. */
Parser parser() const; ///< Access packet field parser directly
/**< Access the parser of the packet. This is the same
object returned by the operator->() operator. The
operator however does not allow to access this object
itself, only it's members.
- \see \ref packetparser for the parser interface */
+ \see \ref packetparser for the %parser interface */
protected:
ConcretePacket(typename interpreter::ptr const & packet_);
- typename interpreter::ptr ptr() const;
+ interpreter * ptr() const;
friend class Packet;
friend class PacketInterpreter<PacketType>;
projects / senf.git / blobdiff