Packets: Restructure documentation

[senf.git] / Socket / FileHandle.ih

diff --git a/Socket/FileHandle.ih b/Socket/FileHandle.ih
index acde015..84df70c 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
@@ -29,13 +29,14 @@
 
 // Custom includes
 #include <boost/intrusive_ptr.hpp>
-#include "Utils/intrusive_refcount.hh"
-#include "Utils/pool_alloc_mixin.hh"
+#include "../Utils/intrusive_refcount.hh"
+#include "../Utils/pool_alloc_mixin.hh"
 
 ///////////////////////////////ih.p////////////////////////////////////////
 
 namespace senf {
 
+    class FileHandle;
 
     /** \brief FileHandle referenced body
 
@@ -84,17 +85,24 @@ 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;