#include <UpdateReceiver_T.h>

Inheritance diagram for OpenDDS::Federator::UpdateReceiver< DataType >:

[legend]

Collaboration diagram for OpenDDS::Federator::UpdateReceiver< DataType >:

[legend]

Public Member Functions
	UpdateReceiver (UpdateProcessor< DataType > &processor)
	Construct with a processor reference. More...

virtual	~UpdateReceiver ()

virtual int	open (void *)

virtual int	svc ()

virtual int	close (u_long flags=0)

void	add (OpenDDS::DCPS::unique_ptr< DataType > sample, OpenDDS::DCPS::unique_ptr< DDS::SampleInfo > info)
	Sample enqueueing. More...

void	stop ()
	Synchronous termination. More...

Public Member Functions inherited from ACE_Task_Base
	ACE_Task_Base (ACE_Thread_Manager *=0)

virtual	~ACE_Task_Base (void)

virtual int	module_closed (void)

virtual int	put (ACE_Message_Block , ACE_Time_Value =0)

virtual int	activate (long flags=THR_NEW_LWP\|THR_JOINABLE\|THR_INHERIT_SCHED, int n_threads=1, int force_active=0, long priority=ACE_DEFAULT_THREAD_PRIORITY, int grp_id=-1, ACE_Task_Base task=0, ACE_hthread_t thread_handles[]=0, void stack[]=0, size_t stack_size[]=0, ACE_thread_t thread_ids[]=0, const char *thr_name[]=0)

virtual int	wait (void)

virtual int	suspend (void)

virtual int	resume (void)

int	grp_id (void) const

void	grp_id (int)

ACE_Thread_Manager *	thr_mgr (void) const

void	thr_mgr (ACE_Thread_Manager *)

int	is_reader (void) const

int	is_writer (void) const

size_t	thr_count (void) const

ACE_thread_t	last_thread (void) const

Public Member Functions inherited from ACE_Service_Object
	ACE_Service_Object (ACE_Reactor *=0)

virtual	~ACE_Service_Object (void)

Public Member Functions inherited from ACE_Event_Handler
virtual	~ACE_Event_Handler (void)

virtual ACE_HANDLE	get_handle (void) const

virtual void	set_handle (ACE_HANDLE)

virtual int	priority (void) const

virtual void	priority (int priority)

virtual int	handle_input (ACE_HANDLE fd=ACE_INVALID_HANDLE)

virtual int	handle_output (ACE_HANDLE fd=ACE_INVALID_HANDLE)

virtual int	handle_exception (ACE_HANDLE fd=ACE_INVALID_HANDLE)

virtual int	handle_timeout (const ACE_Time_Value &current_time, const void *act=0)

virtual int	handle_exit (ACE_Process *)

virtual int	handle_close (ACE_HANDLE handle, ACE_Reactor_Mask close_mask)

virtual int	handle_signal (int signum, siginfo_t =0, ucontext_t =0)

virtual int	resume_handler (void)

virtual int	handle_qos (ACE_HANDLE=ACE_INVALID_HANDLE)

virtual int	handle_group_qos (ACE_HANDLE=ACE_INVALID_HANDLE)

virtual void	reactor (ACE_Reactor *reactor)

virtual ACE_Reactor *	reactor (void) const

virtual ACE_Reactor_Timer_Interface *	reactor_timer_interface (void) const

virtual Reference_Count	add_reference (void)

virtual Reference_Count	remove_reference (void)

Reference_Counting_Policy &	reference_counting_policy (void)

Public Member Functions inherited from ACE_Shared_Object
	ACE_Shared_Object (void)

virtual	~ACE_Shared_Object (void)

virtual int	init (int argc, ACE_TCHAR *argv[])

virtual int	fini (void)

virtual int	info (ACE_TCHAR **info_string, size_t length=0) const

Private Types
typedef std::pair< DataType , DDS::SampleInfo >	DataInfo
	Contents of the queue. More...

Private Attributes
UpdateProcessor< DataType > &	processor_
	The object that we delegate update processing to. More...

bool	stop_
	Termination flag. More...

ACE_SYNCH_MUTEX	lock_
	Protect queue modifications. More...

ACE_Condition< ACE_SYNCH_MUTEX >	workAvailable_
	Work to do indicator. More...

std::list< DataInfo >	queue_
	Queue of publication data to process. More...

Additional Inherited Members
Public Types inherited from ACE_Event_Handler
typedef long	Reference_Count

Static Public Member Functions inherited from ACE_Task_Base
static ACE_THR_FUNC_RETURN	svc_run (void *)

static void	cleanup (void object, void params)

Static Public Member Functions inherited from ACE_Event_Handler
static ACE_THR_FUNC_RETURN	read_adapter (void *event_handler)

static int	register_stdin_handler (ACE_Event_Handler eh, ACE_Reactor reactor, ACE_Thread_Manager *thr_mgr, int flags=THR_DETACHED)

