001:
002:
003:
004:
005:
006:
007:
008:
009:
010:
011:
012:
013:
014:
015:
016:
017:
018:
019:
020:
021:
022:
023:
024:
025:
026:
027:
028:
029:
030:
031:
032:
033:
034:
035:
036:
037:
038:
039:
040:
041:
042:
043:
044:
045:
046:
047:
048:
049:
050:
051:
052:
053:
054:
055:
056:
057:
058:
059:
060:
061:
062:
063:
064:
065:
066:
067:
068:
069:
070:
071:
072:
073:
074:
075:
076:
077:
078:
079:
080:
081:
082:
083:
084:
085:
086:
087:
088:
089:
090:
091:
092:
093:
094:
095:
096:
097:
098:
099:
100:
101:
102:
/*
* Copyright (c), Zeriph Enterprises
* All rights reserved.
*
* Contributor(s):
* Zechariah Perez, omni (at) zeriph (dot) com
*
* THIS SOFTWARE IS PROVIDED BY ZERIPH AND CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL ZERIPH AND CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#if !defined(OMNI_DROP_TIMER_HPP)
#define OMNI_DROP_TIMER_HPP 1
#include <omni/defs/class_macros.hpp>
#include <omni/types/timer_t.hpp>
#if defined(OMNI_SAFE_DROP_TIMER)
#include <omni/sync/basic_lock.hpp>
#endif
#if defined(OMNI_32BIT_DROP_TIMER)
#define OMNI_DTMR_INT_FW uint32_t
#else
#define OMNI_DTMR_INT_FW uint64_t
#endif
namespace omni {
namespace chrono {
class drop_timer
{
public:
drop_timer();
drop_timer(const omni::chrono::drop_timer& cp);
OMNI_EXPLICIT drop_timer(uint32_t interval_ms);
drop_timer(uint32_t interval_ms,
const omni::chrono::timer_delegate& fn);
drop_timer(uint32_t interval_ms,
const omni::chrono::timer_delegate& fn,
bool autoreset);
drop_timer(uint32_t interval_ms,
const omni::chrono::timer_delegate& fn,
bool autoreset,
uint32_t delay);
~drop_timer();
omni::generic_ptr state_object;
omni::chrono::timer_event tick;
bool auto_reset() const;
uint32_t interval() const;
bool is_running() const;
void reset();
void set_auto_reset(bool autoreset);
void set_interval(uint32_t interval_ms);
void start();
void start(uint32_t delay);
void stop();
void stop(uint32_t join_timeout);
void stop(uint32_t join_timeout, bool kill_on_timeout);
void swap(omni::chrono::drop_timer& other);
inline omni::chrono::timer_sync_type::enum_t tick_type() const { return omni::chrono::timer_sync_type::DROP; }
omni::chrono::drop_timer& operator=(const omni::chrono::drop_timer& other);
bool operator==(const omni::chrono::drop_timer& o) const;
inline bool operator!=(const omni::chrono::drop_timer& o) const { return !(*this == o); }
OMNI_MEMBERS_FW(omni::chrono::drop_timer) // disposing,name,type(),hash()
private:
#if defined(OMNI_SAFE_DROP_TIMER)
mutable omni::sync::basic_lock m_mtx;
#endif
omni::sync::basic_thread* m_thread; // the main timer thread to _run on
omni::sync::thread_handle_t m_exec; // the executing tick thread
OMNI_DTMR_INT_FW m_int; // "elapsed" interval in ms between ticks
volatile OMNI_DTMR_INT_FW m_status; // auto run (true by default), is_run, stop_req
void _do_run();
void _do_tick();
void _run();
void _run_delayed(omni::sync::thread_arg_t param);
void _run_skip();
bool _stopreq() const;
};
} // namespace chrono
} // namespace omni
namespace std {
inline void swap(omni::chrono::drop_timer& o1, omni::chrono::drop_timer& o2)
{
o1.swap(o2);
}
}
#endif // OMNI_DROP_TIMER_HPP