use senf::scheduler:now()
[senf.git] / senf / Packets / Packet.hh
index db53195..7d31942 100644 (file)
@@ -171,7 +171,8 @@ namespace senf {
         // 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. */
@@ -196,10 +197,9 @@ namespace senf {
                                                  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.
@@ -225,10 +225,9 @@ namespace senf {
                                                  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.
@@ -289,6 +288,15 @@ namespace senf {
                                              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
@@ -489,13 +497,13 @@ namespace senf {
         ///@}
 
     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_;
 
@@ -610,7 +618,7 @@ namespace senf {
                                              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
 
@@ -672,7 +680,7 @@ namespace senf {
                                              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
 
@@ -752,7 +760,7 @@ namespace senf {
     private:
         typedef PacketInterpreter<PacketType> interpreter;
 
-        ConcretePacket(typename interpreter::ptr packet_);
+        ConcretePacket(typename interpreter::ptr const & packet_);
 
         typename interpreter::ptr ptr() const;