DateTime.h

Go to the documentation of this file.

/*
  * Copyright 2010-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License").
  * You may not use this file except in compliance with the License.
  * A copy of the License is located at
  *
  *  http://aws.amazon.com/apache2.0
  *
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */

#pragma once

#include <aws/core/Core_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <iomanip>
#include <ctime>
#include <mutex>

namespace Aws
{
    namespace Utils
    {
        enum class DateFormat
        {
            RFC822, //for http headers
            ISO_8601 //for query and xml payloads
        };

        enum class Month
        {
            January = 0,
            February,
            March,
            April,
            May,
            June,
            July,
            August,
            September,
            October,
            November,
            December
        };

        enum class DayOfWeek
        {
            Sunday = 0,
            Monday,
            Tuesday,
            Wednesday,
            Thursday,
            Friday,
            Saturday
        };

        class AWS_CORE_API DateTime
        {
        public:
            DateTime();

            DateTime(const std::chrono::system_clock::time_point& timepointToAssign);

            DateTime(int64_t millisSinceEpoch);

            DateTime(double epoch_millis);

            DateTime(const Aws::String& timestamp, DateFormat format);

            DateTime(const char* timestamp, DateFormat format);

            bool operator == (const DateTime& other);
            bool operator < (const DateTime& other);
            bool operator > (const DateTime& other);
            bool operator != (const DateTime& other);
            bool operator <= (const DateTime& other);
            bool operator >= (const DateTime& other);

            DateTime& operator=(double secondsSinceEpoch);

            DateTime& operator=(int64_t millisSinceEpoch);

            DateTime& operator=(const std::chrono::system_clock::time_point& timepointToAssign);

            inline bool WasParseSuccessful() { return m_valid; }

            Aws::String ToLocalTimeString(DateFormat format) const;

            Aws::String ToLocalTimeString(const char* formatStr) const;

            Aws::String ToGmtString(DateFormat format) const;

            Aws::String ToGmtString(const char* formatStr) const;

            double SecondsWithMSPrecision() const;

            int64_t Millis() const;

            std::chrono::system_clock::time_point UnderlyingTimestamp() const;

            int GetYear(bool localTime = false) const;

            Month GetMonth(bool localTime = false) const;

            int GetDay(bool localTime = false) const;

            DayOfWeek GetDayOfWeek(bool localTime = false) const;

            int GetHour(bool localTime = false) const;

            int GetMinute(bool localTime = false) const;

            int GetSecond(bool localTime = false) const;

            bool IsDST(bool localTime = false) const;

            static DateTime Now(); 
            
            static int64_t CurrentTimeMillis();

            static Aws::String CalculateLocalTimestampAsString(const char* formatStr);

            static Aws::String CalculateGmtTimestampAsString(const char* formatStr);

            static int CalculateCurrentHour();

            static double ComputeCurrentTimestampInAmazonFormat();

        /*
         * A platform-agnostic implementation of the timegm function from gnu extensions
         */
        static time_t TimeGM(tm* const t);

        private:
            std::chrono::system_clock::time_point m_time;
            bool m_valid;
                        
            void ConvertTimestampStringToTimePoint(const char* timestamp, DateFormat format);
            tm GetTimeStruct(bool localTime) const;
            tm ConvertTimestampToLocalTimeStruct() const;
            tm ConvertTimestampToGmtStruct() const;   
        };

    } // namespace Utils
} // namespace Aws