PPI/IOEvent.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
   5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief IOEvent public header */
  25
  26 #ifndef HH_IOEvent_
  27 #define HH_IOEvent_ 1
  28
  29 // Custom includes
  30 #include "Scheduler/Scheduler.hh"
  31 #include "Events.hh"
  32
  33 //#include "IOEvent.mpp"
  34 ///////////////////////////////hh.p////////////////////////////////////////
  35
  36 namespace senf {
  37 namespace ppi {
  38
  39     /** \brief IOEvent event information
  40
  41         Information passed to the IOEvent event handler
  42      */
  43     struct IOEventInfo
  44     {
  45         unsigned events;                ///< Type of event signaled
  46                                         /**< The value is a combination of the flags from
  47                                              IOEvent::EventFlags */
  48     };
  49
  50     /** \brief FileHandle based I/O read/write event
  51
  52         An IOEvent is signaled, whenever the FileHandle \a handle becomes readable or writable. The
  53         type of event is specified using the \a events mask with values from EventFlags.
  54
  55         \fixme Implement error/EOF handling
  56       */
  57     class IOEvent
  58         : public EventImplementation<IOEventInfo>
  59     {
  60     public:
  61         ///////////////////////////////////////////////////////////////////////////
  62         // Types
  63
  64         enum EventFlags { Read  = Scheduler::EV_READ,
  65                           Write = Scheduler::EV_WRITE };
  66
  67         ///////////////////////////////////////////////////////////////////////////
  68         ///\name Structors and default members
  69         ///@{
  70
  71         template <class Handle>
  72         IOEvent(Handle handle, unsigned events);
  73
  74         ///@}
  75         ///////////////////////////////////////////////////////////////////////////
  76
  77     protected:
  78
  79     private:
  80         virtual void v_enable();
  81         virtual void v_disable();
  82
  83         void cb(int, Scheduler::EventId event);
  84
  85         int fd_;
  86         unsigned events_;
  87     };
  88
  89
  90 }}
  91
  92 ///////////////////////////////hh.e////////////////////////////////////////
  93 //#include "IOEvent.cci"
  94 //#include "IOEvent.ct"
  95 #include "IOEvent.cti"
  96 #endif
  97
  98 \f
  99 // Local Variables:
 100 // mode: c++
 101 // fill-column: 100
 102 // comment-column: 40
 103 // c-file-style: "senf"
 104 // indent-tabs-mode: nil
 105 // ispell-local-dictionary: "american"
 106 // compile-command: "scons -u test"
 107 // End: