Execute the requests of sending a sample or control message. More...

#include <ThreadPerConnectionSendTask.h>

Inheritance diagram for OpenDDS::DCPS::ThreadPerConnectionSendTask:

[legend]

Collaboration diagram for OpenDDS::DCPS::ThreadPerConnectionSendTask:

[legend]

Public Member Functions
	ThreadPerConnectionSendTask (DataLink *link)

virtual	~ThreadPerConnectionSendTask ()

int	add_request (SendStrategyOpType op, TransportQueueElement *element=0)

virtual int	open (void *=0)
	Activate the worker threads. More...

virtual int	svc ()
	The "mainline" executed by the worker thread. More...

virtual int	close (u_long flag=0)
	Called when the thread exits. More...

RemoveResult	remove_sample (const DataSampleElement *element)
	Remove sample from the thread per connection queue. 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 ACE_SYNCH_MUTEX	LockType

typedef ACE_Guard< LockType >	GuardType

typedef ConditionVariable< LockType >	ConditionVariableType

typedef BasicQueue< SendRequest >	QueueType

Private Member Functions
virtual void	execute (SendRequest &req)
	Handle the request. More...

Private Attributes
LockType	lock_
	Lock to protect the "state" (all of the data members) of this object. More...

QueueType	queue_
	The request queue. More...

ConditionVariableType	work_available_

bool	shutdown_initiated_
	Flag used to initiate a shutdown request to all worker threads. More...

bool	opened_
	Flag used to avoid multiple open() calls. More...

ACE_thread_t	thr_id_
	The id of the thread created by this task. More...

DataLink *	link_
	The datalink to send the samples or control messages. 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

Execute the requests of sending a sample or control message.

This task implements the request execute method which handles each step of sending a sample or control message.

Definition at line 57 of file ThreadPerConnectionSendTask.h.

Member Typedef Documentation

◆ ConditionVariableType

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

private

Definition at line 87 of file ThreadPerConnectionSendTask.h.

◆ GuardType

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

private

Definition at line 86 of file ThreadPerConnectionSendTask.h.

◆ LockType

typedef ACE_SYNCH_MUTEX OpenDDS::DCPS::ThreadPerConnectionSendTask::LockType

private

Definition at line 85 of file ThreadPerConnectionSendTask.h.

◆ QueueType

typedef BasicQueue<SendRequest> OpenDDS::DCPS::ThreadPerConnectionSendTask::QueueType

private

Definition at line 89 of file ThreadPerConnectionSendTask.h.

Constructor & Destructor Documentation

◆ ThreadPerConnectionSendTask()

OpenDDS::DCPS::ThreadPerConnectionSendTask::ThreadPerConnectionSendTask ( DataLink * link )

Definition at line 26 of file ThreadPerConnectionSendTask.cpp.

References DBG_ENTRY_LVL, and NULL_thread.

   : lock_()
   , work_available_(lock_)
   , shutdown_initiated_(false)
   , opened_(false)
   , thr_id_(ACE_OS::NULL_thread)
   , link_(link)
 {
   DBG_ENTRY_LVL("ThreadPerConnectionSendTask", "ThreadPerConnectionSendTask", 6);
 }

◆ ~ThreadPerConnectionSendTask()

OpenDDS::DCPS::ThreadPerConnectionSendTask::~ThreadPerConnectionSendTask ( )

virtual

Definition at line 37 of file ThreadPerConnectionSendTask.cpp.

References DBG_ENTRY_LVL.

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

Member Function Documentation

◆ add_request()

int OpenDDS::DCPS::ThreadPerConnectionSendTask::add_request	(	SendStrategyOpType	op,
		TransportQueueElement *	element = `0`
	)

Put the request to the request queue. Returns 0 if successful, -1 otherwise (it has been "rejected" or this task is shutdown).

Definition at line 42 of file ThreadPerConnectionSendTask.cpp.

