wall_clock.h

Go to the documentation of this file.

// Copyright (C) 2013-2020 iFunFactory Inc. All Rights Reserved.
//
// This work is confidential and proprietary to iFunFactory Inc. and
// must not be used, disclosed, copied, or distributed without the prior
// consent of iFunFactory Inc.

#ifndef INCLUDE_FUNAPI_TIME_WALL_CLOCK_H_
#define INCLUDE_FUNAPI_TIME_WALL_CLOCK_H_

#include <boost/date_time/gregorian/greg_date.hpp>
#include <boost/date_time/posix_time/posix_time.hpp>
#include <funapi/framework/component.h>
#include <funapi/time/monotonic_clock.h>
#include <funapi/types.h>


namespace fun {

class FUNAPI_DLL_VISIBILITY WallClock : public Component {
 public:
  typedef boost::posix_time::ptime Value;
  typedef boost::posix_time::time_duration Duration;

  static const Value kEpochClock;

  static const Duration kEmptyDuration;

  static bool Install(const ArgumentMap &arguments);
  static bool Uninstall();

  static Duration FromSec(int64_t sec) {
    return boost::posix_time::seconds(sec);
  }

  static Duration FromMsec(int64_t msec) {
    return boost::posix_time::milliseconds(msec);
  }

  static Duration FromUsec(int64_t usec) {
    return boost::posix_time::microseconds(usec);
  }

  static WallClock::Value FromMonotonicClock(
      const MonotonicClock::Value &mono_clock);

  static MonotonicClock::Value ToMonotonicClock(
      const WallClock::Value &wall_clock);

  // @return Current WallClock::Value.
  static WallClock::Value Now();

  // @return Current timestamp in second.
  static int64_t GetTimestampInSec();

  // @return Timestamp in second.
  static int64_t GetTimestampInSec(const WallClock::Value &value);

  // @return WallClock::Value from the timestamp in second.
  static WallClock::Value FromTimestampInSec(int64_t timestamp_in_second);

  // @return Current timestamp in millisecond.
  static int64_t GetTimestampInMsec();

  // @return Timestamp in millisecond.
  static int64_t GetTimestampInMsec(const WallClock::Value &value);

  // @return WallClock::Value from the timestamp in msec.
  static WallClock::Value FromTimestampInMsec(int64_t timestamp_in_msec);

  // @return Current timestamp in microsecond.
  static int64_t GetTimestampInUsec();

  // @return Timestamp in microsecond.
  static int64_t GetTimestampInUsec(const WallClock::Value &value);

  // @return WallClock::Value from the timestamp in usec.
  static WallClock::Value FromTimestampInUsec(int64_t timestamp_in_usec);

  // @return Current iso-extended timestring.
  static string GetTimestring();

  // @return iso-extended timestring of the value.
  static string GetTimestring(const WallClock::Value &value);

  static string GetLocalTimestring();

  static string GetLocalTimestring(const WallClock::Value &value);

  // @return True if succeed. false otherwise.
  static bool FromTimestring(const string &timestring, WallClock::Value *value);

  // @return Process start time.
  static WallClock::Value GetProcessStartTime();

  // @return Process uptime.
  static WallClock::Duration GetProcessUptime();
};

}  // namespace fun

#endif  // INCLUDE_FUNAPI_TIME_WALL_CLOCK_H_