Socket/FileHandle.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2006
   4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
   5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
   6 //     Stefan Bund <stefan.bund@fokus.fraunhofer.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
  24 /** \mainpage The SENF Socket Library
  25
  26 \section arch Overall Architecture
  27
  28 \image html "../../SocketLibrary-classes.png" Class Diagram
  29
  30  */
  31
  32 #ifndef HH_FileHandle_
  33 #define HH_FileHandle_ 1
  34
  35 // Custom includes
  36 #include <memory> // std::auto_ptr
  37 #include "Utils/SafeBool.hh"
  38
  39 //#include "FileHandle.mpp"
  40 ///////////////////////////////hh.p////////////////////////////////////////
  41 #include "FileHandle.ih"
  42
  43 namespace satcom {
  44 namespace lib {
  45
  46     /** \brief
  47      */
  48     class FileHandle
  49         : public SafeBool<FileHandle>
  50     {
  51     public:
  52         ///////////////////////////////////////////////////////////////////////////
  53         // Types
  54
  55         ///////////////////////////////////////////////////////////////////////////
  56         ///\name Structors and default members
  57         ///@{
  58
  59         // protected default constructor
  60         // default copy constructor
  61         // default copy assignment
  62         // default destructor
  63
  64         // no conversion constructors
  65
  66         ///@}
  67         ///////////////////////////////////////////////////////////////////////////
  68
  69         void close();
  70         void terminate();
  71
  72         bool readable() const;
  73         void waitReadable() const;
  74         bool writeable() const;
  75         void waitWriteable() const;
  76
  77         bool blocking() const;
  78         void blocking(bool status);
  79
  80         bool eof() const;
  81         bool valid() const;
  82
  83         bool boolean_test() const;
  84
  85         int fd() const;
  86
  87         static FileHandle cast_static(FileHandle handle);
  88         static FileHandle cast_dynamic(FileHandle handle);
  89
  90     protected:
  91         explicit FileHandle(std::auto_ptr<FileBody> body);
  92
  93         FileBody & body();
  94         FileBody const & body() const;
  95         static FileBody & body(FileHandle & handle);
  96         static FileBody const & body(FileHandle const & handle);
  97
  98         void fd(int fd);
  99
 100     private:
 101         FileBody::ptr body_;
 102     };
 103
 104     int retrieve_filehandle(FileHandle handle);
 105
 106 }}
 107
 108 ///////////////////////////////hh.e////////////////////////////////////////
 109 #include "FileHandle.cci"
 110 //#include "FileHandle.ct"
 111 //#include "FileHandle.cti"
 112 #endif
 113
 114 \f
 115 // Local Variables:
 116 // mode: c++
 117 // c-file-style: "satcom"
 118 // End: