OpenDDS::DCPS::DataLinkWatchdog Class Reference

#include <DataLinkWatchdog_T.h>

Inheritance diagram for OpenDDS::DCPS::DataLinkWatchdog:

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

[legend]List of all members.

Public Member Functions
bool	schedule (const void *arg=0)
bool	schedule_now (const void *arg=0)
void	cancel ()
int	handle_timeout (const ACE_Time_Value &now, const void *arg)
Protected Member Functions
	DataLinkWatchdog (ACE_Reactor *reactor, ACE_thread_t owner)
virtual	~DataLinkWatchdog ()
virtual ACE_Time_Value	next_interval ()=0
virtual void	on_interval (const void *arg)=0
virtual ACE_Time_Value	next_timeout ()
virtual void	on_timeout (const void *)
Private Member Functions
bool	schedule_i (const void *arg, bool nodelay)
void	cancel_i ()
Private Attributes
long	timer_id_
ACE_Time_Value	epoch_
bool	cancelled_
Classes
class	CancelCommand
class	CommandBase
class	ScheduleCommand

---

Detailed Description

Definition at line 24 of file DataLinkWatchdog_T.h.

---

Constructor & Destructor Documentation

OpenDDS::DCPS::DataLinkWatchdog::DataLinkWatchdog	(	ACE_Reactor *	reactor,
		ACE_thread_t	owner
	)			[inline, protected]

Definition at line 73 of file DataLinkWatchdog_T.h.

    : ReactorInterceptor(reactor, owner)
    , timer_id_(-1)
    , cancelled_(false)
  {}

virtual OpenDDS::DCPS::DataLinkWatchdog::~DataLinkWatchdog

(

)

[inline, protected, virtual]

Definition at line 80 of file DataLinkWatchdog_T.h.

                              {
  }

---

Member Function Documentation

void OpenDDS::DCPS::DataLinkWatchdog::cancel

(

)

[inline]

Definition at line 39 of file DataLinkWatchdog_T.h.

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

Referenced by OpenDDS::DCPS::ReliableSession::stop(), OpenDDS::DCPS::MulticastSession::stop(), OpenDDS::DCPS::MulticastSession::synack_received(), OpenDDS::DCPS::MulticastSession::~MulticastSession(), and OpenDDS::DCPS::ReliableSession::~ReliableSession().

                {
    CancelCommand c(this);
    execute_or_enqueue(c);
  }

void OpenDDS::DCPS::DataLinkWatchdog::cancel_i

(

)

[inline, private]

Definition at line 169 of file DataLinkWatchdog_T.h.

References cancelled_, and timer_id_.

Referenced by OpenDDS::DCPS::DataLinkWatchdog::CancelCommand::execute(), and handle_timeout().

                  {
    if (this->timer_id_ == -1) return;

    this->timer_id_ = -1;
    this->cancelled_ = true;
    reactor()->cancel_timer(this);
  }

int OpenDDS::DCPS::DataLinkWatchdog::handle_timeout	(	const ACE_Time_Value &	now,
		const void *	arg
	)			[inline]

Definition at line 44 of file DataLinkWatchdog_T.h.

References cancel_i(), epoch_, next_timeout(), on_interval(), on_timeout(), and schedule_i().

                                                                 {
    ACE_Time_Value timeout = next_timeout();

    if (timeout != ACE_Time_Value::zero) {
      timeout += this->epoch_;
      if (now > timeout) {
        on_timeout(arg);
        {
          cancel_i();
        }
        return 0;
      }
    }

    on_interval(arg);

    {
      if (!schedule_i(arg, false)) {
        ACE_ERROR((LM_WARNING,
                   ACE_TEXT("(%P|%t) WARNING: ")
                   ACE_TEXT("DataLinkWatchdog::handle_timeout: ")
                   ACE_TEXT("unable to reschedule watchdog timer!\n")));
      }
    }

    return 0;
  }

virtual ACE_Time_Value OpenDDS::DCPS::DataLinkWatchdog::next_interval

