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