/usr/include/sipxtapi/os/OsTimerTask.h is in libsipxtapi-dev 3.3.0~test17-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 | //
// Copyright (C) 2006-2013 SIPez LLC. All rights reserved.
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp. All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$
///////////////////////////////////////////////////////////////////////////////
#ifndef _OsTimerTask_h_
#define _OsTimerTask_h_
// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "os/OsDefs.h"
#include "os/OsBSem.h"
#include "os/OsMsgQ.h"
#include "os/OsServerTask.h"
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class OsTimer;
class OsTimerMsg;
//:Timer service request manager (runs as a separate task)
// This task is responsible for managing timer service requests. Timer
// requests are received via a message queue.
class OsTimerTask : public OsServerTask
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
/* ============================ CREATORS ================================== */
static OsTimerTask* getTimerTask(void);
//:Return a pointer to the timer task, creating it if necessary
static void destroyTimerTask(void);
//: Destroy the singleton instance of the sys timer
// Should only be called when timers are not being started or stopped.
// All current timers are stopped.
virtual
~OsTimerTask();
//:Destructor
// Should not be called directly. Use destroyTimerTask().
/* ============================ MANIPULATORS ============================== */
/* ============================ ACCESSORS ================================= */
/* ============================ INQUIRY =================================== */
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
/// Constructor (called only indirectly via getTimerTask())
OsTimerTask();
/**< We identify this as a protected (rather than a private) method so
* that gcc doesn't complain that the class only defines a private
* constructor and has no friends.
*/
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
static const int TIMER_MAX_REQUEST_MSGS; // Maximum number of request messages
/// The entry point for the task
virtual int run(void* pArg);
/**< We replace OsServerTask::run() so that it will simultaneously wait
* for an incoming message or for the next timer to fire.
*/
/// Handle a timer service request.
virtual UtlBoolean handleMessage(OsMsg& rMsg);
///< Return TRUE if the request was handled, otherwise FALSE.
/** Fire a timer because it has expired.
* Calls the if notification routine, if the timer hasn't been stopped
* already.
* If the timer is periodic and hasn't been stopped, reinserts it into
* the queue.
* Advances the timer's state if it is one-shot or has been stopped.
*/
virtual void fireTimer(OsTimer* timer);
/// Pointer to the single instance of the OsTimerTask class.
static volatile OsTimerTask* spInstance;
///< Declare as volatile because it is set and tested concurrently.
/// Semaphore used to protect manipulations of spInstance.
static OsBSem *sLock;
/// The queue of timer requests, ordered by increasing firing time.
OsTimer* mTimerQueue;
/// Timeout to use when signalling
OsTime mSignalTimeout;
/// Insert a timer into the timer queue.
void insertTimer(OsTimer* timer);
/// Remove a timer from the timer queue.
void removeTimer(OsTimer* timer);
/// Copy constructor (not implemented for this class)
OsTimerTask(const OsTimerTask& rOsTimerTask);
/// Assignment operator (not implemented for this class)
OsTimerTask& operator=(const OsTimerTask& rhs);
};
/* ============================ INLINE METHODS ============================ */
#endif // _OsTimerTask_h_
|