X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Examples%2FUDPClientServer%2FMainpage.dox;h=b5c787580f5ee9c7633ad21e3b92597911a5c044;hb=34700cdc907e04dbe026df9e86d0509990706a31;hp=5d8398227fd7ab70373f86161e437cf55b9bd85f;hpb=3fe2ed38b800bcb57afff676698462e763724245;p=senf.git diff --git a/Examples/UDPClientServer/Mainpage.dox b/Examples/UDPClientServer/Mainpage.dox index 5d83982..b5c7875 100644 --- a/Examples/UDPClientServer/Mainpage.dox +++ b/Examples/UDPClientServer/Mainpage.dox @@ -65,16 +65,17 @@ Scheduler. The \link senf::Scheduler::add add() \endlink call takes two Arguments, the socket to bind to (which can be a lot of things and must not necessarily be a socket instance) and callback function to call, whenever there is an event on that socket.The callback - is specified as a Boost.Function object. - A third argument may be specified to restrict the events, on which the function is called, here we - used the EV_READ Argument, because we just want the program to read from the socket. - The default argument is set to \c senf::Scheduler::EV_ALL, which allows all actions on the socket. + is specified as a + Boost.Function object. A third argument may be specified to restrict the events, on which + the function is called, here we used the EV_READ Argument, because we just want the program to + read from the socket. The default argument is set to \c senf::Scheduler::EV_ALL, which allows + all actions on the socket. \until } Calling the Schedulers \link senf::Scheduler::process process()\endlink method will - start the event loop. This call does not return (ok, it does return in special cases if - \c senf::Scheduler::terminate() is called which does not apply here). The Callback Function is + start the event loop. This call does not return (ok, it does return in special cases if + \c senf::Scheduler::terminate() is called which does not apply here). The Callback Function is the \c readFromClient() Function, which is declared as private here and will be called whenever an event on the socket is encountered. The scheduler passes the event ID to the function.