senf/Socket/Protocols/DatagramSocketProtocol.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 DatagramSocketProtocol public header */
  25
  26 #ifndef HH_SENF_Socket_Protocols_DatagramSocketProtocol_
  27 #define HH_SENF_Socket_Protocols_DatagramSocketProtocol_ 1
  28
  29 // Custom includes
  30 #include <sys/time.h>
  31 #include <senf/Socket/SocketProtocol.hh>
  32 #include <senf/Scheduler/ClockService.hh>
  33
  34 //#include "DatagramSocketProtocol.mpp"
  35 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  36
  37 namespace senf {
  38
  39     ///\addtogroup protocol_facets_group
  40     //\{
  41
  42     /** \brief Protocol facet providing generic BSD datagram socket functionality
  43       */
  44     class DatagramSocketProtocol
  45         : public virtual SocketProtocol
  46     {
  47     public:
  48         ClockService::clock_type timestamp_system() const; ///< Return packet timestamp of last packet
  49
  50         ClockService::clock_type timestamp() const; ///< Return packet timestamp of last packet
  51                                         /**< The returned timestamp represents the time, at which
  52                                              the last network packet passed to the user has been
  53                                              received from the network. This allows precise network
  54                                              timing.
  55
  56                                              \pre The \c SO_TIMESTAMP socket option must not be set
  57                                                  on the socket.
  58                                              \returns timestamp when last packet was received */
  59     };
  60
  61
  62     //\}
  63 }
  64
  65 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  66 //#include "DatagramSocketProtocol.cci"
  67 //#include "DatagramSocketProtocol.ct"
  68 //#include "DatagramSocketProtocol.cti"
  69 #endif
  70
  71 \f
  72 // Local Variables:
  73 // mode: c++
  74 // fill-column: 100
  75 // comment-column: 40
  76 // c-file-style: "senf"
  77 // indent-tabs-mode: nil
  78 // ispell-local-dictionary: "american"
  79 // compile-command: "scons -u test"
  80 // End: