OpenDDS::DCPS::ServiceEventDispatcher Class Reference

#include <ServiceEventDispatcher.h>

Inheritance diagram for OpenDDS::DCPS::ServiceEventDispatcher:

Collaboration diagram for OpenDDS::DCPS::ServiceEventDispatcher:

Public Member Functions
	ServiceEventDispatcher (size_t count=1)
virtual	~ServiceEventDispatcher ()
void	shutdown (bool immediate=false)
bool	dispatch (EventBase_rch event)
long	schedule (EventBase_rch event, const MonotonicTimePoint &expiration=MonotonicTimePoint::now())
size_t	cancel (long id)
Public Member Functions inherited from OpenDDS::DCPS::EventDispatcher
	EventDispatcher ()
virtual	~EventDispatcher ()
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

Private Attributes
ACE_Thread_Mutex	mutex_
DispatchService_rch	dispatcher_

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

Detailed Description

Definition at line 19 of file ServiceEventDispatcher.h.

Constructor & Destructor Documentation

ServiceEventDispatcher()

OpenDDS::DCPS::ServiceEventDispatcher::ServiceEventDispatcher ( size_t  count = 1 )

explicit

Create a ServiceEventDispatcher

Parameters

count

the requested size of the internal thread pool (see DispatchService)

Definition at line 17 of file ServiceEventDispatcher.cpp.

 : dispatcher_(make_rch<DispatchService>(count))
{
}

~ServiceEventDispatcher()

OpenDDS::DCPS::ServiceEventDispatcher::~ServiceEventDispatcher ( )

virtual

Definition at line 22 of file ServiceEventDispatcher.cpp.

References shutdown().

{
  shutdown();
}

Member Function Documentation

cancel()

size_t OpenDDS::DCPS::ServiceEventDispatcher::cancel ( long  id )

virtual

Cancel a scheduled event dispatch.

Parameters

id	the id of the event timer to cancel

Returns

the number of canceled events (0 for failure to cancel, 1 for success)

Implements OpenDDS::DCPS::EventDispatcher.

Definition at line 75 of file ServiceEventDispatcher.cpp.

References OpenDDS::DCPS::RcObject::_remove_ref(), OpenDDS::DCPS::DispatchService::cancel(), dispatcher_, OpenDDS::DCPS::EventBase::handle_cancel(), mutex_, and OPENDDS_END_VERSIONED_NAMESPACE_DECL.

{
  ACE_Guard<ACE_Thread_Mutex> guard(mutex_);
  if (!dispatcher_) {
    return 0;
  }
  void* arg = 0;
  const size_t result = dispatcher_->cancel(id, &arg);
  if (result) {
    EventBase* ptr = static_cast<EventBase*>(arg);
    if (ptr) {
      ptr->handle_cancel();
      ptr->_remove_ref();
    }
  }
  return result;
}

dispatch()

bool OpenDDS::DCPS::ServiceEventDispatcher::dispatch ( EventBase_rch  event )

virtual

Dispatch an event.

Parameters

event

the event to dispatch

Returns

true if event successfully enqueue, otherwise false

Implements OpenDDS::DCPS::EventDispatcher.

Definition at line 47 of file ServiceEventDispatcher.cpp.

References OpenDDS::DCPS::DispatchService::dispatch(), dispatcher_, and mutex_.

{
  ACE_Guard<ACE_Thread_Mutex> guard(mutex_);
  if (!dispatcher_) {
    return false;
  }
  event->_add_ref();
  const bool result = dispatcher_->dispatch(*event);
  if (!result) {
    event->_remove_ref();
  }
  return result;
}

schedule()

long OpenDDS::DCPS::ServiceEventDispatcher::schedule ( EventBase_rch  event, const MonotonicTimePoint &  expiration = MonotonicTimePoint::now()  )

virtual

Schedule the future dispatch of an event.

Parameters

event	the event to dispatch
expiration	the requested dispatch time (no earlier than)

Returns

-1 on a failure, otherwise the timer id for the future dispatch

Implements OpenDDS::DCPS::EventDispatcher.

Definition at line 61 of file ServiceEventDispatcher.cpp.

References dispatcher_, mutex_, and OpenDDS::DCPS::DispatchService::schedule().

{
  ACE_Guard<ACE_Thread_Mutex> guard(mutex_);
  if (!dispatcher_) {
    return -1;
  }
  event->_add_ref();
  const long result = dispatcher_->schedule(*event, expiration);
  if (result < 0) {
    event->_remove_ref();
  }
  return result;
}

shutdown()

void OpenDDS::DCPS::ServiceEventDispatcher::shutdown ( bool  immediate = false )

virtual

Request shutdown of this EventDispatcher, which prevents sucessful future calls to either dispatch or schedule and cancels all scheduled events.

Parameters

immediate

prevent any further dispatches from event queue, otherwise allow current queue to empty

Implements OpenDDS::DCPS::EventDispatcher.

Definition at line 27 of file ServiceEventDispatcher.cpp.

References OpenDDS::DCPS::RcObject::_remove_ref(), dispatcher_, OpenDDS::DCPS::EventBase::handle_cancel(), mutex_, OpenDDS::DCPS::DispatchService::shutdown(), and OpenDDS::DCPS::RcHandle< T >::swap().

Referenced by ~ServiceEventDispatcher().

{
  DispatchService_rch local;
  {
    ACE_Guard<ACE_Thread_Mutex> guard(mutex_);
    local.swap(dispatcher_);
  }
  if (local) {
    DispatchService::EventQueue remaining;
    local->shutdown(immediate, &remaining);
    for (DispatchService::EventQueue::iterator it = remaining.begin(), limit = remaining.end(); it != limit; ++it) {
      EventBase* ptr = static_cast<EventBase*>(it->second);
      if (ptr) {
        ptr->handle_cancel();
        ptr->_remove_ref();
      }
    }
  }
}

Member Data Documentation

dispatcher_

DispatchService_rch OpenDDS::DCPS::ServiceEventDispatcher::dispatcher_

private

Definition at line 39 of file ServiceEventDispatcher.h.

Referenced by cancel(), dispatch(), schedule(), and shutdown().

mutex_

ACE_Thread_Mutex OpenDDS::DCPS::ServiceEventDispatcher::mutex_

mutableprivate

Definition at line 38 of file ServiceEventDispatcher.h.

Referenced by cancel(), dispatch(), schedule(), and shutdown().

---

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

• ServiceEventDispatcher.h
• ServiceEventDispatcher.cpp