X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FSocketReader.hh;h=4d6795102a153151dc8c4f18783b48515866d919;hb=53a3d02e7fde841badf42555eba87ccef4566073;hp=5c0ca9e2927ec88347d01f05ba0cbc1296bf35b6;hpb=122719831e4d0ce7c335a66ed7c80a7ffc2e00e8;p=senf.git

diff --git a/PPI/SocketReader.hh b/PPI/SocketReader.hh
index 5c0ca9e..4d67951 100644
--- a/PPI/SocketReader.hh
+++ b/PPI/SocketReader.hh
@@ -81,11 +81,17 @@ namespace module {
           class SomeReader
           {
           public:
-              typedef unspecified_type Handle;        // type of handle requested
-              SomeReader();                           // default constructible
-              Packet::ptr operator()(Handle handle);  // extraction function
+              typedef unspecified_type Handle;   // type of handle requested
+              SomeReader();                      // default constructible
+              Packet operator()(Handle handle);  // extraction function
           };
         \endcode
+        
+        Whenever the FileHandle object is ready for reading, the \a Reader's \c operator() is called
+        to read a packet. The default \a Reader is \c PacketReader<>, which will read packets from a
+        datagram SocketHandle into DataPacket's. You may 
+
+        \ingroup io_modules
      */
     template <class Reader=PacketReader<> >
     class ActiveSocketReader