PPI: Add missing TargetDgramWriter doku

[senf.git] / Socket / FileHandle.ih

diff --git a/Socket/FileHandle.ih b/Socket/FileHandle.ih
index 25b45c7..b13f2fe 100644 (file)
--- a/Socket/FileHandle.ih
+++ b/Socket/FileHandle.ih
@@ -1,9 +1,9 @@
 // $Id$
 //
 // Copyright (C) 2006
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
-//     Stefan Bund <stefan.bund@fokus.fraunhofer.de>
+// 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
@@ -24,23 +24,25 @@
     \brief FileHandle internal header
  */
 
-#ifndef IH_FileHandle_
-#define IH_FileHandle_ 1
+#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/intrusive_refcount.hh"
+#include "../Utils/pool_alloc_mixin.hh"
 
 ///////////////////////////////ih.p////////////////////////////////////////
 
 namespace senf {
 
+    class FileHandle;
 
     /** \brief FileHandle referenced body
 
         \internal
 
-        The senf::FileBody class formes the body part of the handle/body structure of the FileHandle
+        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.
 
@@ -56,12 +58,15 @@ namespace senf {
         pointing to a different body type).
 
         To customize the behavior, a virtual interface is provided. This interface only covers some
-        basic funcionality which is only used infrequently during the lifetime of a FileHandle
+        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::intrusive_refcount, 
+          public senf::pool_alloc_mixin<FileBody>
     {
     public:
         ///////////////////////////////////////////////////////////////////////////
@@ -80,22 +85,31 @@ namespace senf {
                                            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;
-        void waitReadable() const;
+        bool waitReadable(senf::ClockService::clock_type timeout) const;
         bool writeable() const;
-        void waitWriteable() 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);
@@ -128,7 +142,7 @@ namespace senf {
     protected:
 
     private:
-        bool pollCheck(int fd, bool incoming, bool block=false) const;
+        bool pollCheck(int fd, bool incoming, int timeout, bool oob=false) const;
 
         int fd_;
     };
@@ -145,4 +159,6 @@ namespace senf {
 // c-file-style: "senf"
 // indent-tabs-mode: nil
 // ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// comment-column: 40
 // End: