#include <RemoveAllVisitor.h>

Inheritance diagram for OpenDDS::DCPS::RemoveAllVisitor:

Collaboration diagram for OpenDDS::DCPS::RemoveAllVisitor:

Public Member Functions
	RemoveAllVisitor ()

virtual	~RemoveAllVisitor ()

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

int	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
int	status_
	Holds the status of our visit. More...

size_t	removed_bytes_

Detailed Description

Definition at line 21 of file RemoveAllVisitor.h.

Constructor & Destructor Documentation

◆ RemoveAllVisitor()

ACE_INLINE OpenDDS::DCPS::RemoveAllVisitor::RemoveAllVisitor ( )

Definition at line 11 of file RemoveAllVisitor.inl.

References ACE_INLINE, and DBG_ENTRY_LVL.

   : status_(0),
     removed_bytes_(0)
 {
   DBG_ENTRY_LVL("RemoveAllVisitor", "RemoveAllVisitor", 6);
 }

◆ ~RemoveAllVisitor()

OpenDDS::DCPS::RemoveAllVisitor::~RemoveAllVisitor ( )

virtual

Definition at line 16 of file RemoveAllVisitor.cpp.

References DBG_ENTRY_LVL.

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

Member Function Documentation

◆ removed_bytes()

ACE_INLINE int OpenDDS::DCPS::RemoveAllVisitor::removed_bytes ( ) const

Definition at line 26 of file RemoveAllVisitor.inl.

References DBG_ENTRY_LVL, and removed_bytes_.

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

◆ status()

ACE_INLINE int OpenDDS::DCPS::RemoveAllVisitor::status ( void ) const

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

Definition at line 19 of file RemoveAllVisitor.inl.

References ACE_INLINE, DBG_ENTRY_LVL, and status_.

 {
   DBG_ENTRY_LVL("RemoveAllVisitor", "status", 6);
   return status_;
 }

◆ visit_element_remove()

int OpenDDS::DCPS::RemoveAllVisitor::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 22 of file RemoveAllVisitor.cpp.

References OpenDDS::DCPS::TransportQueueElement::data_dropped(), DBG_ENTRY_LVL, OpenDDS::DCPS::TransportQueueElement::msg(), removed_bytes_, status_, and ACE_Message_Block::total_length().

 {
   DBG_ENTRY_LVL("RemoveAllVisitor", "visit_element_remove", 6);
 
   // Always remove the element passed in. Always 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.
   if (element->msg()) {
     removed_bytes_ += element->msg()->total_length();
   }
 
   // Inform the element that we've made a decision - and it is
   // data_dropped()
   // This visitor is used in TransportSendStrategy::clear and
   // TransportSendBuffer::release. In formal case, the sample
   // is dropped by transport. In the later case, the
   // dropped_by_transport is not used as the sample is cloned
   // and no callback is made to writer.
   element->data_dropped(true);
 
   // Adjust our status_ to indicate that we actually found (and removed)
   // the sample.
   status_ = 1;
 
   // Continue visitation.
   return 1;
 }

Member Data Documentation

◆ removed_bytes_

size_t OpenDDS::DCPS::RemoveAllVisitor::removed_bytes_

private

Definition at line 44 of file RemoveAllVisitor.h.

Referenced by removed_bytes(), and visit_element_remove().

◆ status_

int OpenDDS::DCPS::RemoveAllVisitor::status_

private

Holds the status of our visit.

Definition at line 42 of file RemoveAllVisitor.h.

Referenced by status(), and visit_element_remove().

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

Public Member Functions

Private Attributes