Timer class for timeout monitoring. More...

#include <sync_timer.h>

Public Types
enum class	TimerState : std::uint8_t { kIdle = 0 , kCancelRequested , kTimeout }
	Definition of different timer state during timeout monitoring. More...

using	Clock = ClockType
	Type alias for the clock type. More...

using	TimePoint = std::chrono::time_point< Clock >
	Type alias for the clock time point. More...

Public Member Functions
	SyncTimer ()
	Construct an instance of SyncTimer. More...

	~SyncTimer ()
	Destruct an instance of SyncTimer. More...

template<typename TimeoutCallback , typename CancelCallback >
void	WaitForTimeout (TimeoutCallback &&timeout_func, CancelCallback &&cancellation_func, std::chrono::milliseconds const timeout)
	Helper function to wait for response with timeout monitoring. More...

auto	IsTimerActive ()
	Function to query if timer is running. More...

void	CancelWait ()
	Function to cancel the synchronous wait. More...

Private Member Functions
auto	Start (std::chrono::milliseconds const timeout) noexcept -> TimerState
	Function to start the timeout monitoring. More...

void	Stop () noexcept
	Function to stop the current timeout monitoring. More...

Private Attributes
std::condition_variable	cond_var_
	The conditional variable needed for synchronizing between start and stop of running timer. More...

std::mutex	mutex_lock_
	The mutex for the conditional variable. More...

bool	exit_request_
	The flag to terminate the wait. More...

bool	start_running_
	The flag to stop the current running timer. More...

Detailed Description

template<typename ClockType>
class utility::sync_timer::SyncTimer< ClockType >

Timer class for timeout monitoring.

Template Parameters

ClockType The type of clock to be used for time monitoring

Definition at line 24 of file sync_timer.h.

Member Typedef Documentation

◆ Clock

template<typename ClockType >

using utility::sync_timer::SyncTimer< ClockType >::Clock = ClockType

Type alias for the clock type.

Definition at line 29 of file sync_timer.h.

◆ TimePoint

template<typename ClockType >

using utility::sync_timer::SyncTimer< ClockType >::TimePoint = std::chrono::time_point<Clock>

Type alias for the clock time point.

Definition at line 34 of file sync_timer.h.

Member Enumeration Documentation

◆ TimerState

template<typename ClockType >

enum utility::sync_timer::SyncTimer::TimerState : std::uint8_t

strong

Definition of different timer state during timeout monitoring.

Enumerator
kIdle
kCancelRequested
kTimeout

Definition at line 39 of file sync_timer.h.

39 : std::uint8_t { kIdle = 0, kCancelRequested, kTimeout };

diag::client::conversation_state_impl::ConversationState::kIdle

@ kIdle

Constructor & Destructor Documentation

◆ SyncTimer()

template<typename ClockType >

utility::sync_timer::SyncTimer< ClockType >::SyncTimer ( )

inline

Construct an instance of SyncTimer.

Definition at line 44 of file sync_timer.h.

44 : cond_var_{}, mutex_lock_{}, exit_request_{false}, start_running_{false} {}

utility::sync_timer::SyncTimer::mutex_lock_

std::mutex mutex_lock_

The mutex for the conditional variable.

Definition: sync_timer.h:148

utility::sync_timer::SyncTimer::start_running_

bool start_running_

The flag to stop the current running timer.

Definition: sync_timer.h:158

utility::sync_timer::SyncTimer::cond_var_

std::condition_variable cond_var_

The conditional variable needed for synchronizing between start and stop of running timer.

Definition: sync_timer.h:143

utility::sync_timer::SyncTimer::exit_request_

bool exit_request_

The flag to terminate the wait.

Definition: sync_timer.h:153

◆ ~SyncTimer()

template<typename ClockType >

utility::sync_timer::SyncTimer< ClockType >::~SyncTimer ( )

inline

Destruct an instance of SyncTimer.

Definition at line 49 of file sync_timer.h.

                {
     std::lock_guard<std::mutex> const lck(mutex_lock_);
     exit_request_ = false;
     start_running_ = false;
     cond_var_.notify_all();
   }

References utility::sync_timer::SyncTimer< ClockType >::cond_var_, utility::sync_timer::SyncTimer< ClockType >::exit_request_, utility::sync_timer::SyncTimer< ClockType >::mutex_lock_, and utility::sync_timer::SyncTimer< ClockType >::start_running_.

Member Function Documentation

◆ CancelWait()

template<typename ClockType >

void utility::sync_timer::SyncTimer< ClockType >::CancelWait ( )

inline

Function to cancel the synchronous wait.

Definition at line 90 of file sync_timer.h.

90 { Stop(); }

utility::sync_timer::SyncTimer::Stop

void Stop() noexcept

Function to stop the current timeout monitoring.

Definition: sync_timer.h:133

References utility::sync_timer::SyncTimer< ClockType >::Stop().

Referenced by doip_client::channel::tcp_channel::DiagnosticMessageHandler::DiagnosticMessageHandlerImpl::Stop(), and doip_client::channel::tcp_channel::RoutingActivationHandler::RoutingActivationHandlerImpl::Stop().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsTimerActive()

template<typename ClockType >

auto utility::sync_timer::SyncTimer< ClockType >::IsTimerActive ( )

inline

Function to query if timer is running.

Definition at line 82 of file sync_timer.h.

                        {
     std::lock_guard<std::mutex> const lck(mutex_lock_);
     return start_running_;
   }

References utility::sync_timer::SyncTimer< ClockType >::mutex_lock_, and utility::sync_timer::SyncTimer< ClockType >::start_running_.

Referenced by doip_client::channel::tcp_channel::DiagnosticMessageHandler::DiagnosticMessageHandlerImpl::Stop(), and doip_client::channel::tcp_channel::RoutingActivationHandler::RoutingActivationHandlerImpl::Stop().

Here is the caller graph for this function:

◆ Start()

template<typename ClockType >

auto utility::sync_timer::SyncTimer< ClockType >::Start ( std::chrono::milliseconds const timeout ) -> TimerState

inlineprivatenoexcept

Function to start the timeout monitoring.

Parameters

[in] timeout The timeout value in milliseconds after which timeout happens

Returns: TimerState "kTimeout" in case of timeout or "kCancelRequested" when timeout monitoring was cancelled

Definition at line 100 of file sync_timer.h.

                                                                          {
     TimerState timer_state{TimerState::kIdle};
     std::unique_lock<std::mutex> lck(mutex_lock_);
     start_running_ = true;
     TimePoint const expiry_time_point{Clock::now() + timeout};
     if (cond_var_.wait_until(lck, expiry_time_point, [this, &expiry_time_point, &timer_state]() {
           bool do_exit_wait{false};
           // check if exit was requested
           if (!exit_request_) {
             TimePoint const current_time{Clock::now()};
             // check for expiry
             if (current_time >= expiry_time_point) {
               // timeout
               timer_state = TimerState::kTimeout;
               do_exit_wait = true;
             } else {
               // check for cancellation request
               if (!start_running_) {
                 timer_state = TimerState::kCancelRequested;
                 do_exit_wait = true;
               }  // else - spurious wake-up, do nothing
             }
           } else {
             do_exit_wait = true;
           }
           return do_exit_wait;
         })) {}
     return timer_state;
   }

References utility::sync_timer::SyncTimer< ClockType >::cond_var_, utility::sync_timer::SyncTimer< ClockType >::exit_request_, utility::sync_timer::SyncTimer< ClockType >::kCancelRequested, utility::sync_timer::SyncTimer< ClockType >::kIdle, utility::sync_timer::SyncTimer< ClockType >::kTimeout, utility::sync_timer::SyncTimer< ClockType >::mutex_lock_, and utility::sync_timer::SyncTimer< ClockType >::start_running_.

Referenced by utility::sync_timer::SyncTimer< ClockType >::WaitForTimeout().

Here is the caller graph for this function:

◆ Stop()

template<typename ClockType >

