#include <PerConnectionSynch.h>

Inheritance diagram for OpenDDS::DCPS::PerConnectionSynch:

[legend]

Collaboration diagram for OpenDDS::DCPS::PerConnectionSynch:

[legend]

Public Member Functions
	PerConnectionSynch (ThreadSynchResource *synch_resource, long priority, long scheduler)

virtual	~PerConnectionSynch ()

virtual void	work_available ()

virtual int	open (void *)

virtual int	svc ()

virtual int	close (u_long)

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

Public Member Functions inherited from OpenDDS::DCPS::ThreadSynch
virtual	~ThreadSynch ()

int	register_worker (ThreadSynchWorker &worker)

void	unregister_worker ()
	Our owner, the worker_, is breaking our relationship. More...

Protected Member Functions
virtual int	register_worker_i ()

virtual void	unregister_worker_i ()

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

Protected Member Functions inherited from OpenDDS::DCPS::ThreadSynch
	ThreadSynch (ThreadSynchResource *resource)

int	wait_on_clogged_resource ()

WeakRcHandle< ThreadSynchWorker >	worker ()
	Access the worker implementation directly. More...

Private Types
typedef ACE_SYNCH_MUTEX	LockType

typedef ACE_Guard< LockType >	GuardType

typedef ConditionVariable< LockType >	ConditionVariableType

Private Attributes
LockType	lock_

ConditionVariableType	condition_

int	work_available_

int	shutdown_

long	dds_priority_

long	scheduler_

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 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

Definition at line 23 of file PerConnectionSynch.h.

Member Typedef Documentation

◆ ConditionVariableType

typedef ConditionVariable<LockType> OpenDDS::DCPS::PerConnectionSynch::ConditionVariableType

private

Definition at line 47 of file PerConnectionSynch.h.

◆ GuardType

typedef ACE_Guard<LockType> OpenDDS::DCPS::PerConnectionSynch::GuardType

private

Definition at line 46 of file PerConnectionSynch.h.

◆ LockType

typedef ACE_SYNCH_MUTEX OpenDDS::DCPS::PerConnectionSynch::LockType

private

Definition at line 45 of file PerConnectionSynch.h.

Constructor & Destructor Documentation

◆ PerConnectionSynch()

ACE_INLINE OpenDDS::DCPS::PerConnectionSynch::PerConnectionSynch	(	ThreadSynchResource *	synch_resource,
		long	priority,
		long	scheduler
	)

Definition at line 11 of file PerConnectionSynch.inl.

References DBG_ENTRY_LVL.

   : ThreadSynch(synch_resource),
     condition_(this->lock_),
     work_available_(0),
     shutdown_(0),
     dds_priority_(priority),
     scheduler_(scheduler)
 {
   DBG_ENTRY_LVL("PerConnectionSynch","PerConnectionSynch",6);
 }

◆ ~PerConnectionSynch()

OpenDDS::DCPS::PerConnectionSynch::~PerConnectionSynch ( )

virtual

Definition at line 19 of file PerConnectionSynch.cpp.

References DBG_ENTRY_LVL.

 {
   DBG_ENTRY_LVL("PerConnectionSynch","~PerConnectionSynch",6);
 }

Member Function Documentation

◆ close()

int OpenDDS::DCPS::PerConnectionSynch::close ( u_long )

virtual

Reimplemented from ACE_Task_Base.

Definition at line 170 of file PerConnectionSynch.cpp.

References DBG_ENTRY_LVL.

 {
   DBG_ENTRY_LVL("PerConnectionSynch","close",6);
   return 0;
 }

◆ open()

int OpenDDS::DCPS::PerConnectionSynch::open ( void * )

virtual

Reimplemented from ACE_Task_Base.

Definition at line 34 of file PerConnectionSynch.cpp.

References ACE_DEBUG, ACE_TEXT(), ACE_Task_Base::activate(), DBG_ENTRY_LVL, OpenDDS::DCPS::DCPS_debug_level, dds_priority_, LM_DEBUG, scheduler_, and shutdown_.

Referenced by register_worker_i().

 {
   DBG_ENTRY_LVL("PerConnectionSynch","open",6);
   // Activate this object to start a new thread that will call
   // our svc() method, and then our close() method.
   this->shutdown_ = 0;
 
   long flags;
   flags  = THR_NEW_LWP | THR_JOINABLE ;//|THR_SCOPE_PROCESS | THR_SCOPE_THREAD;
 
   if (this->scheduler_ >= 0) {
     flags |= THR_EXPLICIT_SCHED | this->scheduler_;
 
   } else {
     flags |= THR_INHERIT_SCHED;
   }
 
   if (DCPS_debug_level > 0) {
     ACE_DEBUG((LM_DEBUG,
                ACE_TEXT("(%P|%t) PerConnectionSynch::open(): ")
                ACE_TEXT("activating thread with flags 0x%08.8x ")
                ACE_TEXT("and priority %d.\n"),
                flags,
                this->dds_priority_));
   }
 
   return this->activate(flags, 1, 0, this->dds_priority_);
 }