(

)

[protected, pure virtual]

Implemented in OpenDDS::DCPS::SynWatchdog, and OpenDDS::DCPS::NakWatchdog.

Referenced by schedule_i().

virtual ACE_Time_Value OpenDDS::DCPS::DataLinkWatchdog::next_timeout

(

)

[inline, protected, virtual]

Reimplemented in OpenDDS::DCPS::SynWatchdog.

Definition at line 86 of file DataLinkWatchdog_T.h.

Referenced by handle_timeout().

{ return ACE_Time_Value::zero; }

virtual void OpenDDS::DCPS::DataLinkWatchdog::on_interval

(

const void *

arg

)

[protected, pure virtual]

Implemented in OpenDDS::DCPS::SynWatchdog, and OpenDDS::DCPS::NakWatchdog.

Referenced by handle_timeout().

virtual void OpenDDS::DCPS::DataLinkWatchdog::on_timeout

(

const void *

)

[inline, protected, virtual]

Reimplemented in OpenDDS::DCPS::SynWatchdog.

Definition at line 87 of file DataLinkWatchdog_T.h.

Referenced by handle_timeout().

{}

bool OpenDDS::DCPS::DataLinkWatchdog::schedule

(

const void *

arg = 0

)

[inline]

Definition at line 27 of file DataLinkWatchdog_T.h.

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

                                     {
    ScheduleCommand c(this, arg, false);
    execute_or_enqueue(c);
    return true;
  }

bool OpenDDS::DCPS::DataLinkWatchdog::schedule_i	(	const void *	arg,
		bool	nodelay
	)			[inline, private]

Definition at line 132 of file DataLinkWatchdog_T.h.

References epoch_, next_interval(), and timer_id_.

Referenced by OpenDDS::DCPS::DataLinkWatchdog::ScheduleCommand::execute(), and handle_timeout().

                                                 {
    if (this->cancelled_) return true;

    ACE_Time_Value delay;
    if (!nodelay) delay = next_interval();

    if (this->epoch_ == ACE_Time_Value::zero) {
      this->epoch_ = ACE_OS::gettimeofday();
    }

    long timer_id = -1;
    {
      timer_id = reactor()->schedule_timer(this,  // event_handler
                                           arg,
                                           delay);

      if (timer_id == -1) {
        ACE_ERROR_RETURN ((LM_ERROR,
                  ACE_TEXT("(%P|%t) ERROR: ")
                  ACE_TEXT("DataLinkWatchdog::schedule_i: ")
                  ACE_TEXT("failed to register timer %p!\n"),
                  ACE_TEXT("schedule_timer")), false);
      }
    }

    //after re-acquiring lock_ need to check cancelled_
    if (this->cancelled_) {
      reactor()->cancel_timer(timer_id);
      return true;
    }
    else {
      this->timer_id_ = timer_id;
    }

    return this->timer_id_ != -1;
  }

bool OpenDDS::DCPS::DataLinkWatchdog::schedule_now

(

const void *

arg = 0

)

[inline]

Definition at line 33 of file DataLinkWatchdog_T.h.

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

Referenced by OpenDDS::DCPS::MulticastSession::start_syn().

                                         {
    ScheduleCommand c(this, arg, true);
    execute_or_enqueue(c);
    return true;
  }

---

Member Data Documentation

bool OpenDDS::DCPS::DataLinkWatchdog::cancelled_ [private]

Definition at line 130 of file DataLinkWatchdog_T.h.

Referenced by cancel_i().

ACE_Time_Value OpenDDS::DCPS::DataLinkWatchdog::epoch_ [private]

Definition at line 129 of file DataLinkWatchdog_T.h.

Referenced by handle_timeout(), and schedule_i().

long OpenDDS::DCPS::DataLinkWatchdog::timer_id_ [private]

Definition at line 127 of file DataLinkWatchdog_T.h.

Referenced by cancel_i(), and schedule_i().

---

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

• DataLinkWatchdog_T.h

---