Time.h

Go to the documentation of this file.

/*
* Copyright Onix Solutions Limited [OnixS]. All rights reserved.
*
* This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
* and international copyright treaties.
*
* Access to and use of the software is governed by the terms of the applicable OnixS Software
* Services Agreement (the Agreement) and Customer end user license agreements granting
* a non-assignable, non-transferable and non-exclusive license to use the software
* for it's own data processing purposes under the terms defined in the Agreement.
*
* Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
* of this source code or associated reference material to any other location for further reproduction
* or redistribution, and any amendments to this copyright notice, are expressly prohibited.
*
* Any reproduction or redistribution for sale or hiring of the Software not in accordance with
* the terms of the Agreement is a violation of copyright law.
*/

#pragma once

#if defined __linux__
#include <unistd.h>
#include <sys/time.h>
#endif

#include "OnixS/MTS/BondVision/SDP/ABI.h"

namespace OnixS {
namespace Mts {
namespace BondVision {
namespace SDP {

#if defined _WIN32

typedef
unsigned __int64
AbsoluteHighResolutionTimeImpl;

typedef
__int64
RelativeHighResolutionTimeImpl;

#elif defined __linux__

typedef timeval AbsoluteHighResolutionTimeImpl;
typedef struct Nothing {} RelativeHighResolutionTimeImpl;
#else

#error High resolution time services are not defined for a given platform.

#endif
/// Alias for raw timestamps.
///
typedef AbsoluteHighResolutionTimeImpl Timestamp;

/// Fields of HighResolutionTime.
///
struct ONIXS_MTS_BONDVISION_SDP_API HighResolutionTimeFields
{
    unsigned short year;
    unsigned short month;
    unsigned short day;

    unsigned short hour;
    unsigned short minute;
    unsigned short seconds;

    unsigned int microseconds;

    /// From absolute.
    ///
    void fromAbsolute (const AbsoluteHighResolutionTimeImpl&);

    /// To absolute.
    ///
    void toAbsolute (AbsoluteHighResolutionTimeImpl*) const;

    /// Parse from string.
    ///
    void fromString (const std::string&);

    /// Returns string representation.
    ///
    std::string toString() const;
};

typedef long long HighResolutionTimeSpan;

/// Miscellaneous time traits.
///
class ONIXS_MTS_BONDVISION_SDP_API HighResolutionTime
{
public:
    /// Initializes as not valid.
    ///
    HighResolutionTime();

    /// Initializes from given number of milliseconds since Jan 1st, 1970, 00:00:00 GMT.
    ///
    HighResolutionTime (UInt64);

    /// Initializes from the given set of time attributes.
    ///
    HighResolutionTime (const HighResolutionTimeFields&);

    /// Initializes from the other instance.
    ///
    HighResolutionTime (const HighResolutionTime&);

    /// Indicates whether the instance is valid time.
    ///
    bool isValid() const;

    /// Extracts details like year, month, seconds, etc.
    ///
    void getFields (HighResolutionTimeFields* fields) const;

    /// Returns canonical presentation of time.
    ///
    std::string toString() const;

    /// Updates to current time.
    ///
    void setToNow();

    /// Compares two timestamps for equality.
    ///
    bool operator == (const HighResolutionTime&) const;

    /// Compares two timestamps for inequality.
    ///
    bool operator != (const HighResolutionTime&) const;

    /// Returns difference between two times in microseconds.
    ///
    HighResolutionTimeSpan operator - (const HighResolutionTime&) const;

    /// Reinitializes from the other instance.
    ///
    HighResolutionTime& operator = (const HighResolutionTime&);

    /// Returns current time.
    ///
    static HighResolutionTime now();

    /// Returns time from its string presentation.
    ///
    static HighResolutionTime parse (const std::string& time);

protected:
    friend struct TimestampHelpers;
#if defined _WIN32
    /// Returns time created from relative value.
    ///
    static HighResolutionTime createFromRelative (RelativeHighResolutionTimeImpl value);
#elif defined __linux__
    /// Returns time created from absolute value.
    ///
    static HighResolutionTime createFromAbsolute (AbsoluteHighResolutionTimeImpl value);
#endif
private:
    enum ValueKind { Invalid, Absolute, Relative };

    union Value
    {
        AbsoluteHighResolutionTimeImpl asAbsolute;
        RelativeHighResolutionTimeImpl asRelative;
    };

    Value value_;
    ValueKind kind_;

    HighResolutionTime (ValueKind kind);
};

inline bool HighResolutionTime::isValid() const
{
    return ! (Invalid == kind_);
}

ONIXS_MTS_BONDVISION_SDP_API std::ostream& operator << (std::ostream& os, const HighResolutionTime&);
}
}
}
}