Socket/SocketHandle.hh

   1 // $Id:SocketHandle.hh 218 2007-03-20 14:39:32Z tho $
   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 SocketHandle public header
  25  */
  26
  27 #ifndef HH_SocketHandle_
  28 #define HH_SocketHandle_ 1
  29
  30 // Custom includes
  31 #include <memory> // std::auto_ptr
  32 #include "FileHandle.hh"
  33 #include "SocketPolicy.hh"
  34
  35 //#include "SocketHandle.mpp"
  36 #include "SocketHandle.ih"
  37 ///////////////////////////////hh.p////////////////////////////////////////
  38 #include "SocketHandle.ih"
  39
  40 namespace senf {
  41
  42     /// \addtogroup handle_group
  43     /// @{
  44
  45     /** \brief basic SocketHandle supporting protocol and policy abstraction
  46
  47         The senf::SocketHandle class introduces the two abstraction layers of the socket
  48         library. senf::SocketHandle does \e not provide socket functions it only provides the
  49         infrastructure necessary to support both, the protocol and the policy interface.
  50
  51         senf::SocketHandle takes the socket policy as a template argument. senf::SocketHandle also
  52         introduces the protocol class. However, the class has no public constructors (see the
  53         derived classes senf::ProtocolClientSocketHandle and senf::ProtocolServerSocketHandle).
  54
  55         The most important functionality provided by senf::SocketHandle is the conversion
  56         constructor. This allows to implicitly convert between compatible socket handle types as
  57         specified by the socket policy. The conversion constructor is defined in such a way, that
  58         only valid conversions are possible (see the implementation source for a more complete
  59         discussion).
  60
  61         \note This class is \e not meant to be used as a base-class outside the library
  62         implementation; The protected interface is for internal use only.
  63
  64         \todo Create a SocketHandleBase class and move some non-Policy dependent code there
  65      */
  66     template <class SPolicy>
  67     class SocketHandle
  68         : public FileHandle
  69     {
  70     public:
  71         ///////////////////////////////////////////////////////////////////////////
  72         // Types
  73
  74         typedef SPolicy Policy;
  75
  76         /** \brief Check policy compatibility
  77
  78             IsCompatible is a template meta-function which will check some other socket policy for
  79             conversion compatibility. This check is used in the senf::SocketPolicy implementation to
  80             restrict the conversion operator.
  81          */
  82         template <class OtherPolicy>
  83         struct IsCompatible
  84             : public boost::enable_if< SocketPolicyIsBaseOf<Policy,OtherPolicy>, SocketHandle >
  85         {};
  86
  87         ///////////////////////////////////////////////////////////////////////////
  88         ///\name Structors and default members
  89         ///@{
  90
  91         // default default constructor
  92         // default copy constructor
  93         // default copy assignment
  94         // default destructor
  95
  96         // here to implement
  97         SocketHandle();
  98
  99         // conversion constructors
 100
 101         template <class OtherPolicy>
 102         SocketHandle(SocketHandle<OtherPolicy> other,
 103                      typename IsCompatible<OtherPolicy>::type * = 0);
 104                                         ///< Convert from other socket handle checking policy
 105                                         ///< compatibility
 106
 107         ///@}
 108         ///////////////////////////////////////////////////////////////////////////
 109
 110         template <class OtherPolicy>
 111         typename IsCompatible<OtherPolicy>::type const & operator=(SocketHandle<OtherPolicy> other);
 112                                         ///< Assign from other socket handle checking policy
 113                                         ///< compatibility
 114
 115         void state(SocketStateMap & map, unsigned lod=0);
 116                                         ///< Inquire state information of socket handle
 117                                         /**< The map argument (a string to string mapping) will be
 118                                              filled with information covering the current state of
 119                                              the socket. The information provided depends on the
 120                                              socket protocol. The amount of information returned can
 121                                              be controlled using the \p lod value.
 122
 123                                              See senf::SocketProtocol::state() for more information,
 124                                              how the Information is generated.
 125
 126                                              \param map string to string mapping to be filled with
 127                                                  state information
 128                                              \param lod level of detail requested. The
 129                                                  interpretation of this value is protocol specific
 130
 131                                              \implementation This member will be re-implemented in
 132                                                  every derived class. This is very important since
 133                                                  state() is \e not a virtual function (which we
 134                                                  don't want since we don't want to add a vtable
 135                                                  pointer to every handle instance). */
 136         std::string dumpState(unsigned lod=0);
 137                                         ///< Format complete state information as string
 138                                         /**< Formats the complete state map value and returns it as
 139                                              a single multi-line string.
 140
 141                                              \param lod level of detail requested. The
 142                                                 interpretation of this value is protocol specific
 143
 144                                              \implementation This member will be re-implemented in
 145                                                  every derived class. See the state()
 146                                                  documentation. */
 147
 148     protected:
 149         explicit SocketHandle(std::auto_ptr<SocketBody> body);
 150                                         ///< Initialize SocketHandle providing the protocol
 151                                         /**< \param protocol Protocol class of the protocol
 152                                                  implemented by this socket handle
 153                                              \param isServer \c true, if this SobcketHandle instance
 154                                                  implements a server handle, \c false otherwise */
 155         SocketHandle(FileHandle other, bool isChecked);
 156                                         ///< Initialize SocketHandle from arbitrary checked
 157                                         ///< FileHandle
 158                                         /**< This constructor is used to support up- and downcasting
 159                                              of SocketHandle instances.
 160
 161                                              \warning It is absolutely necessary to ensure, that the
 162                                                  FileHandle passed in is \e really a SocketHandle
 163                                                  holding a SocketBody (and not a simple FileBody)
 164                                                  instance. Additionally. the SocketPolicy absolutely
 165                                                  must be compatible.
 166
 167                                              \param other FileHandle to assign
 168                                              \param isChecked has to be \c true
 169
 170                                              \todo Answer, why the heck I need the \c isChecked
 171                                                  parameter ?? */
 172
 173         SocketBody & body();            ///< Access socket body
 174                                         /**< This member replaces the corresponding FileHandle
 175                                              member and returns an appropriately cast body
 176                                              reference */
 177         SocketBody const & body() const; ///< Access socket body in const context
 178                                         /**< This member replaces the corresponding FileHandle
 179                                              member and returns an appropriately cast body
 180                                              reference */
 181         SocketProtocol const & protocol() const;
 182                                         ///< Access protocol class
 183
 184         void assign(FileHandle other);  /**< \internal */
 185
 186     public:
 187         static SocketHandle cast_static(FileHandle handle);
 188                                         /**< \internal */
 189         static SocketHandle cast_dynamic(FileHandle handle);
 190                                         /**< \internal */
 191
 192     private:
 193
 194     };
 195
 196     /** \brief Write stream status dump to output stream
 197
 198         Write senf::SocketHandle::dumpState() to \c os
 199
 200         \related senf::SocketHandle
 201      */
 202     template <class SPolicy>
 203     std::ostream & operator<<(std::ostream & os, SocketHandle<SPolicy> handle);
 204
 205     /** \brief static socket (down-)cast
 206
 207         This function is like \c static_cast but for socket handles. It allows to downcast any
 208         FileHandle to any SocketHandle (and its derived types). static_socket_cast will \e not check
 209         the validity of the cast, it will assume, that the cast is valid.
 210
 211         The function will however check, that the cast is possible. Casting between (at compile
 212         time) known incompatible types (like casting a SocketHandle with a communication policy of
 213         ConnectedCommunicationPolicy to a SocketHandle with UnconnectedCommunicationPolicy will fail
 214         at compile time).
 215
 216         \warning
 217         If the type you cast to is not really a compatible socket handle type you will get undefined
 218         behavior, probably your program will crash (You will get an assertion in debug builds).
 219
 220         \related senf::SocketHandle
 221      */
 222     template <class Target, class Source>
 223     Target static_socket_cast(Source handle);
 224
 225     /** \brief dynamic socket (down-)cast
 226
 227         This function is like \c dynamic_cast but for socket handles. It is a runtime typechecked
 228         version of static_socket_cast.
 229
 230         \throws std::bad_cast You have tried to perform an invalid down- or crosscast.
 231
 232         \related senf::SocketHandle
 233      */
 234     template <class Target, class Source>
 235     Target dynamic_socket_cast(Source handle);
 236
 237     /** \brief dynamically check cast validity
 238
 239         This function will check, whether the given cast is valid. This is the same as checking, that
 240         dynamic_socket_cast does not throw.
 241
 242         This member is needed, since there is no 'null' SocketHandle (comparable to a null pointer)
 243         which could be returned by a non-throwing variant of dynamic_socket_cast.
 244
 245         \related senf::SocketHandle
 246      */
 247     template <class Target, class Source>
 248     bool check_socket_cast(Source handle);
 249
 250     /// @}
 251 }
 252
 253 ///////////////////////////////hh.e////////////////////////////////////////
 254 #include "SocketHandle.cci"
 255 #include "SocketHandle.ct"
 256 #include "SocketHandle.cti"
 257 #endif
 258
 259 \f
 260 // Local Variables:
 261 // mode: c++
 262 // fill-column: 100
 263 // c-file-style: "senf"
 264 // indent-tabs-mode: nil
 265 // ispell-local-dictionary: "american"
 266 // compile-command: "scons -u test"
 267 // comment-column: 40
 268 // End: