X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Scheduler%2FScheduler.hh;h=aac4671a62c5aa8b69045d638f6c28e9fc2b6d1f;hb=9a988902090d28007578e93bffd809f6bd913155;hp=819d70e78d88cb06a23df47f2bc74366434600ca;hpb=032707d24b1059febe83ce56b11fd79df106c6e2;p=senf.git diff --git a/Scheduler/Scheduler.hh b/Scheduler/Scheduler.hh index 819d70e..aac4671 100644 --- a/Scheduler/Scheduler.hh +++ b/Scheduler/Scheduler.hh @@ -1,6 +1,6 @@ // $Id$ // -// Copyright (C) 2006 +// Copyright (C) 2006 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS) // Kompetenzzentrum fuer Satelitenkommunikation (SatCom) // Stefan Bund @@ -20,8 +20,8 @@ // Free Software Foundation, Inc., // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -/** \mainpage The SENF Scheduler library - +/** \file + \brief Scheduler public header */ #ifndef HH_Scheduler_ @@ -44,14 +44,28 @@ namespace senf { /** \brief Singleton class to manage the event loop - This class manages a single select() type event loop. A - customer of this class may register any number of file - descriptiors with this class and pass callback functions to be - called on input, output or error. This functions are specified - using boost::function objects - - \todo Fix EventId parameter (probably to int) to allow |-ing - without casting ... + This class manages a single select() type event loop. A customer of this class may register + any number of file descriptors with this class and pass callback functions to be called on + input, output or error. This functions are specified using boost::function objects (See Boost.Function) + + The Scheduler is based on a generic handle representation. The only information needed from + a handle, is the intrinsic file descriptor. Any object for which the statement + \code + int fd = retrieve_filehandle(object); + \endcode + is valid and places the relevant file descriptor into fd can be used as a Handle type. There + is an implementation of retrieve_filehandle(int) within the library to handle explicit file + descriptors. The Socket library provides an + implementation of retrieve_filehandle(FileHandle handle). If you want to support + some other handle type, just define an appropriate \c retrieve_filehandle function in + that types namespace. + + It is important to note, that for every combination of file descriptor and event, only a \e + single handler may be installed. Installing more handlers does not make sense. If you need + to distribute data to several interested parties, you must take care of this yourself. + + \todo Fix EventId parameter (probably to int) to allow |-ing without casting ... */ class Scheduler : boost::noncopyable @@ -60,17 +74,25 @@ namespace senf { /////////////////////////////////////////////////////////////////////////// // Types - enum EventId { EV_NONE=0, - EV_READ=1, EV_PRIO=2, EV_WRITE=4, EV_HUP=8, EV_ERR=16, + /// \brief Types of file descriptor events */ + enum EventId { EV_NONE=0, + EV_READ=1, EV_PRIO=2, EV_WRITE=4, EV_HUP=8, EV_ERR=16, EV_ALL=31 }; + /** \brief Template typedef for Callback type + + This is a template typedef (which does not exist in C++) that is, a template class whose + sole member is a typedef symbol defining the callback type given the handle type. + + The Callback is any callable object taking a \c Handle and an \c EventId as argument. + */ template struct GenericCallback { typedef boost::function::param_type, EventId) > Callback; }; - typedef boost::function SimpleCallback; - typedef boost::function TimerCallback; + /** \brief Callback type for timer events */ + typedef boost::function TimerCallback; /////////////////////////////////////////////////////////////////////////// ///\name Structors and default members @@ -82,32 +104,78 @@ namespace senf { // default destructor // no conversion constructors + /** \brief Return Scheduler instance + + This static member is used to access the singleton instance. This member is save to + return a correctly initialized Scheduler instance even if called at global construction + time + + \implementation This static member just defines the Scheduler as a static method + variable. The C++ standard then provides above guarantee. The instance will be + initialized the first time, the code flow passes the variable declaration found in + the instance() body. + */ static Scheduler & instance(); ///@} /////////////////////////////////////////////////////////////////////////// template - void add(Handle const & handle, + void add(Handle const & handle, typename GenericCallback::Callback const & cb, - int eventMask = EV_ALL); - template - void remove(Handle const & handle, int eventMask = EV_ALL); - - void timeout(unsigned long timeout, TimerCallback const & cb); - - void process(); - void terminate(); + int eventMask = EV_ALL); ///< Add file handle event callback + /**< add() will add a callback to the Scheduler. The + callback will be called for the given type of event on + the given arbitrary file-descriptor or + handle-like object. If there already is a Callback + register ed for one of the events requested, the new + handler will replace the old one. + \param[in] handle file descriptor or handle providing + the Handle interface defined above. + \param[in] cb callback + \param[in] eventMask arbitrary combination via '|' + operator of EventId designators. */ + template + void remove(Handle const & handle, int eventMask = EV_ALL); ///< Remove event callback + /**< remove() will remove any callback registered for any of + the given events on the given file descriptor or handle + like object. + \param[in] handle file descriptor or handle providing + the Handle interface defined above. + \param[in] eventMask arbitrary combination via '|' + operator of EventId designators. */ + + void timeout(unsigned long timeout, TimerCallback const & cb); ///< Add timeout event + /**< \param[in] timeout timeout in milliseconds + \param[in] cb callback to call after \a timeout + milliseconds + \todo Return some kind of handle/pointer and add + support to update or revoke a timeout */ + + void process(); ///< Event handler main loop + /**< This member must be called at some time to enter the + event handler main loop. Only while this function is + running any events are handled. The call will return + only, if any callback calls terminate(). */ + void terminate(); ///< Called by callbacks to terminate the main loop + /**< This member may be called by any callback to tell the + main loop to terminate. The main loop will return to + it's caller after the currently running callback + returns. */ protected: private: + typedef boost::function SimpleCallback; + Scheduler(); - + void do_add(int fd, SimpleCallback const & cb, int eventMask = EV_ALL); void do_remove(int fd, int eventMask = EV_ALL); - struct EventSpec + /** \brief Descriptor event specification + \internal */ + struct EventSpec { SimpleCallback cb_read; SimpleCallback cb_prio; @@ -117,41 +185,53 @@ namespace senf { int epollMask() const; }; - - struct TimerSpec - { - TimerSpec() : timeout(), cb() {} + + /** \brief Timer event specification + \internal */ + struct TimerSpec + { + TimerSpec() : timeout(), cb() {} TimerSpec(unsigned long long timeout_, TimerCallback cb_) : timeout(timeout_), cb(cb_) {} - bool operator< (TimerSpec const & other) const - { return timeout > other.timeout; } - - unsigned long long timeout; - TimerCallback cb; - }; - + bool operator< (TimerSpec const & other) const + { return timeout > other.timeout; } + + unsigned long long timeout; + TimerCallback cb; + }; + typedef std::map FdTable; - typedef std::priority_queue TimerQueue; + typedef std::priority_queue TimerQueue; FdTable fdTable_; - TimerQueue timerQueue_; + TimerQueue timerQueue_; int epollFd_; bool terminate_; }; + /** \brief Default file descriptor accessor + + retrieve_filehandle() provides the Scheduler with support for explicit file descriptors as + file handle argument. + + \relates Scheduler + */ int retrieve_filehandle(int fd); } ///////////////////////////////hh.e//////////////////////////////////////// #include "Scheduler.cci" -#include "Scheduler.ct" +//#include "Scheduler.ct" #include "Scheduler.cti" #endif // Local Variables: // mode: c++ +// fill-column: 100 // c-file-style: "senf" +// indent-tabs-mode: nil +// ispell-local-dictionary: "american" // End: