OpenDDS::DCPS::Watchdog Class Reference

#include <Watchdog.h>

Inheritance diagram for OpenDDS::DCPS::Watchdog:

Inheritance graph
[legend]
Collaboration diagram for OpenDDS::DCPS::Watchdog:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Watchdog (ACE_Reactor *reactor, ACE_Time_Value const &interval)
 Constructor.
virtual ~Watchdog ()
 Destructor.
virtual void execute (void const *act, bool timer_called)=0
void reset_interval (ACE_Time_Value const &interval)
long schedule_timer (void *const act, const ACE_Time_Value &interval)
int cancel_timer (long const &timer_id)
 Cancel a specific timer.
void cancel_all ()
 Cancel all associated timers.
virtual void reschedule_deadline ()=0
 Re-schedule timer with new interval.
int reset_timer_interval (long const &timer_id)
 Reset interval for a specific timer.

Protected Attributes

ACE_Reactor *const reactor_
WatchdogTimer timer_
ACE_Time_Value interval_

Constructor & Destructor Documentation

OpenDDS::DCPS::Watchdog::Watchdog ( ACE_Reactor *  reactor,
ACE_Time_Value const &  interval 
)

Constructor.

OpenDDS::DCPS::Watchdog::~Watchdog (  )  [virtual]

Destructor.


Member Function Documentation

void OpenDDS::DCPS::Watchdog::cancel_all (  ) 

Cancel all associated timers.

int OpenDDS::DCPS::Watchdog::cancel_timer ( long const &  timer_id  ) 

Cancel a specific timer.

virtual void OpenDDS::DCPS::Watchdog::execute ( void const *  act,
bool  timer_called 
) [pure virtual]

Operation to be executed when the associated timer expires or whenever samples are received/sent. The timer_called flag indicates if it's called from reator handle_timeout() or upon a sample receiving/sending.

Implemented in OpenDDS::DCPS::OfferedDeadlineWatchdog, and OpenDDS::DCPS::RequestedDeadlineWatchdog.

virtual void OpenDDS::DCPS::Watchdog::reschedule_deadline (  )  [pure virtual]

Re-schedule timer with new interval.

Implemented in OpenDDS::DCPS::OfferedDeadlineWatchdog, and OpenDDS::DCPS::RequestedDeadlineWatchdog.

void OpenDDS::DCPS::Watchdog::reset_interval ( ACE_Time_Value const &  interval  ) 

Note:
The new interval takes effect after the next expiration. This behavior is dictated by the ACE_Reactor.

int OpenDDS::DCPS::Watchdog::reset_timer_interval ( long const &  timer_id  ) 

Reset interval for a specific timer.

long OpenDDS::DCPS::Watchdog::schedule_timer ( void *const   act,
const ACE_Time_Value &  interval 
)

Schedure with the Watchdog timer interval, i.e. time between recurring timer expirations.


Member Data Documentation

ACE_Time_Value OpenDDS::DCPS::Watchdog::interval_ [protected]

ACE_Reactor* const OpenDDS::DCPS::Watchdog::reactor_ [protected]

WatchdogTimer OpenDDS::DCPS::Watchdog::timer_ [protected]


The documentation for this class was generated from the following files:
Generated on Wed Nov 16 15:29:17 2011 for OpenDDS by  doxygen 1.4.7