OpenDDS::DCPS::QueueRemoveVisitor Class Reference

#include <QueueRemoveVisitor.h>

Inheritance diagram for OpenDDS::DCPS::QueueRemoveVisitor:

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

[legend]List of all members.

Public Member Functions
	QueueRemoveVisitor (const TransportQueueElement::MatchCriteria &mc)
virtual	~QueueRemoveVisitor ()
virtual int	visit_element_remove (TransportQueueElement *element, int &remove)
RemoveResult	status () const
int	removed_bytes () const
Private Attributes
const TransportQueueElement::MatchCriteria &	mc_
	Criteria object describing the Queue Element that needs to be removed.
RemoveResult	status_
	Holds the status of our visit.
size_t	removed_bytes_

---

Detailed Description

Definition at line 24 of file QueueRemoveVisitor.h.

---

Constructor & Destructor Documentation

ACE_INLINE OpenDDS::DCPS::QueueRemoveVisitor::QueueRemoveVisitor

(

const TransportQueueElement::MatchCriteria &

mc

)

[explicit]

Definition at line 14 of file QueueRemoveVisitor.inl.

References DBG_ENTRY_LVL.

  : mc_(mc)
  , status_(REMOVE_NOT_FOUND)
  , removed_bytes_(0)
{
  DBG_ENTRY_LVL("QueueRemoveVisitor", "QueueRemoveVisitor", 6);
}

OpenDDS::DCPS::QueueRemoveVisitor::~QueueRemoveVisitor

(

)

[virtual]

Definition at line 19 of file QueueRemoveVisitor.cpp.

References DBG_ENTRY_LVL.

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

---

Member Function Documentation

ACE_INLINE int OpenDDS::DCPS::QueueRemoveVisitor::removed_bytes

(

)

const

Definition at line 31 of file QueueRemoveVisitor.inl.

References DBG_ENTRY_LVL, and removed_bytes_.

Referenced by OpenDDS::DCPS::TransportSendStrategy::do_remove_sample().

{
  DBG_ENTRY_LVL("QueueRemoveVisitor", "removed_bytes", 6);
  return static_cast<int>(this->removed_bytes_);
}

ACE_INLINE RemoveResult OpenDDS::DCPS::QueueRemoveVisitor::status

(

)

const

Accessor for the status. Called after this visitor object has been passed to BasicQueue<T>::accept_remove_visitor().

Definition at line 24 of file QueueRemoveVisitor.inl.

References DBG_ENTRY_LVL, and status_.

Referenced by OpenDDS::DCPS::TransportSendStrategy::do_remove_sample().

{
  DBG_ENTRY_LVL("QueueRemoveVisitor", "status", 6);
  return this->status_;
}

int OpenDDS::DCPS::QueueRemoveVisitor::visit_element_remove	(	TransportQueueElement *	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 25 of file QueueRemoveVisitor.cpp.

References OpenDDS::DCPS::TransportQueueElement::data_dropped(), DBG_ENTRY_LVL, OpenDDS::DCPS::TransportQueueElement::msg(), OpenDDS::DCPS::REMOVE_FOUND, OpenDDS::DCPS::REMOVE_RELEASED, removed_bytes_, and status_.

{
  DBG_ENTRY_LVL("QueueRemoveVisitor", "visit_element_remove", 6);

  if (this->mc_.matches(*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;

    // Add the total_length() of the element->msg() chain to our
    // removed_bytes_ (running) total.
    this->removed_bytes_ += element->msg()->total_length();

    // Inform the element that we've made a decision - and it is
    // data_dropped() by transport.
    // This visitor is used in TransportSendStrategy::do_remove_sample
    // The dropped_by_transport flag should be false(default) as the
    // data_dropped is resulted from writer's remove_sample call.
    const bool released = element->data_dropped();

    // Adjust our status_ to indicate that we actually found (and removed)
    // the sample.
    this->status_ = released ? REMOVE_RELEASED : REMOVE_FOUND;

    if (released || this->mc_.unique()) {
      // Stop visitation since we've handled the element that matched
      // our sample_.
      // N.B. This unique() test means that if we are comparing by sample, we
      //      remove just the single element matching the sample, but if
      //      we are comparing by publication Id value, we visit the
      //      entire chain and remove all samples originating from that
      //      publication Id.
      return 0;
    }
  }

  // Continue visitation.
  return 1;
}

---

Member Data Documentation

const TransportQueueElement::MatchCriteria& OpenDDS::DCPS::QueueRemoveVisitor::mc_ [private]

Criteria object describing the Queue Element that needs to be removed.

Definition at line 46 of file QueueRemoveVisitor.h.

size_t OpenDDS::DCPS::QueueRemoveVisitor::removed_bytes_ [private]

Definition at line 51 of file QueueRemoveVisitor.h.

Referenced by removed_bytes(), and visit_element_remove().

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

Holds the status of our visit.

Definition at line 49 of file QueueRemoveVisitor.h.

Referenced by status(), and visit_element_remove().

---

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

• QueueRemoveVisitor.h
• QueueRemoveVisitor.cpp
• QueueRemoveVisitor.inl

---