WatchdogThread Class Reference

Simple class for asynchronous check of time-out. More...

#include <WatchdogThread.h>

Collaboration diagram for WatchdogThread:

Public Member Functions
	WatchdogThread (boost::posix_time::time_duration timeout, bool autostart=false)
	Constructor.
virtual	~WatchdogThread ()
	Destructor.
void	start ()
	Start the watchdog thread.
void	stop ()
	Signal the watchdog thread to stop and wait for it.
void	ping ()
	Function to call to notify the watchdog thread that we are still alive.
void	setTimeout (boost::posix_time::time_duration timeout)
	Change the duration of the time-out.
boost::posix_time::time_duration	getTimeout () const
	Get the current time-out value.
boost::system_time	getLastPing () const
	Get the time of latest ping.

Protected Member Functions
virtual void	action ()
	User implemented function that will be called if the time-out is reached.
virtual void	onPing ()
	User implemented function that will be called when ping is called.
virtual void	onStart ()
	User implemented function that will be called when starting.
virtual void	onStop ()
	User implemented function that will be called when stopping.

Private Member Functions
void	i_run ()
	Core function of the secondary thread.

Private Attributes
boost::posix_time::time_duration	m_timeout
	Number of seconds allowed between pings.
boost::system_time	m_lastPing
	When the last ping was received.
std::auto_ptr< boost::thread >	m_thread
	Pointer to the running thread;.
bool	m_running
	Flag to mark the thread as running/stopped (avoid possible race conditions).
boost::mutex	m_lastPingMutex
	Mutex for the access to the m_lastPing data member.

Detailed Description

Simple class for asynchronous check of time-out.

The user must provide a callable with the action to be performed when the time-out occurs.

Author

Marco Clemencic

Date

2010-02-23

Definition at line 25 of file WatchdogThread.h.

Constructor & Destructor Documentation

WatchdogThread::WatchdogThread	(	boost::posix_time::time_duration	timeout,
		bool	autostart = false
	)

Constructor.

Definition at line 12 of file WatchdogThread.cpp.

                                                                                  :
  m_timeout(timeout), m_running(false)
{
  // Start the thread immediately if requested.
  if (autostart) start();