/usr/include/ptlib/timer.h is in libpt2.4.5-dev 2.4.5-2build1.
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 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 | /*
* timer.h
*
* Real time down counting time interval class.
*
* Portable Windows Library
*
* Copyright (c) 1993-1998 Equivalence Pty. Ltd.
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is Portable Windows Library.
*
* The Initial Developer of the Original Code is Equivalence Pty. Ltd.
*
* Portions are Copyright (C) 1993 Free Software Foundation, Inc.
* All Rights Reserved.
*
* Contributor(s): ______________________________________.
*
* $Revision: 20385 $
* $Author: rjongbloed $
* $Date: 2008-06-04 10:40:38 +0000 (Wed, 04 Jun 2008) $
*/
#ifndef _PTIMER
#define _PTIMER
#ifdef P_USE_PRAGMA
#pragma interface
#endif
class PThread;
#include <ptlib/notifier.h>
/**
A class representing a system timer. The time interval ancestor value is
the amount of time left in the timer.
A timer on completion calls the virtual function #OnTimeout()#. This
will in turn call the callback function provided by the instance. The user
may either override the virtual function or set a callback as desired.
A list of active timers is maintained by the applications #PProcess#
instance and the timeout functions are executed in the context of a single
thread of execution. There are many consequences of this: only one timeout
function can be executed at a time and thus a user should not execute a
lot of code in the timeout call-back functions or it will dealy the timely
execution of other timers call-back functions.
Also timers are not very accurate in sub-second delays, even though you can
set the timer in milliseconds, its accuracy is only to -0/+250 ms. Even
more (potentially MUCH more) if there are delays in the user call-back
functions.
Another trap is you cannot destroy a timer in its own call-back. There is
code to cause an assert if you try but it is very easy to accidentally do
this when you delete an object that contains an onject that contains the
timer!
Finally static timers cause race conditions on start up and termination and
should be avoided.
*/
class PTimer : public PTimeInterval
{
PCLASSINFO(PTimer, PTimeInterval);
public:
typedef unsigned IDType;
/**@name Construction */
//@{
/** Create a new timer object and start it in one shot mode for the
specified amount of time. If the time was zero milliseconds then the
timer is {\bf not} started, ie the callback function is not executed
immediately.
*/
PTimer(
long milliseconds = 0, ///< Number of milliseconds for timer.
int seconds = 0, ///< Number of seconds for timer.
int minutes = 0, ///< Number of minutes for timer.
int hours = 0, ///< Number of hours for timer.
int days = 0 ///< Number of days for timer.
);
PTimer(
const PTimeInterval & time ///< New time interval for timer.
);
/** Restart the timer in one shot mode using the specified time value. If
the timer was already running, the "time left" is simply reset.
@return
reference to the timer.
*/
PTimer & operator=(
DWORD milliseconds ///< New time interval for timer.
);
PTimer & operator=(
const PTimeInterval & time ///< New time interval for timer.
);
/** Destroy the timer object, removing it from the applications timer list
if it was running.
*/
virtual ~PTimer();
//@}
/**@name Control functions */
//@{
/** Set the value of the time interval. The time interval, in milliseconds,
is the sum of all of the parameters. For example all of the following
are equivalent:
\begin{verbatim}
SetInterval(120000)
SetInterval(60000, 60)
SetInterval(60000, 0, 1)
SetInterval(0, 60, 1)
SetInterval(0, 0, 2)
\end{verbatim}
*/
virtual void SetInterval(
PInt64 milliseconds = 0, ///< Number of milliseconds for interval.
long seconds = 0, ///< Number of seconds for interval.
long minutes = 0, ///< Number of minutes for interval.
long hours = 0, ///< Number of hours for interval.
int days = 0 ///< Number of days for interval.
);
/** Start a timer in continous cycle mode. Whenever the timer runs out it
is automatically reset to the time specified. Thus, it calls the
notification function every time interval.
*/
void RunContinuous(
const PTimeInterval & time // New time interval for timer.
);
/** Stop a running timer. The timer will not call the notification function
and is reset back to the original timer value. Thus when the timer
is restarted it begins again from the beginning.
The wait flag indicates that the function should wait for the timeout
callback to complete before returning. That way external logic can be
assured there is no race condition. However, under some circumstances
this can cause a deadlock if the timeout function tries to acquire a
mutex the calling thread already has, so an aysnchronouse version is
provided. It is then the responsibility of the caller to handle the
race condition with the timeout function.
*/
void Stop(
bool wait = true
);
/** Determine if the timer is currently running. This really is only useful
for one shot timers as repeating timers are always running.
@return
PTrue if timer is still counting.
*/
PBoolean IsRunning() const;
/** Pause a running timer. This differs from the #Stop()# function in
that the timer may be resumed at the point that it left off. That is
time is "frozen" while the timer is paused.
*/
void Pause();
/** Restart a paused timer continuing at the time it was paused. The time
left at the moment the timer was paused is the time until the next
call to the notification function.
*/
void Resume();
/** Determine if the timer is currently paused.
@return
PTrue if timer paused.
*/
PBoolean IsPaused() const;
/** Restart a timer continuing from the time it was initially.
*/
void Reset();
/** Get the time this timer was set to initially.
*/
const PTimeInterval & GetResetTime() const;
//@}
/**@name Notification functions */
//@{
/**This function is called on time out. That is when the system timer
processing decrements the timer from a positive value to less than or
equal to zero. The interval is then reset to zero and the function
called.
Please note that the application should not execute large amounts of
code in this call back or the accuracy of ALL timers can be severely
impacted.
The default behaviour of this function is to call the #PNotifier#
callback function.
*/
virtual void OnTimeout();
/** Get the current call back function that is called whenever the timer
expires. This is called by the #OnTimeout()# function.
@return
current notifier for the timer.
*/
const PNotifier & GetNotifier() const;
/** Set the call back function that is called whenever the timer expires.
This is called by the #OnTimeout()# function.
*/
void SetNotifier(
const PNotifier & func // New notifier function for the timer.
);
//@}
/**@name Global real time functions */
//@{
/** Get the number of milliseconds since some arbtrary point in time. This
is a platform dependent function that yields a real time counter.
Note that even though this function returns milliseconds, the value may
jump in minimum quanta according the platforms timer system, eg under
MS-DOS and MS-Windows the values jump by 55 every 55 milliseconds. The
#Resolution()# function may be used to determine what the minimum
time interval is.
@return
millisecond counter.
*/
static PTimeInterval Tick();
/** Get the smallest number of milliseconds that the timer can be set to.
All actual timing events will be rounded up to the next value. This is
typically the platforms internal timing units used in the #Tick()#
function.
@return
minimum number of milliseconds per timer "tick".
*/
static unsigned Resolution();
//@}
IDType GetTimerId() const { return timerId; }
private:
void Construct();
/* Start or restart the timer from the #resetTime# variable.
This is an internal function.
*/
void StartRunning(
PBoolean once // Flag for one shot or continuous.
);
/* Process the timer decrementing it by the delta amount and calling the
#OnTimeout()# when zero. This is used internally by the
#PTimerList::Process()# function.
*/
void Process(
const PTimeInterval & delta, // Time interval since last call.
PTimeInterval & minTimeLeft // Minimum time left till next timeout.
);
// Member variables
// Callback function for expired timers.
PNotifier callback;
// The time to reset a timer to when RunContinuous() is called.
PTimeInterval resetTime;
// Timer operates once then stops.
PBoolean oneshot;
// Timer state.
enum { Stopped, Starting, Running, Paused } state;
friend class PTimerList; // needed for Process
class PTimerList * timerList;
IDType timerId;
// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/timer.h"
#else
#include "unix/ptlib/timer.h"
#endif
};
#endif
// End Of File ///////////////////////////////////////////////////////////////
|