mirror of
https://github.com/pocoproject/poco.git
synced 2025-10-17 03:03:23 +02:00
added Clock class which provides a monotonic clock on most platforms and is now used by Poco::Timer, Poco::Stopwatch, Poco::TimedNotificationQueue and Poco::UtilTimer to avoid issues when the system time is changed
This commit is contained in:
241
Foundation/include/Poco/Clock.h
Normal file
241
Foundation/include/Poco/Clock.h
Normal file
@@ -0,0 +1,241 @@
|
||||
//
|
||||
// Clock.h
|
||||
//
|
||||
// $Id: //poco/1.4/Foundation/include/Poco/Clock.h#2 $
|
||||
//
|
||||
// Library: Foundation
|
||||
// Package: DateTime
|
||||
// Module: Clock
|
||||
//
|
||||
// Definition of the Clock class.
|
||||
//
|
||||
// Copyright (c) 2013, Applied Informatics Software Engineering GmbH.
|
||||
// and Contributors.
|
||||
//
|
||||
// Permission is hereby granted, free of charge, to any person or organization
|
||||
// obtaining a copy of the software and accompanying documentation covered by
|
||||
// this license (the "Software") to use, reproduce, display, distribute,
|
||||
// execute, and transmit the Software, and to prepare derivative works of the
|
||||
// Software, and to permit third-parties to whom the Software is furnished to
|
||||
// do so, all subject to the following:
|
||||
//
|
||||
// The copyright notices in the Software and this entire statement, including
|
||||
// the above license grant, this restriction and the following disclaimer,
|
||||
// must be included in all copies of the Software, in whole or in part, and
|
||||
// all derivative works of the Software, unless such copies or derivative
|
||||
// works are solely in the form of machine-executable object code generated by
|
||||
// a source language processor.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
|
||||
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
|
||||
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
|
||||
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
// DEALINGS IN THE SOFTWARE.
|
||||
//
|
||||
|
||||
|
||||
#ifndef Foundation_Clock_INCLUDED
|
||||
#define Foundation_Clock_INCLUDED
|
||||
|
||||
|
||||
#include "Poco/Foundation.h"
|
||||
|
||||
|
||||
namespace Poco {
|
||||
|
||||
|
||||
class Foundation_API Clock
|
||||
/// A Clock stores a monotonic* clock value
|
||||
/// with (theoretical) microseconds resolution.
|
||||
/// Clocks can be compared with each other
|
||||
/// and simple arithmetics are supported.
|
||||
///
|
||||
/// [*] Note that Clock values are only monotonic if
|
||||
/// the operating system provides a monotonic clock.
|
||||
/// The monotonic() function can be used to check whether
|
||||
/// the system's clock is monotonic.
|
||||
///
|
||||
/// Monotonic Clock is available on Windows, Linux, OS X
|
||||
/// and on POSIX platforms supporting clock_gettime() with CLOCK_MONOTONIC.
|
||||
///
|
||||
/// Clock values are relative to a system-dependent epoch time
|
||||
/// (usually the system's startup time) and have no relation
|
||||
/// to the time of day.
|
||||
{
|
||||
public:
|
||||
typedef Int64 ClockVal; /// monotonic clock value in microsecond resolution
|
||||
typedef Int64 ClockDiff; /// difference between two clock values in microseconds
|
||||
|
||||
Clock();
|
||||
/// Creates a Clock with the current system clock value.
|
||||
|
||||
Clock(ClockVal tv);
|
||||
/// Creates a Clock from the given clock value.
|
||||
|
||||
Clock(const Clock& other);
|
||||
/// Copy constructor.
|
||||
|
||||
~Clock();
|
||||
/// Destroys the Clock.
|
||||
|
||||
Clock& operator = (const Clock& other);
|
||||
Clock& operator = (ClockVal tv);
|
||||
|
||||
void swap(Clock& clock);
|
||||
/// Swaps the Clock with another one.
|
||||
|
||||
void update();
|
||||
/// Updates the Clock with the current system clock.
|
||||
|
||||
bool operator == (const Clock& ts) const;
|
||||
bool operator != (const Clock& ts) const;
|
||||
bool operator > (const Clock& ts) const;
|
||||
bool operator >= (const Clock& ts) const;
|
||||
bool operator < (const Clock& ts) const;
|
||||
bool operator <= (const Clock& ts) const;
|
||||
|
||||
Clock operator + (ClockDiff d) const;
|
||||
Clock operator - (ClockDiff d) const;
|
||||
ClockDiff operator - (const Clock& ts) const;
|
||||
Clock& operator += (ClockDiff d);
|
||||
Clock& operator -= (ClockDiff d);
|
||||
|
||||
ClockVal microseconds() const;
|
||||
/// Returns the clock value expressed in microseconds
|
||||
/// since the system-specific epoch time (usually system
|
||||
/// startup).
|
||||
|
||||
ClockDiff elapsed() const;
|
||||
/// Returns the time elapsed since the time denoted by
|
||||
/// the Clock instance. Equivalent to Clock() - *this.
|
||||
|
||||
bool isElapsed(ClockDiff interval) const;
|
||||
/// Returns true iff the given interval has passed
|
||||
/// since the time denoted by the Clock instance.
|
||||
|
||||
static ClockVal resolution();
|
||||
/// Returns the resolution in units per second.
|
||||
/// Since the Clock clas has microsecond resolution,
|
||||
/// the returned value is always 1000000.
|
||||
|
||||
static ClockVal accuracy();
|
||||
/// Returns the system's clock accuracy in microseconds.
|
||||
|
||||
static bool monotonic();
|
||||
/// Returns true iff the system's clock is monotonic.
|
||||
|
||||
private:
|
||||
ClockVal _clock;
|
||||
};
|
||||
|
||||
|
||||
//
|
||||
// inlines
|
||||
//
|
||||
inline bool Clock::operator == (const Clock& ts) const
|
||||
{
|
||||
return _clock == ts._clock;
|
||||
}
|
||||
|
||||
|
||||
inline bool Clock::operator != (const Clock& ts) const
|
||||
{
|
||||
return _clock != ts._clock;
|
||||
}
|
||||
|
||||
|
||||
inline bool Clock::operator > (const Clock& ts) const
|
||||
{
|
||||
return _clock > ts._clock;
|
||||
}
|
||||
|
||||
|
||||
inline bool Clock::operator >= (const Clock& ts) const
|
||||
{
|
||||
return _clock >= ts._clock;
|
||||
}
|
||||
|
||||
|
||||
inline bool Clock::operator < (const Clock& ts) const
|
||||
{
|
||||
return _clock < ts._clock;
|
||||
}
|
||||
|
||||
|
||||
inline bool Clock::operator <= (const Clock& ts) const
|
||||
{
|
||||
return _clock <= ts._clock;
|
||||
}
|
||||
|
||||
|
||||
inline Clock Clock::operator + (Clock::ClockDiff d) const
|
||||
{
|
||||
return Clock(_clock + d);
|
||||
}
|
||||
|
||||
|
||||
inline Clock Clock::operator - (Clock::ClockDiff d) const
|
||||
{
|
||||
return Clock(_clock - d);
|
||||
}
|
||||
|
||||
|
||||
inline Clock::ClockDiff Clock::operator - (const Clock& ts) const
|
||||
{
|
||||
return _clock - ts._clock;
|
||||
}
|
||||
|
||||
|
||||
inline Clock& Clock::operator += (Clock::ClockDiff d)
|
||||
{
|
||||
_clock += d;
|
||||
return *this;
|
||||
}
|
||||
|
||||
|
||||
inline Clock& Clock::operator -= (Clock::ClockDiff d)
|
||||
{
|
||||
_clock -= d;
|
||||
return *this;
|
||||
}
|
||||
|
||||
|
||||
inline Clock::ClockVal Clock::microseconds() const
|
||||
{
|
||||
return _clock;
|
||||
}
|
||||
|
||||
|
||||
inline Clock::ClockDiff Clock::elapsed() const
|
||||
{
|
||||
Clock now;
|
||||
return now - *this;
|
||||
}
|
||||
|
||||
|
||||
inline bool Clock::isElapsed(Clock::ClockDiff interval) const
|
||||
{
|
||||
Clock now;
|
||||
Clock::ClockDiff diff = now - *this;
|
||||
return diff >= interval;
|
||||
}
|
||||
|
||||
|
||||
inline Clock::ClockVal Clock::resolution()
|
||||
{
|
||||
return 1000000;
|
||||
}
|
||||
|
||||
|
||||
inline void swap(Clock& s1, Clock& s2)
|
||||
{
|
||||
s1.swap(s2);
|
||||
}
|
||||
|
||||
|
||||
} // namespace Poco
|
||||
|
||||
|
||||
#endif // Foundation_Clock_INCLUDED
|
Reference in New Issue
Block a user