Timer Manual

Table of Contents

• About
• TimerInterface
• Further Reading

About

A timer can be used to execute a certain function periodically.

TimerInterface

A new timer instance is created with these static functions:

• maxon::TimerInterface::AddPeriodicTimer(): Creates a new periodic timer.
• maxon::TimerInterface::AddOneShotTimer(): Creates a new timer that fires only once.

The created timer instance is controlled with these functions:

• maxon::TimerInterface::Start(): Starts the timer with the given settings.
• maxon::TimerInterface::CancelAndWait(): Cancels the timer and waits until the current job has finished.
• maxon::TimerInterface::Cancel(): Cancels the timer. Can be called from within the timer itself.

These observables are called on certain events:

• ObservableTimerStarted: Notifies the observers that the timer has started.
• ObservableTimerFinished: Notifies the observers that the timer has finished.
• ObservableTimerOverload: Notifies the observers that the timer job took longer than the specified interval.

  // This example creates a new timer that is executed every second.
  // After ten executions, the timer stops itself.
  // g_timer is just a maxon::TimerRef instance.
 
  auto TimerFunction = []()
                       {
                         DiagnosticOutput("Timer Tick...");
 
                         if (g_count < 10)
                         {
                           ++g_count;
                         }
                         else
                         {
                            // timer should end
                           g_timer.Cancel();
                         }
                       };
 
  g_timer = maxon::TimerInterface::AddPeriodicTimer(maxon::Seconds(1), TimerFunction, maxon::JOBQUEUE_CURRENT) iferr_return;

Further Reading

• Jobs Manual
• Observables Usage