References ACE_ERROR, ACE_TEXT(), DBG_ENTRY, ACE_Auto_Basic_Ptr< X >::get(), LM_ERROR, lock_, OpenDDS::DCPS::ConditionVariable< Mutex >::notify_one(), OpenDDS::DCPS::BasicQueue< T >::put(), queue_, ACE_Auto_Basic_Ptr< X >::release(), OpenDDS::DCPS::SEND_STOP, shutdown_initiated_, and work_available_.

 {
   DBG_ENTRY("ThreadPerConnectionSendTask", "add");
 
   ACE_Auto_Ptr<SendRequest> req(new SendRequest);
   req->op_ = op;
   req->element_ = element;
 
   int result = -1;
   { // guard scope
     GuardType guard(lock_);
 
     if (shutdown_initiated_) {
       return -1;
     }
 
     result = queue_.put(req.get());
 
     if (result == 0 && op == SEND_STOP) {
       work_available_.notify_one();
     }
   }
 
   if (result == 0) {
     req.release();
   } else {
     ACE_ERROR((LM_ERROR,
                ACE_TEXT("(%P|%t) ERROR: ThreadPerConnectionSendTask::add %p\n"),
                ACE_TEXT("put")));
   }
 
   return result;
 }

◆ close()

int OpenDDS::DCPS::ThreadPerConnectionSendTask::close ( u_long flag = 0 )

virtual

Called when the thread exits.

Reimplemented from ACE_Task_Base.

Definition at line 191 of file ThreadPerConnectionSendTask.cpp.

References DBG_ENTRY, lock_, OpenDDS::DCPS::ConditionVariable< Mutex >::notify_all(), opened_, shutdown_initiated_, TheServiceParticipant, ACE_OS::thr_equal(), thr_id_, ACE_OS::thr_self(), ACE_Task_Base::wait(), and work_available_.

 {
   DBG_ENTRY("ThreadPerConnectionSendTask","close");
 
   if (flag == 0) {
     return 0;
   }
 
   {
     GuardType guard(lock_);
 
     if (shutdown_initiated_) {
       return 0;
     }
 
     // Set the shutdown flag to true.
     shutdown_initiated_ = true;
     work_available_.notify_all();
   }
 
   if (opened_ && !ACE_OS::thr_equal(thr_id_, ACE_OS::thr_self())) {
     ThreadStatusManager::Sleeper s(TheServiceParticipant->get_thread_status_manager());
     wait();
   }
 
   return 0;
 }

◆ execute()

void OpenDDS::DCPS::ThreadPerConnectionSendTask::execute ( SendRequest & req )

privatevirtual

Handle the request.

Definition at line 234 of file ThreadPerConnectionSendTask.cpp.

References ACE_ERROR, DBG_ENTRY_LVL, OpenDDS::DCPS::SendRequest::element_, OpenDDS::DCPS::GUID_UNKNOWN, link_, LM_ERROR, OpenDDS::DCPS::SendRequest::op_, OPENDDS_END_VERSIONED_NAMESPACE_DECL, OpenDDS::DCPS::SEND, OpenDDS::DCPS::DataLink::send_i(), OpenDDS::DCPS::SEND_START, OpenDDS::DCPS::DataLink::send_start_i(), OpenDDS::DCPS::SEND_STOP, and OpenDDS::DCPS::DataLink::send_stop_i().

Referenced by svc().

 {
   DBG_ENTRY_LVL("ThreadPerConnectionSendTask", "execute", 6);
 
 
 
   switch (req.op_) {
   case SEND_START:
     link_->send_start_i();
     break;
   case SEND:
     link_->send_i(req.element_);
     break;
   case SEND_STOP:
     //DataLink::send_stop_i expects the RepoId of the message sender, however, in ThreadPerConnectionSendTask
     //the control element will be a null element with only the op_ set.  Thus pass in GUID_UNKNOWN which will
     //allow send_stop to call send_delayed_notifications without a match.  In the case of ThreadPerConnectionSendTask
     //this is allowable because only one thread will be managing the sending thus no deadlock down in send_delayed_notifications()
     link_->send_stop_i(GUID_UNKNOWN);
     break;
   default:
     ACE_ERROR((LM_ERROR, "(%P|%t) ERROR: ThreadPerConnectionSendTask::execute unknown command %d\n",
                req.op_));
     break;
   }
 }

◆ open()

int OpenDDS::DCPS::ThreadPerConnectionSendTask::open ( void * = 0 )

virtual

Activate the worker threads.

Reimplemented from ACE_Task_Base.

Definition at line 77 of file ThreadPerConnectionSendTask.cpp.

