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 ACE_Message_Block *sample)
	QueueRemoveVisitor (RepoId pub_id)
	Used to remove all control samples with the specified pub_id.
virtual	~QueueRemoveVisitor ()
virtual int	visit_element_remove (TransportQueueElement *element, int &remove)
int	status () const
int	removed_bytes () const
Private Attributes
const ACE_Message_Block *	sample_
	The sample that needs to be removed.
RepoId	pub_id_
	The publisher_id of the control samples to be removed.
int	status_
	Holds the status of our visit.
int	removed_bytes_

---

Constructor & Destructor Documentation

ACE_INLINE OpenDDS::DCPS::QueueRemoveVisitor::QueueRemoveVisitor

(

const ACE_Message_Block *

sample

)

In order to construct a QueueRemoveVisitor, it must be provided with the DataSampleListElement* (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).

ACE_INLINE OpenDDS::DCPS::QueueRemoveVisitor::QueueRemoveVisitor

(

RepoId

pub_id

)

Used to remove all control samples with the specified pub_id.

OpenDDS::DCPS::QueueRemoveVisitor::~QueueRemoveVisitor

(

)

[virtual]

---

Member Function Documentation

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

(

)

const

ACE_INLINE int OpenDDS::DCPS::QueueRemoveVisitor::status

(

)

const

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

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.

---

Member Data Documentation

RepoId OpenDDS::DCPS::QueueRemoveVisitor::pub_id_ [private]

The publisher_id of the control samples to be removed.

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

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

The sample that needs to be removed.

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

Holds the status of our visit.

---

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

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

---