OpenDDS::DCPS::Watchdog Class Reference

Watchdog abstract base class. More...

#include <Watchdog.h>

Inheritance diagram for OpenDDS::DCPS::Watchdog:

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

[legend]List of all members.

Public Member Functions
void	reset_interval (const ACE_Time_Value &interval)
long	schedule_timer (const void *act, const ACE_Time_Value &interval)
int	cancel_timer (long timer_id)
	Cancel a specific timer.
void	cancel_all ()
	Cancel all associated timers.
int	reset_timer_interval (long timer_id)
	Reset interval for a specific timer.
Protected Member Functions
	Watchdog (const ACE_Time_Value &interval)
virtual	~Watchdog ()
Protected Attributes
ACE_Time_Value	interval_
	Current time interval.
Private Member Functions
int	handle_timeout (const ACE_Time_Value &, const void *act)
virtual void	execute (const void *act, bool timer_called)=0
virtual void	reschedule_deadline ()=0
	Re-schedule timer with new interval.
bool	reactor_is_shut_down () const

---

Detailed Description

Watchdog abstract base class.

A Watchdog object executes an operation each time a corresponding timer expires. The timer is managed by this class. However, it is the responsibility of the Watchdog owner, for example, to run the ACE_Reactor event loop. The Watchdog timer will not fire, otherwise.

Definition at line 33 of file Watchdog.h.

---

Constructor & Destructor Documentation

OpenDDS::DCPS::Watchdog::Watchdog

(

const ACE_Time_Value &

interval

)

[explicit, protected]

Definition at line 80 of file Watchdog.cpp.

  : ReactorInterceptor(TheServiceParticipant->reactor(),
                       TheServiceParticipant->reactor_owner())
  , interval_(interval)
{
}

OpenDDS::DCPS::Watchdog::~Watchdog

(

)

[protected, virtual]

Definition at line 87 of file Watchdog.cpp.

{
}

---

Member Function Documentation

void OpenDDS::DCPS::Watchdog::cancel_all

(

)

Cancel all associated timers.

Definition at line 120 of file Watchdog.cpp.

References OpenDDS::DCPS::ReactorInterceptor::execute_or_enqueue().

Referenced by OpenDDS::DCPS::DataWriterImpl::set_qos(), and OpenDDS::DCPS::DataReaderImpl::set_qos().

{
  CancelCommand c(this, -1);
  execute_or_enqueue(c);
}

int OpenDDS::DCPS::Watchdog::cancel_timer

(

long

timer_id

)

Cancel a specific timer.

Definition at line 113 of file Watchdog.cpp.

References OpenDDS::DCPS::ReactorInterceptor::execute_or_enqueue().

Referenced by OpenDDS::DCPS::RequestedDeadlineWatchdog::cancel_timer(), and OpenDDS::DCPS::OfferedDeadlineWatchdog::cancel_timer().

{
  CancelCommand c(this, timer_id);
  execute_or_enqueue(c);
  return 1;
}

virtual void OpenDDS::DCPS::Watchdog::execute	(	const void *	act,
		bool	timer_called
	)			[private, 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.

Referenced by handle_timeout().

int OpenDDS::DCPS::Watchdog::handle_timeout	(	const ACE_Time_Value &	,
		const void *	act
	)			[inline, private]

Definition at line 41 of file Watchdog.h.

References execute().

  {
    return execute(act, true), 0;
  }

bool OpenDDS::DCPS::Watchdog::reactor_is_shut_down

(

)

const [private, virtual]

Implements OpenDDS::DCPS::ReactorInterceptor.

Definition at line 91 of file Watchdog.cpp.

References TheServiceParticipant.

{
  return TheServiceParticipant->is_shut_down();
}

virtual void OpenDDS::DCPS::Watchdog::reschedule_deadline

(

)

[private, pure virtual]

Re-schedule timer with new interval.

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

Referenced by reset_interval().

void OpenDDS::DCPS::Watchdog::reset_interval

(

const ACE_Time_Value &

interval

)

Note:

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

Definition at line 96 of file Watchdog.cpp.

References interval_, and reschedule_deadline().

Referenced by OpenDDS::DCPS::DataWriterImpl::set_qos(), and OpenDDS::DCPS::DataReaderImpl::set_qos().

{
  if (this->interval_ != interval) {
    this->interval_ = interval;
    this->reschedule_deadline();
  }
}

int OpenDDS::DCPS::Watchdog::reset_timer_interval

(

long

timer_id

)

Reset interval for a specific timer.

Definition at line 126 of file Watchdog.cpp.

References OpenDDS::DCPS::ReactorInterceptor::execute_or_enqueue(), and interval_.

{
  ResetCommand c(this, timer_id, interval_);
  execute_or_enqueue(c);
  return 0;
}

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

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

Definition at line 104 of file Watchdog.cpp.

References OpenDDS::DCPS::ReactorInterceptor::execute_or_enqueue(), and OpenDDS::DCPS::ReactorInterceptor::wait().

Referenced by OpenDDS::DCPS::RequestedDeadlineWatchdog::schedule_timer(), and OpenDDS::DCPS::OfferedDeadlineWatchdog::schedule_timer().

{
  long timer_id = -1;
  ScheduleCommand c(this, act, interval, &timer_id);
  execute_or_enqueue(c);
  wait();
  return timer_id;
}

---

Member Data Documentation

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

Current time interval.

Definition at line 82 of file Watchdog.h.

Referenced by OpenDDS::DCPS::RequestedDeadlineWatchdog::execute(), OpenDDS::DCPS::OfferedDeadlineWatchdog::execute(), reset_interval(), and reset_timer_interval().

---

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

• Watchdog.h
• Watchdog.cpp

---