apollo::cyber::Timer类 参考

Used to perform oneshot or periodic timing tasks 更多...

#include <timer.h>

apollo::cyber::Timer 的协作图:

Public 成员函数
	Timer ()
	Timer (TimerOption opt)
	Construct a new Timer object
	Timer (uint32_t period, std::function< void()> callback, bool oneshot)
	Construct a new Timer object
	~Timer ()
void	SetTimerOption (TimerOption opt)
	Set the Timer Option object
void	Start ()
	Start the timer
void	Stop ()
	Stop the timer

详细描述

Used to perform oneshot or periodic timing tasks

在文件 timer.h 第 71 行定义.

构造及析构函数说明

Timer() [1/3]

apollo::cyber::Timer::Timer

(

)

在文件 timer.cc 第 31 行定义.

             {
  timing_wheel_ = TimingWheel::Instance();
  timer_id_ = GenerateTimerId();
}

Timer() [2/3]

apollo::cyber::Timer::Timer ( TimerOption  opt )

explicit

Construct a new Timer object

参数

opt	Timer option

在文件 timer.cc 第 36 行定义.

                            : timer_opt_(opt) {
  timing_wheel_ = TimingWheel::Instance();
  timer_id_ = GenerateTimerId();
}

Timer() [3/3]

apollo::cyber::Timer::Timer	(	uint32_t	period,
		std::function< void()>	callback,
		bool	oneshot
	)

Construct a new Timer object

参数

period	The period of the timer, unit is ms
callback	The tasks that the timer needs to perform
oneshot	True: perform the callback only after the first timing cycle False: perform the callback every timed period

在文件 timer.cc 第 41 行定义.

                                                                        {
  timing_wheel_ = TimingWheel::Instance();
  timer_id_ = GenerateTimerId();
  timer_opt_.period = period;
  timer_opt_.callback = callback;
  timer_opt_.oneshot = oneshot;
}

~Timer()

apollo::cyber::Timer::~Timer

(

)

在文件 timer.cc 第 154 行定义.

              {
  if (task_) {
    Stop();
  }
}

成员函数说明

SetTimerOption()

void apollo::cyber::Timer::SetTimerOption

(

TimerOption

opt

)

Set the Timer Option object

参数

opt	The timer option will be set

在文件 timer.cc 第 49 行定义.

{ timer_opt_ = opt; }

Start()

void apollo::cyber::Timer::Start

(

)

Start the timer

在文件 timer.cc 第 129 行定义.

                  {
  if (!common::GlobalData::Instance()->IsRealityMode()) {
    return;
  }
 
  if (!started_.exchange(true)) {
    if (InitTimerTask()) {
      timing_wheel_->AddTask(task_);
      AINFO << "start timer [" << task_->timer_id_ << "]";
    }
  }
}

Stop()

void apollo::cyber::Timer::Stop

(

)

Stop the timer

在文件 timer.cc 第 142 行定义.

                 {
  if (started_.exchange(false) && task_) {
    AINFO << "stop timer, the timer_id: " << timer_id_;
    // using a shared pointer to hold task_->mutex before task_ reset
    auto tmp_task = task_;
    {
      std::lock_guard<std::mutex> lg(tmp_task->mutex);
      task_.reset();
    }
  }
}

---

该类的文档由以下文件生成:

• cyber/timer/timer.h
• cyber/timer/timer.cc