X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FSocketWriter.hh;h=118273d26f52e2965f087784337f12843f77f9ab;hb=410b5d6536361b7a7376c38efee92263e793fea4;hp=263f3493ad7503524e6f7c7e5e7172f90ba4e2d6;hpb=122719831e4d0ce7c335a66ed7c80a7ffc2e00e8;p=senf.git

diff --git a/PPI/SocketWriter.hh b/PPI/SocketWriter.hh
index 263f349..118273d 100644
--- a/PPI/SocketWriter.hh
+++ b/PPI/SocketWriter.hh
@@ -25,12 +25,12 @@
 #define HH_SocketWriter_ 1
 
 // Custom includes
-#include "Packets/Packets.hh"
-#include "Socket/ClientSocketHandle.hh"
-#include "Socket/SocketPolicy.hh"
-#include "Socket/ReadWritePolicy.hh"
-#include "Socket/FramingPolicy.hh"
-#include "Socket/CommunicationPolicy.hh"
+#include "../Packets/Packets.hh"
+#include "../Socket/ClientSocketHandle.hh"
+#include "../Socket/SocketPolicy.hh"
+#include "../Socket/ReadWritePolicy.hh"
+#include "../Socket/FramingPolicy.hh"
+#include "../Socket/CommunicationPolicy.hh"
 #include "Module.hh"
 #include "Connectors.hh"
 
@@ -73,7 +73,10 @@ namespace module {
         output module is active. This requires the file handle to be able to signal its readiness to
         accept more data via the Scheduler.
 
-        The \a Writer must fulfill the following interface:
+        The default \a Writer is senf::ppi::PacketWriter which will write out the complete packet to
+        the file handle.
+
+        A \a Writer must fulfill the following interface:
         \code
           class SomeWriter
           {
@@ -83,6 +86,9 @@ namespace module {
               void operator()(Handle handle, Packet packet);       // insertion function
           };
         \endcode
+        Whenever a packet is received for sending, the \a Writer's \c operator() is called.
+
+        \ingroup io_modules
      */
     template <class Writer=PacketWriter>
     class ActiveSocketWriter : public Module
@@ -113,6 +119,9 @@ namespace module {
         mechanism. Either this is desired (like for a UDP socket) or some additional bandwidth
         shaping needs to be used.
 
+        The default \a Writer is senf::ppi::PacketWriter which will write out the complete packet to
+        the file handle.
+
         The \a Writer must fulfill the following interface:
         \code
           class SomeWriter
@@ -123,6 +132,9 @@ namespace module {
               void operator()(Handle handle, Packet packet);       // insertion function
           };
         \endcode
+        Whenever a packet is received for sending, the \a Writer's \c operator() is called.
+
+        \ingroup io_modules
      */
     template <class Writer=PacketWriter>
     class PassiveSocketWriter : public Module