/usr/include/x86_64-linux-gnu/qcc/Timer.h is in liballjoyn-common-dev-1504 15.04b-8.
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 | /**
* @file
*
* Timer declaration
*/
/******************************************************************************
* Copyright AllSeen Alliance. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
******************************************************************************/
#ifndef _QCC_TIMER_H
#define _QCC_TIMER_H
#include <qcc/platform.h>
#include <qcc/Debug.h>
#include <qcc/atomic.h>
#include <set>
#include <deque>
#include <qcc/Mutex.h>
#include <qcc/time.h>
#include <qcc/String.h>
#include <qcc/ManagedObj.h>
#include <qcc/Alarm.h>
namespace qcc {
/** @internal Forward declaration */
class Timer;
class _Alarm;
class TimerImpl;
class TimerThread;
class Timer {
public:
/**
* Constructor
*
* @param name Name for the thread.
* @param expireOnExit If true call all pending alarms when this thread exits.
* @param concurrency Dispatch up to this number of alarms concurently (using multiple threads).
* @param prevenReentrancy Prevent re-entrant call of AlarmTriggered.
* @param maxAlarms Maximum number of outstanding alarms allowed before blocking calls to AddAlarm or 0 for infinite.
*/
Timer(qcc::String name, bool expireOnExit = false, uint32_t concurrency = 1, bool preventReentrancy = false, uint32_t maxAlarms = 0);
/**
* Destructor.
*/
~Timer();
/**
* Start the timer.
*
* @return ER_OK if successful.
*/
QStatus Start();
/**
* Stop the timer (and its associated threads).
*
* @return ER_OK if successful.
*/
QStatus Stop();
/**
* Join the timer.
* Block the caller until all the timer's threads are stopped.
*
* @return ER_OK if successful.
*/
QStatus Join();
/**
* Return true if Timer is running.
*
* @return true iff timer is running.
*/
bool IsRunning() const;
/**
* Associate an alarm with a timer.
*
* @param alarm Alarm to add.
* @return ER_OK if alarm was added
* ER_TIMER_EXITING if timer is exiting
*/
QStatus AddAlarm(const Alarm& alarm);
/**
* Associate an alarm with a timer.
* Non-blocking version.
*
* @param alarm Alarm to add.
* @return ER_OK if alarm was added
* ER_TIMER_FULL if timer has maximum allowed alarms
* ER_TIMER_EXITING if timer is exiting
*/
QStatus AddAlarmNonBlocking(const Alarm& alarm);
/**
* Disassociate an alarm from a timer.
*
* @param alarm Alarm to remove.
* @param blockIfTriggered If alarm has already been triggered, block the caller until AlarmTriggered returns.
* @return true iff the given alarm was found and removed.
*/
bool RemoveAlarm(const Alarm& alarm, bool blockIfTriggered = true);
bool ForceRemoveAlarm(const Alarm& alarm, bool blockIfTriggered = true);
/**
* Remove any alarm for a specific listener returning the alarm. Returns a boolean if an alarm
* was removed. This function is designed to be called in a loop to remove all alarms for a
* specific listener. For example this function would be called from the listener's destructor.
* The alarm is returned so the listener can free and resource referenced by the alarm.
*
* @param listener The specific listener.
* @param alarm Alarm that was removed
* @return true iff the given alarm was found and removed.
*/
bool RemoveAlarm(const AlarmListener& listener, Alarm& alarm);
/**
* Replace an existing Alarm.
* Alarms that are already "in-progress" (meaning they are scheduled for callback) cannot be replaced.
* In this case, RemoveAlarm will return ER_NO_SUCH_ALARM and may optionally block until the triggered
* alarm's AlarmTriggered callback has returned.
*
* @param origAlarm Existing alarm to be replaced.
* @param newAlarm Alarm that will replace origAlarm if found.
* @param blockIfTriggered If alarm has already been triggered, block the caller until AlarmTriggered returns.
*
* @return ER_OK if alarm was replaced
* ER_NO_SUCH_ALARM if origAlarm was already triggered or didn't exist.
* Any other error indicates that adding newAlarm failed (orig alarm will have been removed in this case).
*/
QStatus ReplaceAlarm(const Alarm& origAlarm, const Alarm& newAlarm, bool blockIfTriggered = true);
/**
* Remove all pending alarms with a given alarm listener.
*
* @param listener AlarmListener whose alarms will be removed from this timer.
*/
void RemoveAlarmsWithListener(const AlarmListener& listener);
/*
* Test if the specified alarm is associated with this timer.
*
* @param alarm Alarm to check.
*
* @return Returns true if the alarm is associated with this timer, false if not.
*/
bool HasAlarm(const Alarm& alarm) const;
/**
* Allow the currently executing AlarmTriggered callback to be reentered if another alarm is triggered.
* Calling this method has no effect if timer was created with preventReentrancy == false;
* Calling this method can only be made from within the AlarmTriggered timer callback.
*/
void EnableReentrancy();
/**
* Check whether the current object is holding the lock
*
* @return true if the current Timer is holding the reentrancy lock
*/
bool IsHoldingReentrantLock() const;
/**
* Check whether or not the current thread belongs to this timer instance.
*
* @return true if the current thread is a timer thread from this instance
*/
bool IsTimerCallbackThread() const;
/**
* Get the name of the Timer thread pool
*
* @return the name of the timer thread(s)
*/
const qcc::String& GetName() const;
private:
/*
* private copy constructor
*/
Timer(const Timer&);
/*
* private assignment operator
*/
Timer& operator=(const Timer& src);
TimerImpl* timerImpl;
};
}
#endif
|