◆ register_worker_i()

int OpenDDS::DCPS::PerConnectionSynch::register_worker_i ( )

protectedvirtual

The default implementation is to do nothing here. The subclass may override the implementation in order to do something when the worker registers. Returns 0 for success, -1 for failure.

Reimplemented from OpenDDS::DCPS::ThreadSynch.

Definition at line 177 of file PerConnectionSynch.cpp.

References DBG_ENTRY_LVL, and open().

 {
   DBG_ENTRY_LVL("PerConnectionSynch","register_worker_i",6);
   return this->open(0);
 }

◆ svc()

int OpenDDS::DCPS::PerConnectionSynch::svc ( void )

virtual

Reimplemented from ACE_Task_Base.

Definition at line 64 of file PerConnectionSynch.cpp.

References condition_, DBG_ENTRY_LVL, LM_DEBUG, lock_, shutdown_, SIG_SETMASK, ACE_OS::sigfillset(), TheServiceParticipant, ACE_OS::thr_sigsetmask(), VDBG, VDBG_LVL, OpenDDS::DCPS::ConditionVariable< Mutex >::wait(), OpenDDS::DCPS::ThreadSynch::wait_on_clogged_resource(), work_available_, OpenDDS::DCPS::ThreadSynchWorker::WORK_OUTCOME_BROKEN_RESOURCE, OpenDDS::DCPS::ThreadSynchWorker::WORK_OUTCOME_CLOGGED_RESOURCE, OpenDDS::DCPS::ThreadSynchWorker::WORK_OUTCOME_NO_MORE_TO_DO, and OpenDDS::DCPS::ThreadSynch::worker().

 {
   ThreadStatusManager& thread_status_manager = TheServiceParticipant->get_thread_status_manager();
   ThreadStatusManager::Start s(thread_status_manager, "PerConnectionSynch");
 
   DBG_ENTRY_LVL("PerConnectionSynch","svc",6);
 
   // Ignore all signals to avoid
   // ERROR: ACE::handle_write_ready return -1 while waiting  to unclog. handle_write_ready: Interrupted system call
   // The main thread will handle signals.
   sigset_t set;
   ACE_OS::sigfillset(&set);
   ACE_OS::thr_sigsetmask(SIG_SETMASK, &set, NULL);
 
   ThreadSynchWorker::WorkOutcome work_outcome =
     ThreadSynchWorker::WORK_OUTCOME_NO_MORE_TO_DO;
 
 
   RcHandle<ThreadSynchWorker> worker = this->worker().lock();
 
   if (! worker)
     return ThreadSynchWorker::WORK_OUTCOME_NO_MORE_TO_DO;
 
   // Loop until we honor the shutdown_ flag.
   while (true) {
     VDBG((LM_DEBUG,"(%P|%t) DBG:   "
           "Top of infinite svc() loop\n"));
 
     {
       GuardType guard(this->lock_);
 
       VDBG((LM_DEBUG,"(%P|%t) DBG:   "
             "Lock acquired.  Check to see what to do next.\n"));
 
       // We will wait on the condition_ if all of the following are true:
       //
       //   1) The last time the perform_work() method was called, it
       //      indicated that there was no more work to do.
       //   2) Since we last invoked perform_work(), we have not been
       //      informed that there is work_available().
       //   3) We have not been asked to shutdown_ the svc() loop.
       //
       while ((work_outcome ==
               ThreadSynchWorker::WORK_OUTCOME_NO_MORE_TO_DO) &&
              (this->work_available_ == 0) &&
              (this->shutdown_       == 0)) {
         VDBG((LM_DEBUG,"(%P|%t) DBG:   "
               "No work to do.  Just wait on the condition.\n"));
         this->condition_.wait(thread_status_manager);
         VDBG((LM_DEBUG,"(%P|%t) DBG:   "
               "We are awake from waiting on the condition.\n"));
       }
 
       // Maybe we have been asked to shutdown_ the svc() loop.
       if (this->shutdown_ == 1) {
         VDBG_LVL((LM_DEBUG,"(%P|%t) DBG:   "
                   "Honoring the shutdown request.\n"), 5);
         // We are honoring the request to shutdown_ the svc() loop.
         break;
       }
 
       // Or, perhaps we experienced a fatal error on our last call to
       // perform_work().
       if (work_outcome == ThreadSynchWorker::WORK_OUTCOME_BROKEN_RESOURCE) {
         VDBG_LVL((LM_DEBUG,"(%P|%t) DBG:   "
                   "Fatal error - Broken SynchResounce.\n"), 5);
         // Stop the svc() loop.
         break;
       }
 
       VDBG_LVL((LM_DEBUG,"(%P|%t) DBG:   "
                 "Reset our work_available_ flag to 0, and release lock.\n"), 5);
 
       // Set our work_available_ flag to false (0) before we release the
       // lock so that we will only count any work_available() calls that
       // happen after this point.
       this->work_available_ = 0;
     }
 
     if (work_outcome == ThreadSynchWorker::WORK_OUTCOME_CLOGGED_RESOURCE) {
       VDBG_LVL((LM_DEBUG,"(%P|%t) DBG:   Need to wait for clogged resources to open up.\n"), 5);
 
       // Ask the ThreadSynchResource to block us until the clog situation
       // clears up.
       if (this->wait_on_clogged_resource() == -1) {
         VDBG_LVL((LM_DEBUG,"(%P|%t) DBG:   "
                   "Fatal error - wait_on_clogged_resource fails.\n"), 5);
         break;
       }
     }
 
     VDBG((LM_DEBUG,"(%P|%t) DBG:   "
           "Call perform_work()\n"));
 
     // Without the lock, ask the worker to perform some work.  It tells
     // us if it completed with more work to still be performed (or not).
     work_outcome = worker->perform_work();
 
     VDBG_LVL((LM_DEBUG,"(%P|%t) DBG:   "
               "call to perform_work() returned %d\n",work_outcome), 5);
   }
 
   return 0;
 }