References ACE_DEBUG, ACE_ERROR_RETURN, ACE_TEXT(), ACE_Task_Base::activate(), DBG_ENTRY, OpenDDS::DCPS::DCPS_debug_level, link_, LM_DEBUG, LM_ERROR, lock_, opened_, ACE_Event_Handler::priority(), TheServiceParticipant, and OpenDDS::DCPS::DataLink::transport_priority().

 {
   DBG_ENTRY("ThreadPerConnectionSendTask", "open");
 
   GuardType guard(lock_);
 
   // We can assume that we are in the proper state to handle this open()
   // call as long as we haven't been open()'ed before.
   if (opened_) {
     ACE_ERROR_RETURN((LM_ERROR,
                       "(%P|%t) ThreadPerConnectionSendTask failed to open.  "
                       "Task has previously been open()'ed.\n"),
                      -1);
   }
 
   DirectPriorityMapper mapper(link_->transport_priority());
   int priority = mapper.thread_priority();
 
   long flags  = THR_NEW_LWP | THR_JOINABLE ;//|THR_SCOPE_PROCESS | THR_SCOPE_THREAD;
   long policy = TheServiceParticipant->scheduler();
 
   if (policy >= 0) {
     flags |= policy;
   } else {
     flags |= THR_INHERIT_SCHED;
   }
 
   if (DCPS_debug_level > 0) {
     ACE_DEBUG((LM_DEBUG,
                ACE_TEXT("(%P|%t) ThreadPerConnectionSendTask::open(): ")
                ACE_TEXT("activating thread with flags 0x%08.8x ")
                ACE_TEXT("and priority %d.\n"),
                flags,
                priority));
   }
 
   // Activate this task object with one worker thread.
   if (activate(flags, 1, 0, priority) != 0) {
     // Assumes that when activate returns non-zero return code that
     // no threads were activated.
     ACE_ERROR_RETURN((LM_ERROR,
                       "(%P|%t) ThreadPerConnectionSendTask failed to activate "
                       "the worker threads.\n"),
                      -1);
   }
 
   // Now we have past the point where we can say we've been open()'ed before.
   opened_ = true;
 
   return 0;
 }

◆ remove_sample()

RemoveResult OpenDDS::DCPS::ThreadPerConnectionSendTask::remove_sample ( const DataSampleElement * element )

Remove sample from the thread per connection queue.

Definition at line 220 of file ThreadPerConnectionSendTask.cpp.

References OpenDDS::DCPS::BasicQueue< T >::accept_visitor(), ACE_Message_Block::cont(), DBG_ENTRY, OpenDDS::DCPS::DataSampleElement::get_sample(), lock_, queue_, and OpenDDS::DCPS::ThreadPerConRemoveVisitor::status().

 {
   DBG_ENTRY("ThreadPerConnectionSendTask", "remove_sample");
 
   ACE_Message_Block* payload = element->get_sample()->cont();
   ThreadPerConRemoveVisitor visitor(payload);
 
   GuardType guard(lock_);
 
   queue_.accept_visitor(visitor);
 
   return visitor.status();
 }

◆ svc()

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

virtual

The "mainline" executed by the worker thread.

Reimplemented from ACE_Task_Base.

Definition at line 129 of file ThreadPerConnectionSendTask.cpp.

