Packets: Fix VariantParser invalid parser access bug
[senf.git] / Socket / Protocols / DatagramSocketProtocol.hh
index 98929fc..dcf5af8 100644 (file)
@@ -1,6 +1,6 @@
 // $Id$
 //
-// Copyright (C) 2007 
+// Copyright (C) 2007
 // Fraunhofer Institute for Open Communication Systems (FOKUS)
 // Competence Center NETwork research (NET), St. Augustin, GERMANY
 //     Stefan Bund <g0dil@berlios.de>
 /** \file
     \brief DatagramSocketProtocol public header */
 
-#ifndef HH_DatagramSocketProtocol_
-#define HH_DatagramSocketProtocol_ 1
+#ifndef HH_SENF_Socket_Protocols_DatagramSocketProtocol_
+#define HH_SENF_Socket_Protocols_DatagramSocketProtocol_ 1
 
 // Custom includes
 #include <sys/time.h>
 #include "../../Socket/SocketProtocol.hh"
+#include "../../Scheduler/ClockService.hh"
 
 //#include "DatagramSocketProtocol.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
@@ -44,15 +45,19 @@ namespace senf {
         : public virtual SocketProtocol
     {
     public:
-        struct timeval timestamp() const; ///< Return packet timestamp of last packet
+        ClockService::clock_type timestamp() const; ///< Return packet timestamp of last packet
                                         /**< The returned timestamp represents the time, at which
                                              the last network packet passed to the user has been
                                              received from the network. This allows precise network
                                              timing.
+
+                                             The returned value can be converted to the
+                                             senf::ClockService::clock_type representation using
+                                             semf::ClockService::from_timeval().
+
                                              \pre The \c SO_TIMESTAMP socket option must not be set
                                                  on the socket.
-                                             \returns timestamp when last packet was received
-                                             \todo Move this to DatagramSocketProtocol class */
+                                             \returns timestamp when last packet was received */
     };