#include <ThreadPerConRemoveVisitor.h>

Inheritance diagram for OpenDDS::DCPS::ThreadPerConRemoveVisitor:

Collaboration diagram for OpenDDS::DCPS::ThreadPerConRemoveVisitor:

[legend]

Public Member Functions
	ThreadPerConRemoveVisitor (const ACE_Message_Block *sample)

virtual	~ThreadPerConRemoveVisitor ()

virtual int	visit_element_remove (SendRequest *element, int &remove)

RemoveResult	status () const
	True if the visitor found and removed the sample. More...

Public Member Functions inherited from OpenDDS::DCPS::BasicQueueVisitor< SendRequest >
	BasicQueueVisitor ()

virtual	~BasicQueueVisitor ()

virtual int	visit_element (SendRequest *element)

virtual int	visit_element_ref (SendRequest *&element)

Private Attributes
const ACE_Message_Block *	sample_
	The sample that needs to be removed. More...

RemoveResult	status_
	Holds the status of our visit. More...

Detailed Description

Definition at line 22 of file ThreadPerConRemoveVisitor.h.

Constructor & Destructor Documentation

◆ ThreadPerConRemoveVisitor()

ACE_INLINE OpenDDS::DCPS::ThreadPerConRemoveVisitor::ThreadPerConRemoveVisitor ( const ACE_Message_Block * sample )

explicit

In order to construct a QueueRemoveVisitor, it must be provided with the DataSampleElement* (used as an identifier) that should be removed from the BasicQueue<T> (the one this visitor will visit when it is passed-in to a BasicQueue<T>::accept_remove_visitor() invocation).

Definition at line 11 of file ThreadPerConRemoveVisitor.inl.

References ACE_INLINE, and DBG_ENTRY.

   : sample_(sample)
   , status_(REMOVE_NOT_FOUND)
 {
   DBG_ENTRY("ThreadPerConRemoveVisitor", "ThreadPerConRemoveVisitor");
 }

◆ ~ThreadPerConRemoveVisitor()

OpenDDS::DCPS::ThreadPerConRemoveVisitor::~ThreadPerConRemoveVisitor ( )

virtual

Definition at line 22 of file ThreadPerConRemoveVisitor.cpp.

References DBG_ENTRY.

 {
   DBG_ENTRY("ThreadPerConRemoveVisitor", "~ThreadPerConRemoveVisitor");
 }

Member Function Documentation

◆ status()

ACE_INLINE OpenDDS::DCPS::RemoveResult OpenDDS::DCPS::ThreadPerConRemoveVisitor::status ( void ) const

True if the visitor found and removed the sample.

Definition at line 20 of file ThreadPerConRemoveVisitor.inl.

References DBG_ENTRY, and status_.

Referenced by OpenDDS::DCPS::ThreadPerConnectionSendTask::remove_sample().

 {
   DBG_ENTRY("ThreadPerConRemoveVisitor", "status");
   return this->status_;
 }

◆ visit_element_remove()

int OpenDDS::DCPS::ThreadPerConRemoveVisitor::visit_element_remove	(	SendRequest *	element,
		int &	remove
	)

virtual

The BasicQueue<T>::accept_remove_visitor() method will call this visit_element_remove() method for each element in the queue.

Reimplemented from OpenDDS::DCPS::BasicQueueVisitor< SendRequest >.

Definition at line 28 of file ThreadPerConRemoveVisitor.cpp.

References OpenDDS::DCPS::TransportQueueElement::data_dropped(), DBG_ENTRY, OpenDDS::DCPS::SendRequest::element_, OpenDDS::DCPS::SendRequest::op_, OPENDDS_END_VERSIONED_NAMESPACE_DECL, ACE_Message_Block::rd_ptr(), OpenDDS::DCPS::REMOVE_FOUND, OpenDDS::DCPS::REMOVE_RELEASED, sample_, OpenDDS::DCPS::SEND, and status_.

 {
   DBG_ENTRY("ThreadPerConRemoveVisitor", "visit_element_remove");
 
   TransportQueueElement::MatchOnDataPayload modp(sample_->rd_ptr());
   if ((req->op_ == SEND) && modp.matches(*req->element_)) {
     // We are visiting the element that we want to remove, since the
     // element "matches" our sample_.
 
     // In order to have the BasicQueue<T> remove the element that we
     // are currently visiting, set the remove flag to true (1).  The
     // BasicQueue<T> will perform the actual removal once we return
     // from this method.
     remove = 1;
 
     // Inform the element that we've made a decision - and it is
     // data_dropped()
     const bool released = req->element_->data_dropped();
 
     // Adjust our status_ to indicate that we actually found (and removed)
     // the sample.
     status_ = released ? REMOVE_RELEASED : REMOVE_FOUND;
 
     // Stop visitation since we've handled the element that matched
     // our sample_.
     return 0;
   }
 
   // Continue visitation.
   return 1;
 }