static int	remove_stdin_handler (ACE_Reactor reactor, ACE_Thread_Manager thr_mgr)

Public Attributes inherited from ACE_Service_Object
	ACE_ALLOC_HOOK_DECLARE

Public Attributes inherited from ACE_Event_Handler
	LO_PRIORITY

	HI_PRIORITY

	NULL_MASK

	READ_MASK

	WRITE_MASK

	EXCEPT_MASK

	ACCEPT_MASK

	CONNECT_MASK

	TIMER_MASK

	QOS_MASK

	GROUP_QOS_MASK

	SIGNAL_MASK

	ALL_EVENTS_MASK

	RWE_MASK

	DONT_CALL

	ACE_EVENT_HANDLER_NOT_RESUMED

	ACE_REACTOR_RESUMES_HANDLER

	ACE_APPLICATION_RESUMES_HANDLER

Protected Types inherited from ACE_Event_Handler
typedef ACE_Atomic_Op< ACE_SYNCH_MUTEX, Reference_Count >	Atomic_Reference_Count

Protected Member Functions inherited from ACE_Event_Handler
	ACE_Event_Handler (ACE_Reactor *=0, int priority=ACE_Event_Handler::LO_PRIORITY)

Protected Attributes inherited from ACE_Task_Base
size_t	thr_count_

ACE_Thread_Manager *	thr_mgr_

u_long	flags_

int	grp_id_

ACE_thread_t	last_thread_id_

Protected Attributes inherited from ACE_Event_Handler
Atomic_Reference_Count	reference_count_

Detailed Description

template<class DataType>
class OpenDDS::Federator::UpdateReceiver< DataType >

Definition at line 35 of file UpdateReceiver_T.h.

Member Typedef Documentation

◆ DataInfo

template<class DataType>

typedef std::pair<DataType*, DDS::SampleInfo* > OpenDDS::Federator::UpdateReceiver< DataType >::DataInfo

private

Contents of the queue.

Definition at line 76 of file UpdateReceiver_T.h.

Constructor & Destructor Documentation

◆ UpdateReceiver()

template<class DataType>

OpenDDS::Federator::UpdateReceiver< DataType >::UpdateReceiver ( UpdateProcessor< DataType > & processor )

Construct with a processor reference.

Definition at line 26 of file UpdateReceiver_T.cpp.

   : processor_(processor),
     stop_(false),
     workAvailable_(this->lock_)
 {
   if (OpenDDS::DCPS::DCPS_debug_level > 0) {
     ACE_DEBUG((LM_DEBUG,
                ACE_TEXT("(%P|%t) UpdateReceiver::UpdateReceiver()\n")));
   }
 
   // Always execute the thread.
   this->open(0);
 }

◆ ~UpdateReceiver()

template<class DataType >

OpenDDS::Federator::UpdateReceiver< DataType >::~UpdateReceiver ( )

virtual

Definition at line 41 of file UpdateReceiver_T.cpp.

 {
   if (OpenDDS::DCPS::DCPS_debug_level > 0) {
     ACE_DEBUG((LM_DEBUG,
                ACE_TEXT("(%P|%t) UpdateReceiver::~UpdateReceiver()\n")));
   }
 
   // Cleanly terminate.
   this->stop();
   this->wait();
 }

Member Function Documentation

◆ add()

template<class DataType>

void OpenDDS::Federator::UpdateReceiver< DataType >::add	(	OpenDDS::DCPS::unique_ptr< DataType >	sample,
		OpenDDS::DCPS::unique_ptr< DDS::SampleInfo >	info
	)

Sample enqueueing.

Parameters

sample	- pointer to the received sample to be processed
info	- pointer to the info about the sample to be processed.

NOTE: We take ownership of this data and delete it when we are done processing it.

Definition at line 103 of file UpdateReceiver_T.cpp.

 {
   if (OpenDDS::DCPS::DCPS_debug_level > 0) {
     ACE_DEBUG((LM_DEBUG,
                ACE_TEXT("(%P|%t) UpdateReceiver::add()\n")));
   }
 
   if (this->stop_)
     return;
 
   { // Protect the queue.
     ACE_GUARD(ACE_SYNCH_MUTEX, guard, this->lock_);
     this->queue_.push_back(DataInfo(sample.release(), info.release()));
 
     if (OpenDDS::DCPS::DCPS_debug_level > 9) {
       ACE_DEBUG((LM_DEBUG,
                  ACE_TEXT("(%P|%t) UpdateReceiver::add() - ")
                  ACE_TEXT(" %d samples waiting to process in 0x%x.\n"),
                  this->queue_.size(),
                  (void*)this));
     }
   }
 
   this->workAvailable_.signal();
 }

◆ close()

template<class DataType >

int OpenDDS::Federator::UpdateReceiver< DataType >::close ( u_long flags = 0 )

virtual

Reimplemented from ACE_Task_Base.

