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         There are two types of flags:
  56
  57         \li <em>Event flags</em> (\ref Read, \ref Prio, \ref Write) specify the type of event. The
  58             callback will be called whenever one of the specified events occurs on the filehandle
  59         \li <em>Error flags</em> (\ref Hup, \ref Err) specify some type of error condition on the
  60             filehandle. If you specify an error flag when registering the event, the error condition
  61             will be passed to the callback, otherwise an ErrorException or HangupException will be
  62             thrown.
  63
  64         \see IOEventInfo
  65
  66         \ingroup event_group
  67       */
  68     class IOEvent
  69         : public EventImplementation<IOEventInfo>
  70     {
  71     public:
  72         ///////////////////////////////////////////////////////////////////////////
  73         // Types
  74
  75         // This is stupid, however there is no way to import the Scheduler::EventId enum together
  76         // with the enumeration symbols
  77
  78         enum EventFlags {
  79               Read  = Scheduler::EV_READ   /**< FileHandle is readable */
  80             , Prio = Scheduler::EV_PRIO    /**< FileHandle priority data is readable */
  81             , Write = Scheduler::EV_WRITE  /**< FileHandle is writable */
  82             , Hup = Scheduler::EV_HUP      /**< Hangup condition on FileHandle */
  83             , Err = Scheduler::EV_ERR      /**< Some other error condition on FileHandle */
  84         };
  85
  86         ///////////////////////////////////////////////////////////////////////////
  87         ///\name Structors and default members
  88         ///@{
  89
  90         template <class Handle>
  91         IOEvent(Handle handle, unsigned events);
  92
  93         ///@}
  94         ///////////////////////////////////////////////////////////////////////////
  95
  96         /** \brief Unhandled error condition */
  97         struct ErrorException : public std::exception
  98         { virtual char const * what() const throw()
  99                 { return "senf::ppi::IOEvent::ErrorException"; } };
 100
 101         /** \brief Unhandled hangup condition */
 102         struct HangupException : public std::exception
 103         { virtual char const * what() const throw()
 104                 { return "senf::ppi::IOEvent::HangupException"; } };
 105
 106     protected:
 107
 108     private:
 109         virtual void v_enable();
 110          virtual void v_disable();
 111
 112         void cb(int, Scheduler::EventId event);
 113
 114         int fd_;
 115         unsigned events_;
 116     };
 117
 118
 119 }}
 120
 121 ///////////////////////////////hh.e////////////////////////////////////////
 122 //#include "IOEvent.cci"
 123 //#include "IOEvent.ct"
 124 #include "IOEvent.cti"
 125 #endif
 126
 127 \f
 128 // Local Variables:
 129 // mode: c++
 130 // fill-column: 100
 131 // comment-column: 40
 132 // c-file-style: "senf"
 133 // indent-tabs-mode: nil
 134 // ispell-local-dictionary: "american"
 135 // compile-command: "scons -u test"
 136 // End: