/usr/include/mama/MamaTimer.h is in libmama-dev 2.2.2.1-11.1ubuntu1.
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 | /* $Id$
*
* OpenMAMA: The open middleware agnostic messaging API
* Copyright (C) 2011 NYSE Technologies, Inc.
*
* 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.
*
* 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 MAMA_TIMER_CPP_H__
#define MAMA_TIMER_CPP_H__
#include <mama/mamacpp.h>
namespace Wombat
{
class MamaTimerCallback;
/**
* A repeating timer. The callback will be repeatedly called at the
* specified interval until the timer is destroyed. To restart the
* timer after destroying it if destroy(), use create(). To reset the
* timer to the beginning of the given interval, use reset(). To set
* the timer to a different interval, use setInterval().
*
* The MAMA timer relies on underlying middleware so its resolution is
* also dependent on the middleware.
*
*/
class MAMACPPExpDLL MamaTimer
{
public:
MamaTimer (void);
virtual ~MamaTimer (void);
/**
* Create a repeating timer. The interval is in seconds.
*
* The queue is the queue from which the timer event will be dispatched.
*
* @param queue The queue.
* @param callback The callback.
* @param interval The interval in seconds.
* @param closure The caller supplied closure.
*/
virtual void create (MamaQueue* queue,
MamaTimerCallback* callback,
mama_f64_t interval,
void* closure = NULL);
/**
* Destroy (stop) the timer.
* This function must be called from the same thread dispatching on the
* associated event queue unless both the default queue and dispatch queue are
* not actively dispatching.
*/
virtual void destroy ();
/**
* Return whether the timer is active.
*/
virtual bool isActive () const;
/**
* Reset the timer to the beginning of the interval.
*/
virtual void reset ();
/**
* Set the timer to use a different interval (and reset to the
* beginning of that interval).
*/
virtual void setInterval (mama_f64_t intervalSeconds);
/**
* Get the current timer interval.
*/
virtual mama_f64_t getInterval () const;
/**
* Return the callback for the timer.
*
* @return the callback.
*/
virtual MamaTimerCallback* getCallback () const;
/**
* Return the closure for the timer.
*
* @return the closure.
*/
virtual void* getClosure () const;
// Access to C types for implementation of related classes.
mamaTimer getCValue ();
const mamaTimer getCValue () const;
private:
mamaTimer myTimer;
MamaTimerCallback* myCallback;
void * myClosure;
/* Private functions. */
static void MAMACALLTYPE onTimerDestroy (mamaTimer timer, void *closure);
static void MAMACALLTYPE onTimerTick (mamaTimer timer, void* closure);
};
} // namespace Wombat
#endif // MAMA_TIMER_CPP_H__
|