4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
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.
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.
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.
24 \brief FdDispatcher public header */
26 #ifndef HH_FdDispatcher_
27 #define HH_FdDispatcher_ 1
30 #include "../boost/intrusive/iset_hook.hpp"
31 #include "../Utils/Exception.hh"
32 #include "FdManager.hh"
33 #include "FIFORunner.hh"
35 //#include "FdEvent.mpp"
36 ///////////////////////////////hh.p////////////////////////////////////////
43 typedef boost::intrusive::iset_base_hook<FdSetTag> FdSetBase;
50 /** \brief File descriptor event
52 The FdEvent class registers a file descriptor for read or write events.
54 The type of event is specified using an event mask. Possible events are
56 \li \c EV_READ: File descriptor is readable (or at EOF)
57 \li \c EV_PRIO: There is out-of-band data available to be read on the file descriptor
58 \li \c EV_WRITE: File descriptor is writable
60 These event flags can be or-ed together to form an event mask. The callback will be called
61 with those flags set which are currently signaled. There are additional flags which may be
62 set when calling the callback:
64 \li \c EV_HUP: The other end has closed the connection
65 \li \c EV_ERR: Transport error
67 The file descriptor is specified using an arbitrary handle type which supports the \c
68 retrieve_filehandle() protocol: There must be a global function \c retrieve_filehandle
69 callable with the handle type. This function must return the file descriptor associated with
70 the handle. Implementations for integer numbers (explicit file descriptors) and senf socket
73 The FdEvent class is an implementation of the RAII idiom: The event will be automatically
74 unregistered in the FdEvent destructor. The TimerEvent instance should be created
75 within the same scope or on a scope below where the callback is defined (e.g. if the
76 callback is a member function it should be defined as a class member).
79 : public detail::FIFORunner::TaskInfo,
80 public detail::FdSetBase,
81 public detail::FdManager::Event
84 ///////////////////////////////////////////////////////////////////////////
87 typedef boost::function<void (int)> Callback;
91 EV_READ = detail::FdManager::EV_READ,
92 EV_PRIO = detail::FdManager::EV_PRIO,
93 EV_WRITE = detail::FdManager::EV_WRITE,
94 EV_HUP = detail::FdManager::EV_HUP,
95 EV_ERR = detail::FdManager::EV_ERR,
96 EV_ALL = (detail::FdManager::EV_READ
97 | detail::FdManager::EV_WRITE
98 | detail::FdManager::EV_PRIO)
101 ///////////////////////////////////////////////////////////////////////////
102 ///\name Structors and default members
105 template <class Handle>
106 FdEvent(std::string const & name, Callback const & cb, Handle const & handle, int events,
107 bool initiallyEnabled = true);
108 ///< Register a file descriptor event
109 /**< Registers \a cb to be called when any of the \a events
110 occurs on \a handle. If \a initiallyEnabled is set \c
111 false, the callback will not be enabled
112 automatically. Use enable() to do so.
113 \param[in] name Descriptive event name (purely
115 \param[in] cb Callback to call
116 \param[in] handle Handle (file descriptor) to watch
117 \param[in] events Events to watch for (see Events enum)
118 \param[in] initiallyEnabled if set \c false, do not
119 enable callback automatically. */
120 FdEvent(std::string const & name, Callback const & cb);
121 ///< Create a file descriptor event
122 /**< Creates a file descriptor event for callback \a cb. The
123 event is initially disabled. Use the other members to
124 set the missing parameters and enable the event.
125 \param[in] name Descriptive event name (purely
127 \param[in] cb Callback to call. This callback may \e
128 explicitly be set to \c 0 if the value cannot be
133 ///////////////////////////////////////////////////////////////////////////
135 void disable(); ///< Disable event
136 void enable(); ///< Enable event
137 bool enabled(); ///< \c true if event enabled, \c false otherwise
139 FdEvent & action(Callback const & cb); ///< Change event callback
141 FdEvent & events(int events); ///< Change event mask
142 FdEvent & addEvents(int events); ///< Add additional events to event mask
143 FdEvent & removeEvents(int events); ///< Remove events from event mask
144 int events(); ///< Current event mask
146 template <class Handle>
147 FdEvent & handle(Handle const & handle); ///< Change event file handle
149 struct DuplicateEventRegistrationException : public Exception
150 { DuplicateEventRegistrationException() : Exception("duplicate fd event registration") {} };
155 virtual void signal(int events);
164 friend class detail::FdSetCompare;
165 friend class detail::FindFd;
166 friend class detail::FdDispatcher;
167 friend class detail::FileDispatcher;
170 int retrieve_filehandle(int fd);
174 ///////////////////////////////hh.e////////////////////////////////////////
175 #include "FdEvent.cci"
176 #include "FdEvent.ct"
177 #include "FdEvent.cti"
184 // comment-column: 40
185 // c-file-style: "senf"
186 // indent-tabs-mode: nil
187 // ispell-local-dictionary: "american"
188 // compile-command: "scons -u test"