Utils/Daemon: Add warning when the scheduler has registered events at a fork()

[senf.git] / Scheduler / FdEvent.hh

diff --git a/Scheduler/FdEvent.hh b/Scheduler/FdEvent.hh
index 90ddc7a..d574351 100644 (file)
--- a/Scheduler/FdEvent.hh
+++ b/Scheduler/FdEvent.hh
@@ -171,6 +171,12 @@ namespace scheduler {
         friend class detail::FileDispatcher;
     };
 
+    /** \brief Get file descriptor from handle object
+
+        This function will query the \a handle for it's file descriptor. The real implementation
+        must be provided by a freestanding function \c retrieve_filehandle(Handle const & h) within
+        the namespace of \a Handle.
+     */
     template <class Handle>
     int get_descriptor(Handle const & handle);
 }}