OpenDDS::DCPS::ThreadPerConRemoveVisitor Class Reference

#include <ThreadPerConRemoveVisitor.h>

Inheritance diagram for OpenDDS::DCPS::ThreadPerConRemoveVisitor:

[legend]Collaboration diagram for OpenDDS::DCPS::ThreadPerConRemoveVisitor:

[legend]List of all members.

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.
Private Attributes
const ACE_Message_Block *	sample_
	The sample that needs to be removed.
RemoveResult	status_
	Holds the status of our visit.

---

Detailed Description

Definition at line 20 of file ThreadPerConRemoveVisitor.h.

---

Constructor & Destructor Documentation

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

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

OpenDDS::DCPS::ThreadPerConRemoveVisitor::~ThreadPerConRemoveVisitor

(

)

[virtual]

Definition at line 20 of file ThreadPerConRemoveVisitor.cpp.

References DBG_ENTRY.

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

---

Member Function Documentation

ACE_INLINE OpenDDS::DCPS::RemoveResult OpenDDS::DCPS::ThreadPerConRemoveVisitor::status

(

)

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_;
}

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.

Definition at line 26 of file ThreadPerConRemoveVisitor.cpp.

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

{
  DBG_ENTRY("ThreadPerConRemoveVisitor", "visit_element_remove");

  TransportQueueElement::MatchOnDataPayload modp(this->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.
    this->status_ = released ? REMOVE_RELEASED : REMOVE_FOUND;

    // Stop visitation since we've handled the element that matched
    // our sample_.
    return 0;
  }

  // Continue visitation.
  return 1;
}

---

Member Data Documentation

const ACE_Message_Block* OpenDDS::DCPS::ThreadPerConRemoveVisitor::sample_ [private]

The sample that needs to be removed.

Definition at line 44 of file ThreadPerConRemoveVisitor.h.

RemoveResult OpenDDS::DCPS::ThreadPerConRemoveVisitor::status_ [private]

Holds the status of our visit.

Definition at line 47 of file ThreadPerConRemoveVisitor.h.

Referenced by status(), and visit_element_remove().

---

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

• ThreadPerConRemoveVisitor.h
• ThreadPerConRemoveVisitor.cpp
• ThreadPerConRemoveVisitor.inl

---