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