Definition at line 68 of file UpdateReceiver_T.cpp.

 {
   if (OpenDDS::DCPS::DCPS_debug_level > 0) {
     ACE_DEBUG((LM_DEBUG,
                ACE_TEXT("(%P|%t) UpdateReceiver::close()\n")));
   }
 
   while (this->queue_.size()) {
     delete this->queue_.front().first;
     delete this->queue_.front().second;
     this->queue_.pop_front();
   }
 
   return 0;
 }

◆ open()

template<class DataType >

int OpenDDS::Federator::UpdateReceiver< DataType >::open ( void * )

virtual

Reimplemented from ACE_Task_Base.

Definition at line 55 of file UpdateReceiver_T.cpp.

 {
   if (OpenDDS::DCPS::DCPS_debug_level > 0) {
     ACE_DEBUG((LM_DEBUG,
                ACE_TEXT("(%P|%t) UpdateReceiver::open()\n")));
   }
 
   // Run as a separate thread.
   return this->activate();
 }

◆ stop()

template<class DataType >

void OpenDDS::Federator::UpdateReceiver< DataType >::stop ( void )

Synchronous termination.

Definition at line 86 of file UpdateReceiver_T.cpp.

 {
   if (OpenDDS::DCPS::DCPS_debug_level > 0) {
     ACE_DEBUG((LM_DEBUG,
                ACE_TEXT("(%P|%t) UpdateReceiver::stop()\n")));
   }
 
   // Indicate the thread should stop and get its attention.
   if (this->stop_)
     return;
 
   this->stop_ = true;
   this->workAvailable_.signal();
 }

◆ svc()

template<class DataType >

int OpenDDS::Federator::UpdateReceiver< DataType >::svc ( void )

virtual

Reimplemented from ACE_Task_Base.

Definition at line 131 of file UpdateReceiver_T.cpp.

 {
   if (OpenDDS::DCPS::DCPS_debug_level > 0) {
     ACE_DEBUG((LM_DEBUG,
                ACE_TEXT("(%P|%t) UpdateReceiver::svc()\n")));
   }
 
   // Continue until we are synchronously terminated.
   while (this->stop_ == false) {
     { // Block until there is work to do.
       ACE_GUARD_RETURN(ACE_SYNCH_MUTEX, guard, this->lock_, 0);
 
       while (this->queue_.size() == 0) {
         // This releases the lock while we block.
         this->workAvailable_.wait();
 
         if (OpenDDS::DCPS::DCPS_debug_level > 9) {
           ACE_DEBUG((LM_DEBUG,
                      ACE_TEXT("(%P|%t) UpdateReceiver::svc() - ")
                      ACE_TEXT("wakeup in 0x%x.\n"),
                      (void*)this));
         }
 
         // We were asked to stop instead.
         if (this->stop_ == true) {
           if (OpenDDS::DCPS::DCPS_debug_level > 4) {
             ACE_DEBUG((LM_DEBUG,
                        ACE_TEXT("(%P|%t) UpdateReceiver::svc() - ")
                        ACE_TEXT("discontinuing processing after wakeup in 0x%x.\n"),
                        (void*)this));
           }
 
           return 0;
         }
       }
     }
 
     if (OpenDDS::DCPS::DCPS_debug_level > 0) {
       ACE_DEBUG((LM_DEBUG,
                  ACE_TEXT("(%P|%t) UpdateReceiver::svc() - ")
                  ACE_TEXT("processing a sample in 0x%x.\n"),
                  (void*)this));
     }
 
     // Delegate actual processing to the publication manager.
     this->processor_.processSample(
       this->queue_.front().first,
       this->queue_.front().second);
 
     { // Remove the completed work.
       ACE_GUARD_RETURN(ACE_SYNCH_MUTEX, guard, this->lock_, 0);
       delete this->queue_.front().first;
       delete this->queue_.front().second;
       this->queue_.pop_front();
     }
   }
 
   if (OpenDDS::DCPS::DCPS_debug_level > 4) {
     ACE_DEBUG((LM_DEBUG,
                ACE_TEXT("(%P|%t) UpdateReceiver::svc() - ")
                ACE_TEXT("discontinuing processing after sample complete in 0x%x.\n"),
                (void*)this));
   }
 
   return 0;
 }

Definition at line 73 of file UpdateReceiver_T.h.

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

Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

template<class DataType> class OpenDDS::Federator::UpdateReceiver< DataType >

Member Typedef Documentation

◆ DataInfo

Constructor & Destructor Documentation

◆ UpdateReceiver()

◆ ~UpdateReceiver()

Member Function Documentation

◆ add()

◆ close()

◆ open()

◆ stop()

◆ svc()

Member Data Documentation

◆ lock_

◆ processor_

◆ queue_

◆ stop_

◆ workAvailable_

template<class DataType>
class OpenDDS::Federator::UpdateReceiver< DataType >