Socket/FileHandle.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 FileHandle public header
  25  */
  26
  27 /** \defgroup handle_group The Handle Hierarchy
  28
  29     <div class="diamap" name="FhHierarchy">
  30     <span coords="233,47,438,89">\ref SocketHandle</span>
  31     <span coords="32,126,281,168">\ref ClientSocketHandle</span>
  32     <span coords="0,187,326,229">\ref ProtocolClientSocketHandle</span>
  33     <span coords="350,187,684,229">\ref ProtocolServerSocketHandle</span>
  34     <span coords="243,0,343,28">\ref FileHandle</span>
  35     <span coords="382,126,638,168">\ref ServerSocketHandle</span>
  36     </div>
  37     \htmlonly <img src="FhHierarchy.png" border="0" alt="FhHierarchy" usemap="#FhHierarchy"> \endhtmlonly
  38
  39     The senf::FileHandle class is the base of a hierarchy of socket handle classes (realized as
  40     templates). These classes provide an interface to the complete socket API. While going down the
  41     inheritance hierarchy, the interface will be more and more complete.
  42
  43     The most complete interface is provided by senf::ProtocolClientSocketHandle and
  44     senf::ProtocolServerSocketHandle. The template Arguments specifies the Protocol class of the
  45     underlying socket type. These are the \e only classes having public constructors and are
  46     therefore the only classes, which may be created by the library user. You will normally use
  47     these classes by naming a specific socket typedef (e.g. senf::TCPv4ClientSocketHandle).
  48
  49     However, to aid writing flexible and generic code, the socket library provides the
  50     senf::ClientSocketHandle and senf::ServerSocketHandle class templates. These templates implement
  51     a family of closely related classes based on the specification of the socket policy. This policy
  52     specification may be \e incomplete (see below). Instances of
  53     senf::ClientSocketHandle/senf::ServerSocketHandle can be assigned and converted to different
  54     ClientSocketHandle/ServerSocketHandle types as long as the policy specifications are compatible.
  55
  56     \attention It is very important, to (almost) always pass the socket handle <em>by
  57     value</em>. The socket handle is a very lightweight class and designed to be used like an
  58     ordinary built-in type. This is very important in combination with the policy interface.
  59
  60     \note The FileHandle hierarchy below the SocketHandle template is \e not meant to be user
  61     extensible. To add new socket types, you should introduce new protocol and/or policy classes,
  62     the SocketHandle classes should not be changed.
  63  */
  64
  65 #ifndef HH_SENF_Socket_FileHandle_
  66 #define HH_SENF_Socket_FileHandle_ 1
  67
  68 // Custom includes
  69 #include <memory> // std::auto_ptr
  70 #include "../Utils/safe_bool.hh"
  71
  72 //#include "FileHandle.mpp"
  73 ///////////////////////////////hh.p////////////////////////////////////////
  74 #include "FileHandle.ih"
  75
  76 namespace senf {
  77
  78     /// \addtogroup handle_group
  79     /// @{
  80
  81     /** \brief Basic file handle wrapper
  82
  83         senf::FileHandle provides a simple wrapper for arbitrary file handles. It exposes only a
  84         minimal interface which does \e not include reading or writing (since some filehandles are
  85         not readable or writable or only using special function calls like sendto).
  86
  87         The FileHandle class provides handle/body handling and uses automatic reference
  88         counting. The senf::FileHandle instance is very lightweight and should be used like a
  89         built-in type.
  90
  91         \attention You should mostly pass around senf::FileHandle objects by \e value and not by
  92         reference.
  93
  94         The FileHandle abstraction is only applicable to real filehandles. It is \e not possible to
  95         wrap any provider or consumer into a filehandle like interface using this wrapper. The
  96         wrapper will forward some calls directly to the underlying API without relying on virtual
  97         methods. This allows important members to be inlined.
  98
  99         It is not possible to use the senf::FileHandle class directly since it does not have any
 100         public constructor. The FileHandle class is however the baseclass of all handle classes of
 101         the socket library.
 102
 103         \section filehandle_new Writing senf::FileHandle derived classes
 104
 105         To build a new FileHandle type you need to derive from senf::FileHandle. The derived class
 106         will have to call the protected FileHandle constructor passing a new senf::FileBody
 107         instance. This instance may either be a simple senf::FileBody or a class derived from
 108         senf::FileBody.
 109      */
 110     class FileHandle
 111         : public safe_bool<FileHandle>
 112     {
 113     public:
 114         ///////////////////////////////////////////////////////////////////////////
 115         // Types
 116
 117         ///////////////////////////////////////////////////////////////////////////
 118         ///\name Structors and default members
 119         ///@{
 120
 121         FileHandle();
 122         ~FileHandle();
 123
 124         // my default constructor
 125         // default copy constructor
 126         // default copy assignment
 127         // default destructor
 128
 129         // no conversion constructors
 130
 131         ///@}
 132         ///////////////////////////////////////////////////////////////////////////
 133
 134         void close();                ///< Close filehandle
 135                                      /**< \throws senf::SystemException */
 136         void terminate();            ///< Close filehandle ignoring error conditions
 137
 138         bool readable() const;       ///< Check, whether a read on the handle would not block
 139                                      ///< (ignoring blocking state)
 140         void waitReadable() const;   ///< Wait, until read on the handle would not block (ignoring
 141                                      ///< blocking state)
 142         bool writeable() const;      ///< Check, whether a write on the handle would not block
 143                                      ///< (ignoring blocking state)
 144         void waitWriteable() const;  ///< Wait, until a write on the handle would not block
 145                                      ///< (ignoring blocking state)
 146         bool oobReadable() const;    ///< Check, whether a read of prioritized data on the handle
 147                                      ///< would not block (ignoring blocking state)
 148         void waitOOBReadable() const; ///< Wait, until read of prioritized data on the handle does
 149                                      ///< not block (ignoring blocking state)
 150
 151         bool blocking() const;       ///< Return current blocking state
 152         void blocking(bool status);  ///< Set blocking state
 153
 154         bool eof() const;            ///< Check EOF condition
 155                                      /**< Depending on the socket type, this might never return \p
 156                                         true.
 157
 158                                         This member is somewhat problematic performance wise if
 159                                         called frequently since it relies on virtual
 160                                         functions. However, since the eof() handling is extremely
 161                                         protocol dependent, a policy based implementation does not
 162                                         seam feasible. */
 163         bool valid() const;          ///< Check filehandle validity
 164                                      /**< Any operation besides valid() will fail on an invalid
 165                                         FileHandle */
 166
 167         bool boolean_test() const;  ///< Short for valid() && ! eof()
 168                                     /**< This is called when using a FileHandle instance in a boolean
 169                                        context
 170
 171                                        See the performance comments for the eof() member */
 172
 173         int fd() const;             ///< Return the raw FileHandle
 174
 175         static FileHandle cast_static(FileHandle handle);  /**< \internal */
 176         static FileHandle cast_dynamic(FileHandle handle); /**< \internal */
 177
 178     protected:
 179         explicit FileHandle(std::auto_ptr<FileBody> body);
 180                                     ///< create new FileHandle instance
 181                                     /**< The FileHandle instance will take over ownership over the
 182                                        given FileBody instance which must have been allocated using
 183                                        \c new. To configure the FileHandle behavior, A derived class
 184                                        may provide any class derived from FileBody here. */
 185
 186         explicit FileHandle(FileBody::ptr body);
 187
 188         FileBody & body();          ///< Access body
 189         FileBody const & body() const; ///< Access body in const context
 190         static FileBody & body(FileHandle & handle); ///< Access body of another FileHandle instance
 191         static FileBody const & body(FileHandle const & handle); ///< Access body of another
 192                                     ///< FileHandle instance in const context
 193
 194         void fd(int fd);            ///< Set raw filehandle
 195
 196     private:
 197         FileBody::ptr body_;
 198
 199         friend class FileBody;
 200     };
 201
 202     /** \brief Adapt FileHandle to senf::scheduler
 203         \related senf::FileHandle
 204
 205         \internal
 206
 207         This function will be called by the Scheduler to retrieve the file descriptor of the
 208         FileHandle.
 209      */
 210     int retrieve_filehandle(FileHandle handle);
 211
 212     /// @}
 213
 214 }
 215
 216 ///////////////////////////////hh.e////////////////////////////////////////
 217 #include "FileHandle.cci"
 218 //#include "FileHandle.ct"
 219 //#include "FileHandle.cti"
 220 #endif
 221
 222 \f
 223 // Local Variables:
 224 // mode: c++
 225 // fill-column: 100
 226 // c-file-style: "senf"
 227 // indent-tabs-mode: nil
 228 // ispell-local-dictionary: "american"
 229 // compile-command: "scons -u test"
 230 // comment-column: 40
 231 // End: