OpenDDS::DCPS::QueueRemoveVisitor Class Reference

#include <QueueRemoveVisitor.h>

Inheritance diagram for OpenDDS::DCPS::QueueRemoveVisitor:

Collaboration diagram for OpenDDS::DCPS::QueueRemoveVisitor:

Public Member Functions
	QueueRemoveVisitor (const TransportQueueElement::MatchCriteria &mc, bool remove_all=false)
virtual	~QueueRemoveVisitor ()
virtual int	visit_element_remove (TransportQueueElement *element, int &remove)
RemoveResult	status () const
int	removed_bytes () const
Public Member Functions inherited from OpenDDS::DCPS::BasicQueueVisitor< TransportQueueElement >
	BasicQueueVisitor ()
virtual	~BasicQueueVisitor ()
virtual int	visit_element (TransportQueueElement *element)
virtual int	visit_element_ref (TransportQueueElement *&element)

Private Attributes
const TransportQueueElement::MatchCriteria &	mc_
	Criteria object describing the Queue Element that needs to be removed. More...
RemoveResult	status_
	Holds the status of our visit. More...
size_t	removed_bytes_
bool	remove_all_

Detailed Description

Definition at line 26 of file QueueRemoveVisitor.h.

Constructor & Destructor Documentation

QueueRemoveVisitor()

ACE_INLINE OpenDDS::DCPS::QueueRemoveVisitor::QueueRemoveVisitor ( const TransportQueueElement::MatchCriteria &  mc, bool  remove_all = false  )

explicit

Definition at line 16 of file QueueRemoveVisitor.inl.

References ACE_INLINE, and DBG_ENTRY_LVL.

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

~QueueRemoveVisitor()

OpenDDS::DCPS::QueueRemoveVisitor::~QueueRemoveVisitor ( )

virtual

Definition at line 21 of file QueueRemoveVisitor.cpp.

References DBG_ENTRY_LVL.

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

Member Function Documentation

removed_bytes()

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

(

)

const

Definition at line 35 of file QueueRemoveVisitor.inl.

References DBG_ENTRY_LVL, OPENDDS_END_VERSIONED_NAMESPACE_DECL, 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_);
}

status()

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

(

void

)

const

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

Definition at line 28 of file QueueRemoveVisitor.inl.

References ACE_INLINE, DBG_ENTRY_LVL, and status_.

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

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

visit_element_remove()

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.

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

Definition at line 27 of file QueueRemoveVisitor.cpp.

References OpenDDS::DCPS::TransportQueueElement::data_dropped(), DBG_ENTRY_LVL, OpenDDS::DCPS::TransportQueueElement::MatchCriteria::matches(), mc_, OpenDDS::DCPS::TransportQueueElement::msg(), OPENDDS_END_VERSIONED_NAMESPACE_DECL, remove_all_, OpenDDS::DCPS::REMOVE_FOUND, OpenDDS::DCPS::REMOVE_RELEASED, removed_bytes_, status_, ACE_Message_Block::total_length(), and OpenDDS::DCPS::TransportQueueElement::MatchCriteria::unique().

{
  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 ((!remove_all_ && 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

mc_

const TransportQueueElement::MatchCriteria& OpenDDS::DCPS::QueueRemoveVisitor::mc_

private

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

Definition at line 48 of file QueueRemoveVisitor.h.

Referenced by visit_element_remove().

remove_all_

bool OpenDDS::DCPS::QueueRemoveVisitor::remove_all_

private

Definition at line 55 of file QueueRemoveVisitor.h.

Referenced by visit_element_remove().

removed_bytes_

size_t OpenDDS::DCPS::QueueRemoveVisitor::removed_bytes_

private

Definition at line 53 of file QueueRemoveVisitor.h.

Referenced by removed_bytes(), and visit_element_remove().

status_

RemoveResult OpenDDS::DCPS::QueueRemoveVisitor::status_

private

Holds the status of our visit.

Definition at line 51 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