senf/Socket/Protocols/INet/UDPSocketProtocol.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 UDPSocketProtocol public header
  25  */
  26
  27 #ifndef HH_SENF_Socket_Protocols_INet_UDPSocketProtocol_
  28 #define HH_SENF_Socket_Protocols_INet_UDPSocketProtocol_ 1
  29
  30 // Custom includes
  31 #include "INetSocketProtocol.hh"
  32
  33 //#include "UDPSocketProtocol.mpp"
  34 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  35
  36 namespace senf {
  37
  38     /// \addtogroup protocol_facets_group
  39     //\{
  40
  41     /** \brief Protocol facet to support UDP operations
  42
  43         This protocol facet provides all those protocol functions,
  44         which are available on any UDP socket.
  45      */
  46     class UDPSocketProtocol
  47         : public virtual INetSocketProtocol
  48     {
  49     public:
  50         ///\name Abstract Interface Implementation
  51         //\{
  52
  53         unsigned available() const;
  54         bool eof() const;
  55
  56         //\}
  57     };
  58
  59     //\}
  60 }
  61
  62 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  63 //#include "UDPSocketProtocol.cci"
  64 //#include "UDPSocketProtocol.ct"
  65 //#include "UDPSocketProtocol.cti"
  66 #endif
  67
  68 \f
  69 // Local Variables:
  70 // mode: c++
  71 // fill-column: 100
  72 // c-file-style: "senf"
  73 // indent-tabs-mode: nil
  74 // ispell-local-dictionary: "american"
  75 // compile-command: "scons -u test"
  76 // comment-column: 40
  77 // End: