--- /dev/null
+// $Id$
+//
+// Copyright (C) 2006
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
+// Stefan Bund <g0dil@berlios.de>
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the
+// Free Software Foundation, Inc.,
+// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+/** \file
+ \brief FileHandle internal header
+ */
+
+#ifndef IH_SENF_Socket_FileHandle_
+#define IH_SENF_Socket_FileHandle_ 1
+
+// Custom includes
+#include <boost/intrusive_ptr.hpp>
+#include "../Utils/intrusive_refcount.hh"
+#include "../Utils/pool_alloc_mixin.hh"
+
+///////////////////////////////ih.p////////////////////////////////////////
+
+namespace senf {
+
+ class FileHandle;
+
+ /** \brief FileHandle referenced body
+
+ \internal
+
+ The senf::FileBody class forms the body part of the handle/body structure of the FileHandle
+ interface. It manages the FileHandle data and is referenced by senf::FileHandle. It is
+ automatically managed using reference counting.
+
+ Since the senf::FileHandle class forwards most calls directly to the underlying
+ senf::FileBody instance, most members are documented in senf::FileHandle.
+
+ \section filebody_new Writing senf::FileBody derived classes
+
+ It is possible to write customized senf::FileBody derived body implementations. This
+ implementation can then be used be a senf::FileHandle derived class to customize the
+ FileHandle behavior. Handling the body directly by the handle class ensures, that no invalid
+ handles can be created (a senf::FileHandle derived handle expecting a specific body type but
+ pointing to a different body type).
+
+ To customize the behavior, a virtual interface is provided. This interface only covers some
+ basic functionality which is only used infrequently during the lifetime of a FileHandle
+ instance.
+
+ \attention Whenever a new class is derived from FileBody which adds new members, this class
+ \e must also derive from senf::pool_alloc_mixin
+ */
+ class FileBody
+ : public senf::intrusive_refcount,
+ public senf::pool_alloc_mixin<FileBody>
+ {
+ public:
+ ///////////////////////////////////////////////////////////////////////////
+ // Types
+
+ typedef boost::intrusive_ptr<FileBody> ptr;
+
+ ///////////////////////////////////////////////////////////////////////////
+ ///\name Structors and default members
+ ///@{
+
+ explicit FileBody(int fd=-1); ///< Create new instance
+ /**< You need to pass a real file descriptor to this
+ constructor not some arbitrary id even if you overload
+ all the virtual members. If the file descriptor is -1 the
+ resulting body/handle is not valid() */
+ virtual ~FileBody();
+
+ // NO DESTRUCTOR HERE (that is, only an empty virtual destructor) - destructors and virtual
+ // functions don't mix. What would be in the the destructor is in 'destroyClose()' which is
+ // called from FileHandle::~FileHandle() *before* the last handle dies.
+
+ // no copy
+ // no conversion constructors
+
+ ///@}
+ ///////////////////////////////////////////////////////////////////////////
+
+ FileHandle handle();
+
+ int fd() const;
+ void fd(int fd);
+
+ void close();
+ void terminate();
+ void destroyClose();
+
+ bool readable() const;
+ bool waitReadable(senf::ClockService::clock_type timeout) const;
+ bool writeable() const;
+ bool waitWriteable(senf::ClockService::clock_type timeout) const;
+ bool oobReadable() const;
+ bool waitOOBReadable(senf::ClockService::clock_type timeout) const;
+
+ bool blocking() const;
+ void blocking(bool status);
+
+ bool eof() const;
+ bool valid() const;
+
+ private:
+ ///////////////////////////////////////////////////////////////////////////
+ // Virtual interface for subclasses to override
+
+ virtual void v_close(); ///< Called to close the file descriptor
+ /**< You should probably always call the global ::close()
+ function in this member, however you might want to do
+ some additional cleanup here. If the operation fails, you
+ are allowed to throw (preferably a
+ senf::SystemException).
+
+ \throws senf::SystemException */
+ virtual void v_terminate(); ///< Called to forcibly close the file descriptor
+ /**< This member is called by the destructor (and by
+ terminate()) to close the descriptor. This member must \e
+ never throw, it should probably just ignore error
+ conditions (there's not much else you can do) */
+ virtual bool v_eof() const; ///< Called by eof()
+ virtual bool v_valid() const; ///< Called by valid()
+ /**< This member is only called, if the file descriptor is
+ not -1 */
+
+ protected:
+
+ private:
+ bool pollCheck(int fd, bool incoming, int timeout, bool oob=false) const;
+
+ int fd_;
+ };
+
+}
+
+///////////////////////////////ih.e////////////////////////////////////////
+#endif
+
+\f
+// Local Variables:
+// mode: c++
+// fill-column: 100
+// c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// comment-column: 40
+// End:
projects / senf.git / blobdiff