Socket: Ignore ECONNREFUSED on write to datagram socket
[senf.git] / PPI / IOEvent.hh
index 4e143b2..d36fcb7 100644 (file)
@@ -27,8 +27,8 @@
 #define HH_IOEvent_ 1
 
 // Custom includes
-#include "Events.hh"
 #include "Scheduler/Scheduler.hh"
+#include "Events.hh"
 
 //#include "IOEvent.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
 namespace senf {
 namespace ppi {
 
+    /** \brief IOEvent event information
+
+        Information passed to the IOEvent event handler
+     */
     struct IOEventInfo
     {
-        unsigned events;
+        unsigned events;                ///< Type of event signaled
+                                        /**< The value is a combination of the flags from
+                                             IOEvent::EventFlags */
     };
 
-    /** \brief
+    /** \brief FileHandle based I/O read/write event
+
+        An IOEvent is signaled, whenever the FileHandle \a handle becomes readable or writable. The
+        type of event is specified using the \a events mask with values from EventFlags.
+
+        \fixme Implement error/EOF handling
+
+        \see IOEventInfo
+
+        \ingroup event_group
       */
     class IOEvent
         : public EventImplementation<IOEventInfo>