Timestamp.h

Go to the documentation of this file.

//
// Timestamp.h
//
// $Id: //poco/1.3/Foundation/include/Poco/Timestamp.h#2 $
//
// Library: Foundation
// Package: DateTime
// Module:  Timestamp
//
// Definition of the Timestamp class.
//
// Copyright (c) 2004-2006, 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_Timestamp_INCLUDED
#define Foundation_Timestamp_INCLUDED


#include "Poco/Foundation.h"
#include <ctime>


namespace Poco {


class Foundation_API Timestamp
{
public:
        typedef Int64 TimeVal;    
        typedef Int64 UtcTimeVal; 
        typedef Int64 TimeDiff;   

        Timestamp();
                
        Timestamp(TimeVal tv);
                
        Timestamp(const Timestamp& other);
                
        ~Timestamp();
                
        Timestamp& operator = (const Timestamp& other);
        Timestamp& operator = (TimeVal tv);
        
        void swap(Timestamp& timestamp);
        
        void update();

        bool operator == (const Timestamp& ts) const;
        bool operator != (const Timestamp& ts) const;
        bool operator >  (const Timestamp& ts) const;
        bool operator >= (const Timestamp& ts) const;
        bool operator <  (const Timestamp& ts) const;
        bool operator <= (const Timestamp& ts) const;
        
        Timestamp  operator +  (TimeDiff d) const;
        Timestamp  operator -  (TimeDiff d) const;
        TimeDiff   operator -  (const Timestamp& ts) const;
        Timestamp& operator += (TimeDiff d);
        Timestamp& operator -= (TimeDiff d);
        
        std::time_t epochTime() const;
                
        UtcTimeVal utcTime() const;
        
        TimeVal epochMicroseconds() const;
        
        TimeDiff elapsed() const;
        
        bool isElapsed(TimeDiff interval) const;
        
        static Timestamp fromEpochTime(std::time_t t);
                
        static Timestamp fromUtcTime(UtcTimeVal val);
                
        static TimeVal resolution();

#if defined(_WIN32)
        static Timestamp fromFileTimeNP(UInt32 fileTimeLow, UInt32 fileTimeHigh);
        void toFileTimeNP(UInt32& fileTimeLow, UInt32& fileTimeHigh) const;
#endif

private:
        TimeVal _ts;
};


//
// inlines
//
inline bool Timestamp::operator == (const Timestamp& ts) const
{
        return _ts == ts._ts;
}


inline bool Timestamp::operator != (const Timestamp& ts) const
{
        return _ts != ts._ts;
}


inline bool Timestamp::operator >  (const Timestamp& ts) const
{
        return _ts > ts._ts;
}


inline bool Timestamp::operator >= (const Timestamp& ts) const
{
        return _ts >= ts._ts;
}


inline bool Timestamp::operator <  (const Timestamp& ts) const
{
        return _ts < ts._ts;
}


inline bool Timestamp::operator <= (const Timestamp& ts) const
{
        return _ts <= ts._ts;
}


inline Timestamp Timestamp::operator + (Timestamp::TimeDiff d) const
{
        return Timestamp(_ts + d);
}


inline Timestamp Timestamp::operator - (Timestamp::TimeDiff d) const
{
        return Timestamp(_ts - d);
}


inline Timestamp::TimeDiff Timestamp::operator - (const Timestamp& ts) const
{
        return _ts - ts._ts;
}


inline Timestamp& Timestamp::operator += (Timestamp::TimeDiff d)
{
        _ts += d;
        return *this;
}


inline Timestamp& Timestamp::operator -= (Timestamp::TimeDiff d)
{
        _ts -= d;
        return *this;
}


inline std::time_t Timestamp::epochTime() const
{
        return std::time_t(_ts/resolution());
}


inline Timestamp::UtcTimeVal Timestamp::utcTime() const
{
        return _ts*10 + (TimeDiff(0x01b21dd2) << 32) + 0x13814000;
}


inline Timestamp::TimeVal Timestamp::epochMicroseconds() const
{
        return _ts;
}


inline Timestamp::TimeDiff Timestamp::elapsed() const
{
        Timestamp now;
        return now - *this;
}


inline bool Timestamp::isElapsed(Timestamp::TimeDiff interval) const
{
        Timestamp now;
        Timestamp::TimeDiff diff = now - *this;
        return diff >= interval;
}


inline Timestamp::TimeVal Timestamp::resolution()
{
        return 1000000;
}


inline void swap(Timestamp& s1, Timestamp& s2)
{
        s1.swap(s2);
}


} // namespace Poco


#endif // Foundation_Timestamp_INCLUDED