Omni C++ Framework - omni/chrono/sync

omni/chrono/sync_timer.hpp


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:



















































































































/*
 * This file is part of the Omni C++ framework

 * 

 * Copyright (c) 2016, Zeriph Enterprises, LLC

 * All rights reserved.

 * 

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions are met:

 * 

 * - Redistributions of source code must retain the above copyright

 *   notice, this list of conditions and the following disclaimer.

 * - Redistributions in binary form must reproduce the above copyright

 *   notice, this list of conditions and the following disclaimer in the

 *   documentation and/or other materials provided with the distribution.

 * - Neither the name of Zeriph, Zeriph Enterprises, LLC, nor the names

 *   of its contributors may be used to endorse or promote products

 *   derived from this software without specific prior written permission.

 * 

 * 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_SYNC_TIMER_HPP)

#define OMNI_SYNC_TIMER_HPP 1

#include <omni/defs/class_macros.hpp>

#include <omni/types/timer_t.hpp>

#if defined(OMNI_SAFE_SYNC_TIMER)

    #include <omni/sync/basic_lock.hpp>

#endif



namespace omni {

    namespace chrono {

        class sync_timer

        {

            public:

                sync_timer();

                sync_timer(const omni::chrono::sync_timer& cp);

                explicit sync_timer(std::size_t interval_ms);

                sync_timer(std::size_t interval_ms,

                           const omni::chrono::timer_delegate& fn);

                sync_timer(std::size_t interval_ms,

                           const omni::chrono::timer_delegate& fn,

                           bool autoreset);

                sync_timer(std::size_t interval_ms,

                           const omni::chrono::timer_delegate& fn,

                           bool autoreset,

                           std::size_t delay);

                ~sync_timer();

                

                omni::generic_ptr state_object; // state object used when tick event passes

                omni::chrono::timer_event tick; // Occurs when the interval has passed

                

                bool auto_reset() const; 

                std::size_t interval() const; 

                bool is_running() const;

                void reset();

                void set_auto_reset(bool autoreset);

                void set_interval(std::size_t interval_ms);

                void start();

                void start(std::size_t delay);

                void stop();

                void stop(std::size_t join_timeout);

                void stop(std::size_t join_timeout, bool kill_on_timeout);

                const omni::chrono::timer_sync_t tick_type() const { return omni::chrono::timer_sync_type::SYNCHRONOUS; }

                omni::chrono::sync_timer& operator=(const omni::chrono::sync_timer& other);

                bool operator==(const omni::chrono::sync_timer& o) const;

                inline bool operator!=(const omni::chrono::sync_timer& o) const { return !(*this == o); }

                

                OMNI_MEMBERS_FW(omni::chrono::sync_timer) // disposing,name,type(),hash()

                

            private:

                void _do_run();

                void _do_tick();

                void _run();

                void _run_delayed(omni::generic_ptr param);

                void _run_noblock();

                bool _stopreq() const;

                

                #if defined(OMNI_TYPE_INFO)

                    omni::type<omni::chrono::sync_timer> m_type;

                #endif

                #if defined(OMNI_SAFE_SYNC_TIMER)

                    mutable omni::sync::basic_lock m_mtx;

                #endif

                omni::sync::basic_thread *m_thread; // the main timer thread to _run on

                std::size_t m_int; // "elapsed" interval in ms between ticks

                volatile bool m_auto; // true by default, false for tick once then stop

                volatile bool m_isrun; // is running

                volatile bool m_stopreq; // stop requested

        };

    } // namespace chrono

} // namespace omni



#endif // OMNI_SYNC_TIMER_HPP