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