mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-20 11:05:54 +00:00
122 lines
4.0 KiB
C++
122 lines
4.0 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
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.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#ifndef BEAST_DEADLINETIMER_H_INCLUDED
|
|
#define BEAST_DEADLINETIMER_H_INCLUDED
|
|
|
|
/** Provides periodic or one time notifications at a specified time interval.
|
|
*/
|
|
class DeadlineTimer : public List <DeadlineTimer>::Node
|
|
{
|
|
public:
|
|
/** Listener for a deadline timer.
|
|
|
|
The listener is called on an auxiliary thread. It is suggested
|
|
not to perform any time consuming operations during the call.
|
|
*/
|
|
// VFALCO TODO Allow construction with a specific ThreadWithCallQueue&
|
|
// on which to notify the listener.
|
|
class Listener
|
|
{
|
|
public:
|
|
virtual void onDeadlineTimer (DeadlineTimer&) { }
|
|
};
|
|
|
|
public:
|
|
/** Create a deadline timer with the specified listener attached.
|
|
*/
|
|
explicit DeadlineTimer (Listener* listener);
|
|
|
|
~DeadlineTimer ();
|
|
|
|
/** Set the timer to go off once in the future.
|
|
|
|
If the timer is already active, this will reset it.
|
|
|
|
@note If the timer is already active, the old one might go off
|
|
before this function returns.
|
|
|
|
@param secondsUntilDeadline The number of seconds until the timer
|
|
will send a notification. This must be
|
|
greater than zero.
|
|
*/
|
|
void setExpiration (double secondsUntilDeadline);
|
|
|
|
/** Set the timer to go off repeatedly with the specified frequency.
|
|
|
|
If the timer is already active, this will reset it.
|
|
|
|
@note If the timer is already active, the old one might go off
|
|
before this function returns.
|
|
|
|
@param secondsUntilDeadline The number of seconds until the timer
|
|
will send a notification. This must be
|
|
greater than zero.
|
|
*/
|
|
void setRecurringExpiration (double secondsUntilDeadline);
|
|
|
|
/** Set the timer to go off at a specific time.
|
|
|
|
If the timer is already active, this will reset it.
|
|
|
|
@note If the timer is already active, the old one might go off
|
|
before this function returns.
|
|
|
|
@note If the time is in the past, the timer will go off
|
|
immediately.
|
|
*/
|
|
void setExpirationTime (Time const& when);
|
|
|
|
/** Reset the timer so that no more notifications are sent.
|
|
|
|
It is okay to call this on an inactive timer.
|
|
|
|
@note It is guaranteed that no notifications will occur after this
|
|
function returns.
|
|
*/
|
|
void reset ();
|
|
|
|
/** Equality comparison.
|
|
|
|
Timers are equal if they have the same address.
|
|
*/
|
|
inline bool operator== (DeadlineTimer const& other) const
|
|
{
|
|
return this == &other;
|
|
}
|
|
|
|
/** Inequality comparison.
|
|
*/
|
|
inline bool operator!= (DeadlineTimer const& other) const
|
|
{
|
|
return this != &other;
|
|
}
|
|
|
|
private:
|
|
class Manager;
|
|
|
|
Listener* const m_listener;
|
|
SharedPtr <Manager> m_manager;
|
|
bool m_isActive;
|
|
Time m_notificationTime;
|
|
double m_secondsRecurring; // non zero if recurring
|
|
};
|
|
|
|
#endif
|