/usr/include/cxxtools/selector.h is in libcxxtools-dev 2.2.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 | /*
* Copyright (C) 2006-2007 Laurentiu-Gheorghe Crisan
* Copyright (C) 2006-2007 Marc Boris Duerner
* Copyright (C) 2006-2007 PTV AG
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* As a special exception, you may use this file as part of a free
* software library without restriction. Specifically, if other files
* instantiate templates or use macros or inline functions from this
* file, or you compile this file and link it with other files to
* produce an executable, this file does not by itself cause the
* resulting executable to be covered by the GNU General Public
* License. This exception does not however invalidate any other
* reasons why the executable file might be covered by the GNU Library
* General Public License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef CXXTOOLS_SYSTEM_SELECTOR_H
#define CXXTOOLS_SYSTEM_SELECTOR_H
#include <cxxtools/timespan.h>
#include <cxxtools/noncopyable.h>
#include <cxxtools/connectable.h>
#include <cxxtools/api.h>
#include <map>
namespace cxxtools {
class Timer;
class Selectable;
class Application;
class SelectorImpl;
/** @brief Reports activity on a set of devices.
A Selector can be used to monitor a set of Selectables and Timers
and wait for activity on them. The wait call can be performed with
a timeout and the respective timeout signal is sent if it occurs.
Clients can be notified about Timer and Selectable activity by
connecting to the appropriate signals of the Timer and Selectable
classes.
The following example uses a %Selector to wait on acitvity on
a %Timer, which is set to time-out after 1000 msecs.
@code
// slot to handle timer activity
void onTimer();
int main()
{
using cxxtools::System;
Timer timer;
timer.start(1000);
connect(timer.timeout, ontimer);
Selector selector;
selector.addTimer(timer);
selector wait();
return 0;
}
@endcode
A Selector is the heart of the EventLoop, which calls Selector::wait
continously. The %EventLoop and %Application classes provide the same API
as the Selector itself.
*/
class CXXTOOLS_API SelectorBase : public Connectable
, protected NonCopyable
{
friend class Selectable;
friend class Timer;
public:
static const std::size_t WaitInfinite = static_cast<const std::size_t>(-1);
//! @brief Destructor
virtual ~SelectorBase();
/** @brief Adds an IOResult
Adds an IOResult to the selector. IOResult are removed
automatically when they get destroyed.
*/
void add(Selectable& s);
/** @brief Cancel an IOResult.
*/
void remove(Selectable& s);
/** @brief Adds a Timer
Adds a Timer to the selector. Timers are removed
automatically when they get destroyed.
@param timer The device to add
*/
void add(Timer& timer);
/** @brief Removes a Timer
@param timer The timer to remove
*/
void remove(Timer& timer);
/** @brief Wait for activity
This method will wait for activity on the registered
Selectables and Timers. Use Selector::WaitInfinite to
wait without timeout.
@param msecs timeout in miliseconds
@return true on timeout
*/
bool wait(std::size_t msecs = WaitInfinite);
/** @brief Wakes the selctor from waiting
This method can be used to end a Selector::wait call
before the timeout expires. It is supposed to be used from
another thread and thus is thread-safe.
*/
void wake();
protected:
//! @brief Default constructor
SelectorBase();
void onAddTimer(Timer& timer);
void onRemoveTimer( Timer& timer );
void onTimerChanged( Timer& timer );
/** @brief A Selectable is added to this %Selector
Do not throw exceptions.
*/
virtual void onAdd(Selectable&) = 0;
/** @brief A Selectable is removed from this %Selector
Do not throw exceptions.
*/
virtual void onRemove(Selectable&) = 0;
/** @brief A Selectable is reinitialised and needs to be updated
Do not throw exceptions.
*/
virtual void onReinit(Selectable&) = 0;
/** @brief A Selectable in this %Selector has changed
Do not throw exceptions.
*/
virtual void onChanged(Selectable& s) = 0;
virtual bool onWait(std::size_t msecs) = 0;
virtual void onWake() = 0;
private:
/** @internal Update all timers and return true if a timer fired
@param timeout interval to next expiring timer
*/
bool updateTimer(size_t& timeout);
//! @internal
typedef std::multimap<Timespan, Timer*> TimerMap;
//! @internal
TimerMap _timers;
void* _reserved;
};
class CXXTOOLS_API Selector : public SelectorBase
{
public:
Selector();
virtual ~Selector();
SelectorImpl& impl();
protected:
void onAdd( Selectable& dev );
void onRemove( Selectable& dev );
void onReinit(Selectable&);
void onChanged(Selectable&);
bool onWait(std::size_t msecs = WaitInfinite);
void onWake();
private:
//! @internal
class SelectorImpl* _impl;
};
} //namespace cxxtools
#endif
|