rippled/beast/module/core/thread/DeadlineTimer.cpp

//------------------------------------------------------------------------------
/*
    This file is part of Beast: https://github.com/vinniefalco/Beast
    Copyright 2013, Vinnie Falco <vinnie.falco@gmail.com>

    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.

    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================

#include <beast/utility/static_initializer.h>

namespace beast
{

class DeadlineTimer::Manager
    : protected Thread
{
private:
    using LockType = CriticalSection;
    using Items = List <DeadlineTimer>;

public:
    Manager () : Thread ("DeadlineTimer::Manager")
    {
        startThread ();
    }

    ~Manager ()
    {
        signalThreadShouldExit ();
        notify ();
        waitForThreadToExit ();
        bassert (m_items.empty ());
    }

    static
    Manager&
    instance()
    {
        static beast::static_initializer<Manager> m;
        return *m;
    }

    // Okay to call on an active timer.
    // However, an extra notification may still happen due to concurrency.
    //
    void activate (DeadlineTimer& timer,
        double secondsRecurring, RelativeTime const& when)
    {
        bassert (secondsRecurring >= 0);

        std::lock_guard <LockType> lock (m_mutex);

        if (timer.m_isActive)
        {
            m_items.erase (m_items.iterator_to (timer));

            timer.m_isActive = false;
        }

        timer.m_secondsRecurring = secondsRecurring;
        timer.m_notificationTime = when;

        insertSorted (timer);
        timer.m_isActive = true;

        notify ();
    }

    // Okay to call this on an inactive timer.
    // This can happen naturally based on concurrency.
    //
    void deactivate (DeadlineTimer& timer)
    {
        std::lock_guard <LockType> lock (m_mutex);

        if (timer.m_isActive)
        {
            m_items.erase (m_items.iterator_to (timer));

            timer.m_isActive = false;

            notify ();
        }
    }

    void run ()
    {
        while (! threadShouldExit ())
        {
            RelativeTime const currentTime (
                RelativeTime::fromStartup ());

            double seconds (0);
            DeadlineTimer* timer (nullptr);

            {
                std::lock_guard <LockType> lock (m_mutex);

                // See if a timer expired
                if (! m_items.empty ())
                {
                    timer = &m_items.front ();

                    // Has this timer expired?
                    if (timer->m_notificationTime <= currentTime)
                    {
                        // Expired, remove it from the list.
                        bassert (timer->m_isActive);
                        m_items.pop_front ();

                        // Is the timer recurring?
                        if (timer->m_secondsRecurring > 0)
                        {
                            // Yes so set the timer again.
                            timer->m_notificationTime =
                                currentTime + timer->m_secondsRecurring;

                            // Put it back into the list as active
                            insertSorted (*timer);
                        }
                        else
                        {
                            // Not a recurring timer, deactivate it.
                            timer->m_isActive = false;
                        }

                        timer->m_listener->onDeadlineTimer (*timer);

                        // re-loop
                        seconds = -1;
                    }
                    else
                    {
                        seconds = (
                            timer->m_notificationTime - currentTime).inSeconds ();

                        // Can't be zero and come into the else clause.
                        bassert (seconds != 0);

                        // Don't call the listener
                        timer = nullptr;
                    }
                }
            }

            // Note that we have released the lock here.

            if (seconds > 0)
            {
                // Wait until interrupt or next timer.
                //
                int const milliSeconds (std::max (
                    static_cast <int> (seconds * 1000 + 0.5), 1));
                bassert (milliSeconds > 0);
                wait (milliSeconds);
            }
            else if (seconds == 0)
            {
                // Wait until interrupt
                //
                wait ();
            }
            else
            {
                // Do not wait. This can happen if the recurring timer duration
                // is extremely short, or if a listener wastes too much time in
                // their callback.
            }
        }
    }

    // Caller is responsible for locking
    void insertSorted (DeadlineTimer& timer)
    {
        if (! m_items.empty ())
        {
            Items::iterator before = m_items.begin ();

            for (;;)
            {
                if (before->m_notificationTime >= timer.m_notificationTime)
                {
                    m_items.insert (before, timer);
                    break;
                }

                ++before;

                if (before == m_items.end ())
                {
                    m_items.push_back (timer);
                    break;
                }
            }
        }
        else
        {
            m_items.push_back (timer);
        }
    }

private:
    CriticalSection m_mutex;
    Items m_items;
};

//------------------------------------------------------------------------------

DeadlineTimer::DeadlineTimer (Listener* listener)
    : m_listener (listener)
    , m_isActive (false)
{
}

DeadlineTimer::~DeadlineTimer ()
{
    Manager::instance().deactivate (*this);
}

void DeadlineTimer::cancel ()
{
    Manager::instance().deactivate (*this);
}

void DeadlineTimer::setExpiration (double secondsUntilDeadline)
{
    bassert (secondsUntilDeadline != 0);

    RelativeTime const when (
        RelativeTime::fromStartup() + secondsUntilDeadline);

    Manager::instance().activate (*this, 0, when);
}

void DeadlineTimer::setRecurringExpiration (double secondsUntilDeadline)
{
    bassert (secondsUntilDeadline != 0);

    RelativeTime const when (
        RelativeTime::fromStartup() + secondsUntilDeadline);

    Manager::instance().activate (*this, secondsUntilDeadline, when);
}

} // beast