1 // Copyright 2010 The Kyua Authors. 2 // All rights reserved. 3 // 4 // Redistribution and use in source and binary forms, with or without 5 // modification, are permitted provided that the following conditions are 6 // met: 7 // 8 // * Redistributions of source code must retain the above copyright 9 // notice, this list of conditions and the following disclaimer. 10 // * Redistributions in binary form must reproduce the above copyright 11 // notice, this list of conditions and the following disclaimer in the 12 // documentation and/or other materials provided with the distribution. 13 // * Neither the name of Google Inc. nor the names of its contributors 14 // may be used to endorse or promote products derived from this software 15 // without specific prior written permission. 16 // 17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 29 /// \file utils/signals/timer.hpp 30 /// Multiprogrammed support for timers. 31 /// 32 /// The timer module and class implement a mechanism to program multiple timers 33 /// concurrently by using a deadline scheduler and leveraging the "single timer" 34 /// features of the underlying operating system. 35 36 #if !defined(UTILS_SIGNALS_TIMER_HPP) 37 #define UTILS_SIGNALS_TIMER_HPP 38 39 #include "utils/signals/timer_fwd.hpp" 40 41 #include <memory> 42 43 #include "utils/datetime_fwd.hpp" 44 #include "utils/noncopyable.hpp" 45 46 namespace utils { 47 namespace signals { 48 49 50 namespace detail { 51 void invoke_do_fired(timer*); 52 } // namespace detail 53 54 55 /// Individual timer. 56 /// 57 /// Asynchronously executes its callback() method, which can be overridden by 58 /// subclasses, when the timeout given at construction expires. 59 class timer : noncopyable { 60 struct impl; 61 62 /// Pointer to the shared internal implementation. 63 std::auto_ptr< impl > _pimpl; 64 65 friend void detail::invoke_do_fired(timer*); 66 void do_fired(void); 67 68 protected: 69 virtual void callback(void); 70 71 public: 72 timer(const utils::datetime::delta&); 73 virtual ~timer(void); 74 75 const utils::datetime::timestamp& when(void) const; 76 77 bool fired(void) const; 78 79 void unprogram(void); 80 }; 81 82 83 } // namespace signals 84 } // namespace utils 85 86 #endif // !defined(UTILS_SIGNALS_TIMER_HPP) 87