OpenDDS::DCPS::EventBase Struct Reference

#include <EventDispatcher.h>

Inheritance diagram for OpenDDS::DCPS::EventBase:

Collaboration diagram for OpenDDS::DCPS::EventBase:

Public Member Functions
virtual	~EventBase ()
virtual void	handle_event ()=0
	Called when the event is dispatched by an EventDispatcher. More...
virtual void	handle_error ()
	Only called when an exception is caught during handle_event. More...
virtual void	handle_cancel ()
void	operator() ()
Public Member Functions inherited from OpenDDS::DCPS::RcObject
virtual	~RcObject ()
virtual void	_add_ref ()
virtual void	_remove_ref ()
long	ref_count () const
WeakObject *	_get_weak_object () const

Additional Inherited Members
Protected Member Functions inherited from OpenDDS::DCPS::RcObject
	RcObject ()

Detailed Description

EventBase is an abstract base class for events

EventBase is an abstract base class for events dispatched or scheduled by an EventDispatcher. Derived classes are required to implement handle_event which will be called when the event is dispatched by the event dispatcher

Definition at line 27 of file EventDispatcher.h.

Constructor & Destructor Documentation

~EventBase()

OpenDDS::DCPS::EventBase::~EventBase ( )

virtual

Definition at line 17 of file EventDispatcher.cpp.

{
}

Member Function Documentation

handle_cancel()

void OpenDDS::DCPS::EventBase::handle_cancel ( )

virtual

Called when the dispatch or schedule of an event is canceled by an EventDispatcher, for example when immediate shutdown is requested

Reimplemented in OpenDDS::DCPS::PeriodicEvent, and OpenDDS::DCPS::SporadicEvent.

Definition at line 25 of file EventDispatcher.cpp.

Referenced by OpenDDS::DCPS::ServiceEventDispatcher::cancel(), and OpenDDS::DCPS::ServiceEventDispatcher::shutdown().

{
}

handle_error()

void OpenDDS::DCPS::EventBase::handle_error ( void  )

virtual

Only called when an exception is caught during handle_event.

Definition at line 21 of file EventDispatcher.cpp.

Referenced by operator()().

{
}

handle_event()

virtual void OpenDDS::DCPS::EventBase::handle_event ( )

pure virtual

Called when the event is dispatched by an EventDispatcher.

Implemented in OpenDDS::RTPS::Sedp::ReaderRemoveAssociations, OpenDDS::RTPS::Sedp::ReaderAddAssociation, OpenDDS::RTPS::Sedp::WriterRemoveAssociations, OpenDDS::RTPS::Sedp::WriterAddAssociation, OpenDDS::DCPS::RtpsUdpDataLink::ReplayDurableData, OpenDDS::DCPS::TransportImpl::DoClear, OpenDDS::DCPS::PmfNowEvent< Delegate >, OpenDDS::DCPS::PeriodicEvent, OpenDDS::DCPS::PmfEvent< Delegate >, and OpenDDS::DCPS::SporadicEvent.

Referenced by operator()().

operator()()

void OpenDDS::DCPS::EventBase::operator()

(

void

)

Definition at line 29 of file EventDispatcher.cpp.

References OpenDDS::DCPS::RcObject::_remove_ref(), handle_error(), and handle_event().

{
  try {
    handle_event();
  } catch (...) {
    handle_error();
  }
  // In order to avoid extra allocations for containers of RcHandle<EventBase>
  // implementations of EventDispatcher will increase the reference count of
  // all queued EventBase objects, and decrement them when they are dispatched
  // or canceled.
  // Since the EventDispatcher does not directly hold copies of the events,
  // decrementing the reference count after a normal dispatch currently needs
  // to happen here in the call to EventBase::operator()() after handle_event.
  this->_remove_ref();
}

---

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

• EventDispatcher.h
• EventDispatcher.cpp