senf/Scheduler/Poller.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Stefan Bund <g0dil@berlios.de>
  27
  28 /** \file
  29     \brief Poller public header */
  30
  31 #ifndef HH_SENF_Scheduler_Poller_
  32 #define HH_SENF_Scheduler_Poller_ 1
  33
  34 // Custom includes
  35 #include <sys/epoll.h>
  36 #include <boost/utility.hpp>
  37 #include <boost/iterator/transform_iterator.hpp>
  38 #include <boost/range/iterator_range.hpp>
  39
  40 //#include "Poller.mpp"
  41 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  42
  43 namespace senf {
  44 namespace scheduler {
  45 namespace detail {
  46
  47     /** \brief Epoll abstraction
  48
  49         This class provides a more convenient interface to the epoll() API. File descriptors are
  50         registered with pointers to a parameterized event type. After waiting for an event, the
  51         Poller allows to iterate over the event instances for all posted events.
  52
  53         \tparam Value Event type
  54       */
  55     template <class Value>
  56     class Poller
  57         : boost::noncopyable
  58     {
  59         struct GetPollResult
  60         {
  61             typedef std::pair<int, Value*> result_type;
  62             result_type operator()(epoll_event const &) const;
  63         };
  64
  65         static int const NumEvents = 8;
  66
  67     public:
  68         //-////////////////////////////////////////////////////////////////////////
  69         // Types
  70
  71         typedef Value value_type;
  72         typedef boost::transform_iterator<GetPollResult, epoll_event*> iterator;
  73         typedef boost::iterator_range<iterator> range;
  74
  75         enum Events {
  76             EV_READ = EPOLLIN, EV_PRIO = EPOLLPRI, EV_WRITE = EPOLLOUT,
  77             EV_HUP = EPOLLHUP, EV_ERR = EPOLLERR
  78         };
  79
  80         //-////////////////////////////////////////////////////////////////////////
  81         ///\name Structors and default members
  82         //\{
  83
  84         Poller();
  85         ~Poller();
  86
  87         //\}
  88         //-////////////////////////////////////////////////////////////////////////
  89
  90         bool set(int fd, int events, Value * data); ///< Set file descriptor event data and mask
  91                                         /**< The Poller does \e not own \a data. The value is owned
  92                                              by some external entity (the dispatcher to be more
  93                                              precise). */
  94         void remove(int fd);            ///< Remove file descriptor
  95         range wait();                   ///< Wait for one event
  96                                         /**< \returns a range of iterators which iterate over the
  97                                              data values registered with the event */
  98
  99         void timeout(int t);            ///< Set event timeout to \a t milliseconds
 100         int timeout() const;            ///< Current event timeout
 101
 102     private:
 103         int epollFd_;
 104         int timeout_;
 105     };
 106
 107
 108 }}}
 109
 110 //-/////////////////////////////////////////////////////////////////////////////////////////////////
 111 //#include "Poller.cci"
 112 #include "Poller.ct"
 113 #include "Poller.cti"
 114 #endif
 115
 116 \f
 117 // Local Variables:
 118 // mode: c++
 119 // fill-column: 100
 120 // comment-column: 40
 121 // c-file-style: "senf"
 122 // indent-tabs-mode: nil
 123 // ispell-local-dictionary: "american"
 124 // compile-command: "scons -u test"
 125 // End: