X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FSocketReader.hh;h=c85060342e54d8c1c9df0632eb9f39b627e2b415;hb=739eecfbeffc911e700660864ff1d7f05c6283d0;hp=5c0ca9e2927ec88347d01f05ba0cbc1296bf35b6;hpb=122719831e4d0ce7c335a66ed7c80a7ffc2e00e8;p=senf.git diff --git a/PPI/SocketReader.hh b/PPI/SocketReader.hh index 5c0ca9e..c850603 100644 --- a/PPI/SocketReader.hh +++ b/PPI/SocketReader.hh @@ -25,11 +25,11 @@ #define HH_SocketReader_ 1 // Custom includes -#include "Packets/Packets.hh" -#include "Socket/ClientSocketHandle.hh" -#include "Socket/SocketPolicy.hh" -#include "Socket/ReadWritePolicy.hh" -#include "Socket/FramingPolicy.hh" +#include "../Packets/Packets.hh" +#include "../Socket/ClientSocketHandle.hh" +#include "../Socket/SocketPolicy.hh" +#include "../Socket/ReadWritePolicy.hh" +#include "../Socket/FramingPolicy.hh" #include "Module.hh" #include "Connectors.hh" #include "IOEvent.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 ActiveSocketReader