References DBG_ENTRY_LVL, execute(), OpenDDS::DCPS::BasicQueue< T >::get(), lock_, OpenDDS::DCPS::OPENDDS_VECTOR(), queue_, OpenDDS::DCPS::SEND_STOP, shutdown_initiated_, SIG_SETMASK, ACE_OS::sigfillset(), OpenDDS::DCPS::BasicQueue< T >::size(), TheServiceParticipant, thr_id_, ACE_OS::thr_self(), ACE_OS::thr_sigsetmask(), OpenDDS::DCPS::ConditionVariable< Mutex >::wait(), and work_available_.

 {
   ThreadStatusManager& thread_status_manager = TheServiceParticipant->get_thread_status_manager();
   ThreadStatusManager::Start s(thread_status_manager, "ThreadPerConnectionSendTask");
 
   DBG_ENTRY_LVL("ThreadPerConnectionSendTask", "svc", 6);
 
   thr_id_ = ACE_OS::thr_self();
 
   // Ignore all signals to avoid
   //     ERROR: <something descriptive> Interrupted system call
   // The main thread will handle signals.
   sigset_t set;
   ACE_OS::sigfillset(&set);
   ACE_OS::thr_sigsetmask(SIG_SETMASK, &set, NULL);
 
   SendRequest* req;
   OPENDDS_VECTOR(SendRequest*) reqs;
 
   ACE_Reverse_Lock<LockType> rev_lock(lock_);
   GuardType guard(lock_);
 
   // Start the "GetWork-And-PerformWork" loop for the current worker thread.
   while (!shutdown_initiated_) {
 
     if (queue_.size() == 0) {
       work_available_.wait(thread_status_manager);
     }
 
     if (shutdown_initiated_) {
       break;
     }
 
     while (queue_.size() != 0 && (reqs.empty() || reqs.back()->op_ != SEND_STOP)) {
       req = queue_.get();
 
       if (req == 0) {
         //I'm not sure why this thread got more signals than actual signals
         //when using thread_per_connection and the user application thread
         //send requests without interval. We just need ignore the dequeue
         //failure.
         //ACE_ERROR ((LM_ERROR, "(%P|%t) ERROR: ThreadPerConnectionSendTask::svc  %p\n",
         //  ACE_TEXT("dequeue_head")));
         continue;
       }
       reqs.push_back(req);
     }
 
     ACE_Guard<ACE_Reverse_Lock<LockType> > rev_guard(rev_lock);
 
     if (!reqs.empty() && reqs.back()->op_ == SEND_STOP) {
       for (size_t i = 0; i < reqs.size(); ++i) {
         execute(*reqs[i]);
         delete reqs[i];
       }
       reqs.clear();
     }
   }
 
   return 0;
 }

Member Data Documentation

◆ link_

DataLink* OpenDDS::DCPS::ThreadPerConnectionSendTask::link_

private

The datalink to send the samples or control messages.

Definition at line 113 of file ThreadPerConnectionSendTask.h.

Referenced by execute(), and open().

◆ lock_

LockType OpenDDS::DCPS::ThreadPerConnectionSendTask::lock_

private

Lock to protect the "state" (all of the data members) of this object.

Definition at line 92 of file ThreadPerConnectionSendTask.h.

Referenced by add_request(), close(), open(), remove_sample(), and svc().

◆ opened_

bool OpenDDS::DCPS::ThreadPerConnectionSendTask::opened_

private

Flag used to avoid multiple open() calls.

Definition at line 107 of file ThreadPerConnectionSendTask.h.

Referenced by close(), and open().

◆ queue_

QueueType OpenDDS::DCPS::ThreadPerConnectionSendTask::queue_

private

The request queue.

Definition at line 95 of file ThreadPerConnectionSendTask.h.

Referenced by add_request(), remove_sample(), and svc().

◆ shutdown_initiated_

bool OpenDDS::DCPS::ThreadPerConnectionSendTask::shutdown_initiated_

private

Flag used to initiate a shutdown request to all worker threads.

Definition at line 104 of file ThreadPerConnectionSendTask.h.

Referenced by add_request(), close(), and svc().

◆ thr_id_

ACE_thread_t OpenDDS::DCPS::ThreadPerConnectionSendTask::thr_id_

private

The id of the thread created by this task.

Definition at line 110 of file ThreadPerConnectionSendTask.h.

Referenced by close(), and svc().

◆ work_available_

ConditionVariableType OpenDDS::DCPS::ThreadPerConnectionSendTask::work_available_

private

Condition used to signal the worker threads that they may be able to find a request in the queue_ that needs to be executed. This condition will be signal()'ed each time a request is added to the queue_, and also when this task is shutdown.

Definition at line 101 of file ThreadPerConnectionSendTask.h.

Referenced by add_request(), close(), and svc().

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConditionVariableType

◆ GuardType

◆ LockType

◆ QueueType

Constructor & Destructor Documentation

◆ ThreadPerConnectionSendTask()

◆ ~ThreadPerConnectionSendTask()

Member Function Documentation

◆ add_request()

◆ close()

◆ execute()

◆ open()

◆ remove_sample()

◆ svc()

Member Data Documentation

◆ link_

◆ lock_

◆ opened_

◆ queue_

◆ shutdown_initiated_

◆ thr_id_

◆ work_available_