Updated license
[anna.git] / include / anna / timex / internal / TickProducer.hpp
1 // ANNA - Anna is Not Nothingness Anymore
2 //
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
4 //
5 // https://bitbucket.org/testillano/anna
6 //
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
9 // are met:
10 //
11 //     * Redistributions of source code must retain the above copyright
12 // notice, this list of conditions and the following disclaimer.
13 //     * Redistributions in binary form must reproduce the above
14 // copyright notice, this list of conditions and the following disclaimer
15 // in the documentation and/or other materials provided with the
16 // distribution.
17 //     * Neither the name of Google Inc. nor the names of its
18 // contributors may be used to endorse or promote products derived from
19 // this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
33 // Authors: eduardo.ramos.testillano@gmail.com
34 //          cisco.tierra@gmail.com
35
36
37 #ifndef anna_timex_internal_TickProducer_hpp
38 #define anna_timex_internal_TickProducer_hpp
39
40 #include <anna/core/mt/Runnable.hpp>
41
42 namespace anna {
43
44 namespace timex {
45
46 class Engine;
47
48 /**
49  * Esta clase se ejecuta desde un thread 'real' aunque estemos generando la librería en modo ST,
50  * para evitar que la librería tenga que generar pulso de reloj mediante el SIGALRM.
51  */
52 class TickProducer {
53 public:
54   void requestStop() throw() { a_requestedStop = true; }
55
56   // Para poder clonarlo
57   void setfd(const int fd) throw() { a_fdWrite = fd; }
58
59 private:
60   Engine& a_timeController;
61   int a_fdWrite;
62   Millisecond a_expectedTime;
63   bool a_isInPause;
64   bool a_requestedStop;
65
66   TickProducer(Engine* timeController, const int fdWrite);
67
68   bool isInPause() const throw() { return a_isInPause; }
69   void setIsInPause(const bool isInPause) throw() { a_isInPause = isInPause; }
70
71   void tick() throw();
72   void resetExpectedTime() throw() { a_expectedTime = 0; }
73   Millisecond calculeSlice(const Millisecond & msnow) throw();
74
75   static void* exec(void* arg) throw();
76
77   friend class Engine;
78 };
79
80 }
81 }
82
83 #endif