timer.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2019 The Apollo Authors. 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.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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.
 *****************************************************************************/

#ifndef CYBER_TIMER_TIMER_H_
#define CYBER_TIMER_TIMER_H_

#include <atomic>
#include <memory>

#include "cyber/timer/timing_wheel.h"

namespace apollo {
namespace cyber {

struct TimerOption {
  TimerOption(uint32_t period, std::function<void()> callback, bool oneshot)
      : period(period), callback(callback), oneshot(oneshot) {}

  TimerOption() : period(), callback(), oneshot() {}

  uint32_t period = 0;

  std::function<void()> callback;

  bool oneshot;
};

class Timer {
 public:
  Timer();

  explicit Timer(TimerOption opt);

  Timer(uint32_t period, std::function<void()> callback, bool oneshot);
  ~Timer();

  void SetTimerOption(TimerOption opt);

  void Start();

  void Stop();

 private:
  bool InitTimerTask();
  uint64_t timer_id_;
  TimerOption timer_opt_;
  TimingWheel* timing_wheel_ = nullptr;
  std::shared_ptr<TimerTask> task_;
  std::atomic<bool> started_ = {false};
};

}  // namespace cyber
}  // namespace apollo

#endif  // CYBER_TIMER_TIMER_H_