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         \todo the multicast add/remove/iface semantics are quite unclear ...
  48      */
  49     class UDPProtocol
  50         : public virtual SocketProtocol
  51     {
  52     public:
  53         ///\name Abstract Interface Implementation
  54         ///@{
  55
  56         unsigned available() const;
  57         bool eof() const;
  58
  59         ///@}
  60     };
  61
  62     /// @}
  63 }
  64
  65 ///////////////////////////////hh.e////////////////////////////////////////
  66 //#include "UDPProtocol.cci"
  67 //#include "UDPProtocol.ct"
  68 //#include "UDPProtocol.cti"
  69 #endif
  70
  71 \f
  72 // Local Variables:
  73 // mode: c++
  74 // fill-column: 100
  75 // c-file-style: "senf"
  76 // indent-tabs-mode: nil
  77 // ispell-local-dictionary: "american"
  78 // compile-command: "scons -u test"
  79 // comment-column: 40
  80 // End: