Implemented global cross-reference generation
[senf.git] / Scheduler / Scheduler.hh
index a535fad..819d70e 100644 (file)
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \mainpage The SENF Scheduler library
+
+ */
+
 #ifndef HH_Scheduler_
 #define HH_Scheduler_ 1
 
@@ -35,8 +39,8 @@
 //#include "scheduler.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
 
-namespace satcom {
-namespace lib {
+/** \brief SENF Project namespace */
+namespace senf {
 
     /** \brief Singleton class to manage the event loop
 
@@ -45,6 +49,9 @@ namespace lib {
         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 ...
       */
     class Scheduler
         : boost::noncopyable
@@ -83,9 +90,9 @@ namespace lib {
         template <class Handle>
         void add(Handle const & handle, 
                  typename GenericCallback<Handle>::Callback const & cb,
-                 EventId eventMask = EV_ALL); 
+                 int eventMask = EV_ALL); 
        template <class Handle>
-        void remove(Handle const & handle, EventId eventMask = EV_ALL);
+        void remove(Handle const & handle, int eventMask = EV_ALL);
 
        void timeout(unsigned long timeout, TimerCallback const & cb);
 
@@ -97,8 +104,8 @@ namespace lib {
     private:
         Scheduler();
        
-        void do_add(int fd, SimpleCallback const & cb, EventId eventMask = EV_ALL);
-        void do_remove(int fd, EventId eventMask = EV_ALL);
+        void do_add(int fd, SimpleCallback const & cb, int eventMask = EV_ALL);
+        void do_remove(int fd, int eventMask = EV_ALL);
 
        struct EventSpec 
         {
@@ -135,7 +142,7 @@ namespace lib {
 
     int retrieve_filehandle(int fd);
 
-}}
+}
 
 ///////////////////////////////hh.e////////////////////////////////////////
 #include "Scheduler.cci"
@@ -146,5 +153,5 @@ namespace lib {
 \f
 // Local Variables:
 // mode: c++
-// c-file-style: "satcom"
+// c-file-style: "senf"
 // End: