OpenMAMA C++ API
MamaTimer.h
Go to the documentation of this file.
1 /* $Id$
2  *
3  * OpenMAMA: The open middleware agnostic messaging API
4  * Copyright (C) 2011 NYSE Technologies, Inc.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19  * 02110-1301 USA
20  */
21 
22 #ifndef MAMA_TIMER_CPP_H__
23 #define MAMA_TIMER_CPP_H__
24 
25 #include <mama/mamacpp.h>
26 
27 namespace Wombat
28 {
29  class MamaTimerCallback;
30 
43  class MAMACPPExpDLL MamaTimer
44  {
45  public:
46 
47  MamaTimer (void);
48 
49  virtual ~MamaTimer (void);
50 
61  virtual void create (MamaQueue* queue,
62  MamaTimerCallback* callback,
63  mama_f64_t interval,
64  void* closure = NULL);
65 
72  virtual void destroy ();
73 
77  virtual bool isActive () const;
78 
82  virtual void reset ();
83 
88  virtual void setInterval (mama_f64_t intervalSeconds);
89 
93  virtual mama_f64_t getInterval () const;
94 
100  virtual MamaTimerCallback* getCallback () const;
101 
107  virtual void* getClosure () const;
108 
109  // Access to C types for implementation of related classes.
110  mamaTimer getCValue ();
111  const mamaTimer getCValue () const;
112 
113  private:
114  mamaTimer myTimer;
115  MamaTimerCallback* myCallback;
116  void * myClosure;
117 
118  /* Private functions. */
119  static void MAMACALLTYPE onTimerDestroy (mamaTimer timer, void *closure);
120  static void MAMACALLTYPE onTimerTick (mamaTimer timer, void* closure);
121  };
122 
123 } // namespace Wombat
124 #endif // MAMA_TIMER_CPP_H__
Definition: MamaConnection.h:29
A repeating timer.
Definition: MamaTimer.h:43
Subclass this to receive timer notifications.
Definition: MamaTimerCallback.h:34
Queue allows applications to dispatch events in order with multiple threads using a single MamaDispat...
Definition: MamaQueue.h:40