senf/Socket/ProtocolClientSocketHandle.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2006
   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 ProtocolClientSocketHandle public header
  25  */
  26
  27 #ifndef HH_SENF_Socket_ProtocolClientSocketHandle_
  28 #define HH_SENF_Socket_ProtocolClientSocketHandle_ 1
  29
  30 // Custom includes
  31 #include "ClientSocketHandle.hh"
  32 #include <senf/config.hh>
  33 #include <senf/Utils/Tags.hh>
  34
  35 #include "ProtocolClientSocketHandle.mpp"
  36 ///////////////////////////////hh.p////////////////////////////////////////
  37
  38 namespace senf {
  39
  40     /// \addtogroup handle_group
  41     /// @{
  42
  43     template <class Protocol> class ProtocolServerSocketHandle;
  44
  45     /** \brief Protocol specific socket handle (client interface)
  46
  47         The ProtocolClientSocketHandle is the client interface leaf class of the handle
  48         hierarchy. This is the class to instantiate to open a new socket. This is also the \e only
  49         class, which can be used to open a client socket.
  50
  51         The \a Protocol template argument defines the protocol of the socket. This protocol provides
  52         the protocol interface of the socket as well as the complete socket policy of this protocol.
  53
  54         The ProtocolClientSocketHandle adds the protocol interface as an additional interface to the
  55         socket handle. This interface is only accessible via the protocol class. All socket
  56         functionality not available through the policy interface (see ClientSocketHandle) is
  57         accessible via the protocol() member.
  58
  59         \see \ref protocol_group
  60       */
  61     template <class SocketProtocol>
  62     class ProtocolClientSocketHandle
  63         : public ClientSocketHandle<typename SocketProtocol::Policy>
  64     {
  65     public:
  66         ///////////////////////////////////////////////////////////////////////////
  67         // Types
  68
  69         typedef SocketProtocol Protocol; ///< The sockets protocol
  70
  71         ///////////////////////////////////////////////////////////////////////////
  72         ///\name Structors and default members
  73         ///@{
  74
  75         /** \brief Create new client socket
  76
  77             This constructor is one of the possible constructors. The exact Signature of the
  78             constructor (or constructors) is defined by the \c init_client() member (or members) of
  79             the \a Protocol class. ProtocolClientSocketHandle defines a number of constructors
  80             taking up to 9 arguments which just forward to a corresponding \a Protocol\c
  81             ::init_client() member. See the documentation of the respective Protocol class for a
  82             detailed documentation of that protocols constructors.
  83          */
  84         ProtocolClientSocketHandle();
  85
  86 #       define BOOST_PP_ITERATION_PARAMS_1 (4, (1, 9, SENF_ABSOLUTE_INCLUDE_PATH(Socket/ProtocolClientSocketHandle.mpp), 1))
  87 #       include BOOST_PP_ITERATE()
  88
  89         /** \brief Create uninitialized socket variable
  90
  91             This special constructor is called when passing \c senf::noinit as only argument to
  92             the constructor. This will create an in-\ref valid() socket handle which can however
  93             be assigned later with another socket instance.
  94
  95             \implementation The socket handle will have no \c body allocated.
  96          */
  97         ProtocolClientSocketHandle(senf::NoInit_t);
  98
  99         ///@}
 100         ///////////////////////////////////////////////////////////////////////////
 101
 102         Protocol & protocol();          ///< Access the protocol interface
 103                                         /**< The returned protocol class reference gives access to
 104                                              the complete protocol interface as defined by that
 105                                              class. See the respective protocol class documentation.
 106                                              \returns \a Protocol class reference */
 107
 108         static ProtocolClientSocketHandle cast_static(FileHandle handle);
 109         static ProtocolClientSocketHandle cast_dynamic(FileHandle handle);
 110
 111         void state(SocketStateMap & map, unsigned lod=0);
 112         std::string dumpState(unsigned lod=0);
 113
 114     protected:
 115         ProtocolClientSocketHandle(FileHandle other, bool isChecked);
 116
 117     private:
 118         friend class ProtocolServerSocketHandle<Protocol>;
 119     };
 120
 121     /// @}
 122 }
 123
 124 ///////////////////////////////hh.e////////////////////////////////////////
 125 //#include "ProtocolClientSocketHandle.cci"
 126 //#include "ProtocolClientSocketHandle.ct"
 127 #include "ProtocolClientSocketHandle.cti"
 128 #include "ProtocolClientSocketHandle.mpp"
 129 #endif
 130
 131 \f
 132 // Local Variables:
 133 // mode: c++
 134 // fill-column: 100
 135 // c-file-style: "senf"
 136 // indent-tabs-mode: nil
 137 // ispell-local-dictionary: "american"
 138 // compile-command: "scons -u test"
 139 // comment-column: 40
 140 // End: