timer.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_TIMER_H_
#define INCLUDE_FUNAPI_TIME_TIMER_H_

#include <boost/function.hpp>
#include <boost/thread/thread_time.hpp>
#include <boost/utility.hpp>
#include <funapi/framework/component.h>
#include <funapi/system/event.h>
#include <funapi/time/wall_clock.h>
#include <funapi/types.h>


namespace fun {


FUNAPI_DLL_VISIBILITY extern const EventTag kTimerEventTag;


class FUNAPI_DLL_VISIBILITY Timer : public Component {
 public:
  typedef uint64_t Id;

  typedef function<void (const Id &, const WallClock::Value &)> Handler;

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

  static Id ExpireAt(
      const WallClock::Value &abs_time,
      const Handler &handler,
      const EventTag &tag = kTimerEventTag) ASSERT_NO_ROLLBACK;

  static Id ExpireAfter(
      const WallClock::Duration &rel_time,
      const Handler &handler,
      const EventTag &tag = kTimerEventTag) ASSERT_NO_ROLLBACK;

  static Id ExpireRepeatedly(
      const WallClock::Duration &interval,
      const Handler &handler,
      const EventTag &tag = kTimerEventTag) ASSERT_NO_ROLLBACK;

  static void Cancel(const Id &timer_id) ASSERT_NO_ROLLBACK;

  static const Id kInvalidTimerId;
};

}  // namespace fun

#endif  // INCLUDE_FUNAPI_TIME_TIMER_H_