/usr/include/rutil/Poll.hxx is in libresiprocate-1.9-dev 1.9.6-1.
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 223 224 225 226 227 228 229 230 231 232 233 234 235 | #if !defined(RESIP_POLL_HXX)
#define RESIP_POLL_HXX
#include <memory>
#include <vector>
namespace resip {
///////////////////////////////////////////////////////////////////////////////
class PollImpl;
/**
@brief This class abstracts the Unix system call "poll".
It offers implementations in terms of "poll" itself, "epoll", and "select".
(Respectively #ifdef'd by RESIP_POLL_IMPL_POLL, RESIP_POLL_IMPL_SELECT, and
RESIP_POLL_IMPL_EPOLL.)
File descriptors are wrapped by inner class "Poll::FDEntry".
The actual "poll" call is represented by method "wait", or if an application
wants to control the system call directly, it can instead use methods
"beforeExternWait", "setEntryFDStateForExternWait", and "afterExternWait".
(The latter are selected by #define-ing RESIP_POLL_EXTERN.)
*/
class Poll {
public:
class FDEntry {
friend class Poll;
public:
typedef unsigned short StateBitMask; // FDStateBitMask | ResipStateBitMask.
enum FDStateBitMaskEnum {
fdsbmReadable = 0x0001, // (POLLIN)
fdsbmWritable = 0x0004, // (POLLOUT)
fdsbmError = 0x0008, // (POLLERR)
fdsbmAll = Poll::FDEntry::fdsbmReadable |
Poll::FDEntry::fdsbmWritable |
Poll::FDEntry::fdsbmError
};
typedef StateBitMask FDStateBitMask;
enum ResipStateBitMaskEnum {
rsbmIsTransport = 0x0040,
rsbmIsWritePending = 0x0080
};
typedef StateBitMask ResipStateBitMask;
private:
static
int
compare(const Poll::FDEntry * leftFDEntry,
const Poll::FDEntry * rightFDEntry);
// Fields:
Poll * _poll;
int/*FD*/ _fd;
Poll::FDEntry::StateBitMask _stateBitMask;
unsigned short _index; // Within "_poll->_fdEntryVector".
public:
//constructor
FDEntry(Poll * poll,
bool isTransport,
int/*FD*/ fd);
//destructor
virtual ~FDEntry();
inline
int//FD
getFD() const
{
return _fd;
}
inline
Poll::FDEntry::StateBitMask
getStateBitMask() const
{
return _stateBitMask;
}
void
clearFDState();
protected:
void
setIsWritePending(bool isWritePending);
virtual void doRead() {};
virtual void doWrite() {};
virtual void doError() {};
private:
// Copy constructor: declared but not defined
FDEntry(const Poll::FDEntry & from);
// Assignment: declared but not defined
Poll::FDEntry &
operator=(const Poll::FDEntry & from);
};
friend class Poll::FDEntry;
private:
std::auto_ptr<PollImpl> mImpl;
public:
/*
"waitResult" is the result of method "wait" or "afterExternWait".
Returns the index of the entry with the smallest file descriptor >= "fd" in
"waitResult", or "waitResult.size()" if none exists.
*/
static
int
findFDInWaitResult(int/*FD*/ fd,
const std::vector<Poll::FDEntry *> & waitResult);
//constructor
Poll();
//destructor
~Poll();
#ifdef RESIP_POLL_EXTERN // {
// The result is the set of entries in this poll object.
const std::vector<Poll::FDEntry *> &
beforeExternWait();
/*
If "fd" has no entry in this poll object, ignore it and return false.
Otherwise, set the entry's FD state from "fdStateBitMask" and return true.
If the same "fd" is passed in multiple times, the "fdStateBitMask" are
or-ed together.
*/
bool
setEntryFDStateForExternWait(int/*FD*/ fd,
Poll::FDEntry::StateBitMask fdStateBitMask);
// The result is identical to that of method "wait".
const std::vector<Poll::FDEntry *> &
afterExternWait();
#else //!defined(RESIP_POLL_EXTERN) } {
/*
Wait for I/O on any of this poll object's entry's file descriptors.
More precisely, wait for the file descriptor of any entry with a pending
write to be writable or for any entry's file descriptor to have readable
input or an error.
If "timeoutMilliSeconds" is negative, it means wait indefinitely, otherwise
it indicates the maximum period to wait.
The result is an array of the entries for the file descriptors that are
readable, writable, or error, as specified by each entry's FD state.
The result contains no duplicates and is sorted by file descriptor.
(To service file descriptors with round-robin prioritization, remember the
last file descriptor serviced and use method "Poll::findFDInWaitResult" to
find the index in the result array of the highest priority entry.)
The result is valid until the next call to this method, method
"beforeExternWait", or the destructor.
At some point before then, for each entry in the result, method
"Poll::FDEntry::clearFDState" must be called.
*/
const std::vector<Poll::FDEntry *> &
wait(int timeoutMilliSeconds);
#endif //!defined(RESIP_POLL_EXTERN) }
private:
// Copy constructor: declared but not defined
Poll(const Poll & from);
// Assignment: declared but not defined
Poll &
operator=(const Poll & from);
};
///////////////////////////////////////////////////////////////////////////////
} // namespace resip
#endif //!defined(RESIP_POLL_HXX)
/* ====================================================================
* The Vovida Software License, Version 1.0
*
* Copyright (c) 2000-2005 Jacob Butcher
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The names "VOCAL", "Vovida Open Communication Application Library",
* and "Vovida Open Communication Application Library (VOCAL)" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact vocal@vovida.org.
*
* 4. Products derived from this software may not be called "VOCAL", nor
* may "VOCAL" appear in their name, without prior written
* permission of Vovida Networks, Inc.
*
* THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
* NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL VOVIDA
* NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
* IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
* USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
*/
|