OpenDDS::DCPS::BasicQueueVisitor< T > Class Template Reference

#include <BasicQueueVisitor_T.h>

Public Member Functions
	BasicQueueVisitor ()
virtual	~BasicQueueVisitor ()
virtual int	visit_element (T *element)
virtual int	visit_element_remove (T *element, int &remove)
virtual int	visit_element_ref (T *&element)

Detailed Description

template<typename T>
class OpenDDS::DCPS::BasicQueueVisitor< T >

Definition at line 19 of file BasicQueueVisitor_T.h.

Constructor & Destructor Documentation

BasicQueueVisitor()

template<typename T>

OpenDDS::DCPS::BasicQueueVisitor< T >::BasicQueueVisitor ( )

inline

Definition at line 22 of file BasicQueueVisitor_T.h.

                      {
  }

~BasicQueueVisitor()

template<typename T>

virtual OpenDDS::DCPS::BasicQueueVisitor< T >::~BasicQueueVisitor ( )

inlinevirtual

Definition at line 25 of file BasicQueueVisitor_T.h.

                               {
  }

Member Function Documentation

visit_element()

template<typename T>

virtual int OpenDDS::DCPS::BasicQueueVisitor< T >::visit_element ( T *  element )

inlinevirtual

This is the visit_element() method that will be called when the visitation method used is BasicQueue<T>::accept_visitor().

Return 0 if visiting should stop, return 1 to continue visiting.

Reimplemented in OpenDDS::DCPS::CopyChainVisitor, and OpenDDS::DCPS::BuildChainVisitor.

Definition at line 32 of file BasicQueueVisitor_T.h.

Referenced by OpenDDS::DCPS::BasicQueue< TransportQueueElement >::accept_visitor().

                                        {
    ACE_UNUSED_ARG(element);
    return 0;
  }

visit_element_ref()

template<typename T>

virtual int OpenDDS::DCPS::BasicQueueVisitor< T >::visit_element_ref ( T *&  element )

inlinevirtual

This is the visit_element_ref() method that will be called when the visitation method used is BasicQueue<T>::accept_replace_visitor().

Return 0 if visiting should stop, return 1 to continue visiting.

Reimplemented in OpenDDS::DCPS::PacketRemoveVisitor.

Definition at line 59 of file BasicQueueVisitor_T.h.

Referenced by OpenDDS::DCPS::BasicQueue< TransportQueueElement >::accept_replace_visitor().

                                             {
    ACE_UNUSED_ARG(element);
    return 0;
  }

visit_element_remove()

template<typename T>

virtual int OpenDDS::DCPS::BasicQueueVisitor< T >::visit_element_remove ( T *  element, int &  remove  )

inlinevirtual

This is the visit_element_remove() method that will be called when the visitation method used is BasicQueue<T>::accept_remove_visitor().

Return 0 if visiting should stop, return 1 to continue visiting. The remove is an "inout" argument that is always passed-in with a false (0) value, indicating that the link should not be removed from the queue as a result of this visit. If the visit_remove() implementation decides that the link should be removed, then it must set the remove argument to true (1). By default, this method is implemented to just return 0 to stop the "remove visitation" immediately. It doesn't modify the value of the remove argument.

Reimplemented in OpenDDS::DCPS::ThreadPerConRemoveVisitor, OpenDDS::DCPS::QueueRemoveVisitor, and OpenDDS::DCPS::RemoveAllVisitor.

Definition at line 49 of file BasicQueueVisitor_T.h.

Referenced by OpenDDS::DCPS::BasicQueue< TransportQueueElement >::accept_remove_visitor().

                                                            {
    ACE_UNUSED_ARG(element);
    ACE_UNUSED_ARG(remove);
    return 0;
  }

---

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

• BasicQueueVisitor_T.h