void utility::sync_timer::SyncTimer< ClockType >::Stop ( )

inlineprivatenoexcept

Function to stop the current timeout monitoring.

Definition at line 133 of file sync_timer.h.

                        {
     std::lock_guard<std::mutex> const lck(mutex_lock_);
     start_running_ = false;
     cond_var_.notify_all();
   }

Referenced by utility::sync_timer::SyncTimer< ClockType >::CancelWait().

Here is the caller graph for this function:

◆ WaitForTimeout()

template<typename ClockType >

template<typename TimeoutCallback , typename CancelCallback >

void utility::sync_timer::SyncTimer< ClockType >::WaitForTimeout	(	TimeoutCallback &&	timeout_func,
		CancelCallback &&	cancellation_func,
		std::chrono::milliseconds const	timeout
	)

inline

Helper function to wait for response with timeout monitoring.

Template Parameters

TimeoutCallback	The callback functor type for timeout notification
CancelCallback	The callback functor type for cancellation notification

Parameters

[in]	timeout_func	The functor to be called when timeout occurs
[in]	cancel_func	The functor to be called when expected event occurs within timeout
[in]	timeout	The timeout in milliseconds

Definition at line 70 of file sync_timer.h.

                                                            {
     if (Start(timeout) == TimerState::kTimeout) {
       timeout_func();
     } else {
       cancellation_func();
     }
   }

References utility::sync_timer::SyncTimer< ClockType >::kTimeout, and utility::sync_timer::SyncTimer< ClockType >::Start().

Here is the call graph for this function:

Member Data Documentation

◆ cond_var_

template<typename ClockType >

std::condition_variable utility::sync_timer::SyncTimer< ClockType >::cond_var_

private

The conditional variable needed for synchronizing between start and stop of running timer.

Definition at line 143 of file sync_timer.h.

Referenced by utility::sync_timer::SyncTimer< ClockType >::Start(), and utility::sync_timer::SyncTimer< ClockType >::~SyncTimer().

◆ exit_request_

template<typename ClockType >

bool utility::sync_timer::SyncTimer< ClockType >::exit_request_

private

The flag to terminate the wait.

Definition at line 153 of file sync_timer.h.

Referenced by utility::sync_timer::SyncTimer< ClockType >::Start(), and utility::sync_timer::SyncTimer< ClockType >::~SyncTimer().

◆ mutex_lock_

template<typename ClockType >

std::mutex utility::sync_timer::SyncTimer< ClockType >::mutex_lock_

private

The mutex for the conditional variable.

Definition at line 148 of file sync_timer.h.

Referenced by utility::sync_timer::SyncTimer< ClockType >::IsTimerActive(), utility::sync_timer::SyncTimer< ClockType >::Start(), and utility::sync_timer::SyncTimer< ClockType >::~SyncTimer().

◆ start_running_

template<typename ClockType >

bool utility::sync_timer::SyncTimer< ClockType >::start_running_

private

The flag to stop the current running timer.

Definition at line 158 of file sync_timer.h.

Referenced by utility::sync_timer::SyncTimer< ClockType >::IsTimerActive(), utility::sync_timer::SyncTimer< ClockType >::Start(), and utility::sync_timer::SyncTimer< ClockType >::~SyncTimer().

The documentation for this class was generated from the following file:

/home/runner/work/diag-client-lib/diag-client-lib/diag-client-lib/lib/utility-support/utility/sync_timer.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<typename ClockType> class utility::sync_timer::SyncTimer< ClockType >

Member Typedef Documentation

◆ Clock

◆ TimePoint

Member Enumeration Documentation

◆ TimerState

Constructor & Destructor Documentation

◆ SyncTimer()

◆ ~SyncTimer()

Member Function Documentation

◆ CancelWait()

◆ IsTimerActive()

◆ Start()

◆ Stop()

◆ WaitForTimeout()

Member Data Documentation

◆ cond_var_

◆ exit_request_

◆ mutex_lock_

◆ start_running_

template<typename ClockType>
class utility::sync_timer::SyncTimer< ClockType >