◆ unregister_worker_i()

void OpenDDS::DCPS::PerConnectionSynch::unregister_worker_i ( )

protectedvirtual

The default implementation is to do nothing here. The subclass may override the implementation in order to do something when the worker unregisters.

Reimplemented from OpenDDS::DCPS::ThreadSynch.

Definition at line 184 of file PerConnectionSynch.cpp.

References condition_, DBG_ENTRY_LVL, lock_, OpenDDS::DCPS::ConditionVariable< Mutex >::notify_one(), shutdown_, TheServiceParticipant, and ACE_Task_Base::wait().

 {
   DBG_ENTRY_LVL("PerConnectionSynch","unregister_worker_i",6);
   // It is at this point that we need to stop the thread that
   // was activated when our open() method was called.
   {
     // Acquire the lock
     GuardType guard(this->lock_);
 
     // Set the shutdown_ flag to false to shutdown the svc() method loop.
     this->shutdown_ = 1;
 
     // Signal the condition_ object in case the svc() method is currently
     // blocked wait()'ing on the condition.
     condition_.notify_one();
   }
 
   // Wait for all threads running this task (there should just be one thread)
   // to finish.
 
   ThreadStatusManager::Sleeper s(TheServiceParticipant->get_thread_status_manager());
   this->wait();
 }

◆ work_available()

void OpenDDS::DCPS::PerConnectionSynch::work_available ( )

virtual

The ThreadSynchWorker would like to have its perform_work() called from the appropriate thread once the ThreadSynchResource claims that it is_ready_for_work().

Implements OpenDDS::DCPS::ThreadSynch.

Definition at line 25 of file PerConnectionSynch.cpp.

References condition_, DBG_ENTRY_LVL, lock_, OpenDDS::DCPS::ConditionVariable< Mutex >::notify_one(), and work_available_.

 {
   DBG_ENTRY_LVL("PerConnectionSynch","work_available",6);
   GuardType guard(this->lock_);
   this->work_available_ = 1;
   condition_.notify_one();
 }

Member Data Documentation

◆ condition_

ConditionVariableType OpenDDS::DCPS::PerConnectionSynch::condition_

private

Definition at line 50 of file PerConnectionSynch.h.

Referenced by svc(), unregister_worker_i(), and work_available().

◆ dds_priority_

long OpenDDS::DCPS::PerConnectionSynch::dds_priority_

private

Definition at line 53 of file PerConnectionSynch.h.

Referenced by open().

◆ lock_

LockType OpenDDS::DCPS::PerConnectionSynch::lock_

private

Definition at line 49 of file PerConnectionSynch.h.

Referenced by svc(), unregister_worker_i(), and work_available().

◆ scheduler_

long OpenDDS::DCPS::PerConnectionSynch::scheduler_

private

Definition at line 54 of file PerConnectionSynch.h.

Referenced by open().

◆ shutdown_

int OpenDDS::DCPS::PerConnectionSynch::shutdown_

private

Definition at line 52 of file PerConnectionSynch.h.

Referenced by open(), svc(), and unregister_worker_i().

◆ work_available_

int OpenDDS::DCPS::PerConnectionSynch::work_available_

private

Definition at line 51 of file PerConnectionSynch.h.

Referenced by svc(), and work_available().

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

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConditionVariableType

◆ GuardType

◆ LockType

Constructor & Destructor Documentation

◆ PerConnectionSynch()

◆ ~PerConnectionSynch()

Member Function Documentation

◆ close()

◆ open()

◆ register_worker_i()

◆ svc()

◆ unregister_worker_i()

◆ work_available()

Member Data Documentation

◆ condition_

◆ dds_priority_

◆ lock_

◆ scheduler_

◆ shutdown_

◆ work_available_