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

#include <BasicQueue_T.h>

Inheritance diagram for OpenDDS::DCPS::BasicQueue< T >:

Collaboration diagram for OpenDDS::DCPS::BasicQueue< T >:

Public Member Functions
int	put (T *elem)
	Put a pointer to an element (T*) on to the queue. More...
T *	peek () const
void	replace_head (T *value)
T *	get ()
size_t	size () const
	Accessor for the current number of elements in the queue. More...
void	accept_visitor (VisitorType &visitor) const
void	accept_remove_visitor (VisitorType &visitor)
void	accept_replace_visitor (VisitorType &visitor)
void	swap (BasicQueue &other)

Private Types
typedef BasicQueueVisitor< T >	VisitorType
typedef QueueImpl::iterator	iterator
typedef QueueImpl::const_iterator	const_iterator

Private Member Functions
typedef	OPENDDS_DEQUE (T *) QueueImpl

Private Attributes
QueueImpl	elements_

Detailed Description

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

Definition at line 26 of file BasicQueue_T.h.

Member Typedef Documentation

const_iterator

template<typename T>

typedef QueueImpl::const_iterator OpenDDS::DCPS::BasicQueue< T >::const_iterator

private

Definition at line 32 of file BasicQueue_T.h.

iterator

template<typename T>

typedef QueueImpl::iterator OpenDDS::DCPS::BasicQueue< T >::iterator

private

Definition at line 31 of file BasicQueue_T.h.

VisitorType

template<typename T>

typedef BasicQueueVisitor<T> OpenDDS::DCPS::BasicQueue< T >::VisitorType

private

Definition at line 29 of file BasicQueue_T.h.

Member Function Documentation

accept_remove_visitor()

template<typename T>

void OpenDDS::DCPS::BasicQueue< T >::accept_remove_visitor ( VisitorType &  visitor )

inline

Alternate way to supply a visitor to the queue - this will invoke visit_element(T* element, int& remove) on the supplied visitor object once for each element in this BasicQueue<T> object, in order.

The remove argument is a flag that should be set to true (1) in the visitor's visit_element_remove(T* element, int& remove) method if the visitor decides that the element should be removed from the queue. The remove flag is always set to false (0) prior to calling the visitor's visit_element_remove(T* element, int& remove) method.

The visitor can stop visitation early by returning 0 from its visit_element_remove(T* element, int& remove) method.

Definition at line 95 of file BasicQueue_T.h.

Referenced by OpenDDS::DCPS::TransportSendStrategy::clear(), OpenDDS::DCPS::TransportSendStrategy::do_remove_sample(), and OpenDDS::DCPS::TransportSendStrategy::stop().

                                                   {
    QueueImpl tmp;
    for (iterator itr = elements_.begin();
         itr != elements_.end(); ++itr) {

      int remove = 0;
      int keep_going = visitor.visit_element_remove(*itr, remove);
      if (!remove)
        tmp.push_back(*itr);
      if (keep_going == 0) {
        std::copy(++itr,elements_.end(), std::back_inserter(tmp));
        break;
      }
    }
    elements_.swap(tmp);
  }

accept_replace_visitor()

template<typename T>

void OpenDDS::DCPS::BasicQueue< T >::accept_replace_visitor ( VisitorType &  visitor )

inline

This kind of visitation may cause the visitor to replace the currently visited element with a new element.

Definition at line 113 of file BasicQueue_T.h.

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

                                                    {
    for (iterator itr = elements_.begin();
         itr != elements_.end(); ++itr) {
      if (visitor.visit_element_ref(*itr) == 0)
        return;
    }
  }

accept_visitor()

template<typename T>

void OpenDDS::DCPS::BasicQueue< T >::accept_visitor ( VisitorType &  visitor ) const

inline

Standard way to supply a visitor to the queue - this will invoke visit_element(T* element) on the supplied visitor object once for each element in this BasicQueue<T> object, in order. The visitor can stop visitation early by returning 0 from its visit_element(T* element) method.

Definition at line 74 of file BasicQueue_T.h.

Referenced by OpenDDS::DCPS::SingleSendBuffer::insert_buffer(), OpenDDS::DCPS::TransportSendStrategy::prepare_packet(), and OpenDDS::DCPS::ThreadPerConnectionSendTask::remove_sample().

                                                  {
    for (const_iterator itr = elements_.begin();
         itr != elements_.end(); ++itr) {
      visitor.visit_element(*itr);
    }
  }

get()

template<typename T>

T* OpenDDS::DCPS::BasicQueue< T >::get ( void  )

inline

Extract the top element from the queue. Returns 0 if there are no elements in the queue.

Definition at line 55 of file BasicQueue_T.h.

Referenced by OpenDDS::DCPS::TransportSendStrategy::adjust_packet_after_send(), OpenDDS::DCPS::TransportSendStrategy::get_packet_elems_from_queue(), and OpenDDS::DCPS::ThreadPerConnectionSendTask::svc().

           {
    T* result = 0;
    if (elements_.size()) {
      result = elements_.front();
      elements_.pop_front();
    }
    return result;
  }

OPENDDS_DEQUE()

template<typename T>

typedef OpenDDS::DCPS::BasicQueue< T >::OPENDDS_DEQUE ( T *  )

private

peek()

template<typename T>

T* OpenDDS::DCPS::BasicQueue< T >::peek ( void  ) const

inline

Peek at the element at the top of the queue. This is just like the get() operation except that the queue remains intact.

Definition at line 43 of file BasicQueue_T.h.

Referenced by OpenDDS::DCPS::TransportSendStrategy::adjust_packet_after_send(), OpenDDS::DCPS::TransportSendStrategy::current_packet_first_element(), OpenDDS::DCPS::TransportSendStrategy::get_packet_elems_from_queue(), OpenDDS::DCPS::SingleSendBuffer::insert(), and OpenDDS::DCPS::RtpsUdpDataLink::MultiSendBuffer::insert().

                  {
    return elements_.size() ? elements_[0] : 0;
  }

put()

template<typename T>

int OpenDDS::DCPS::BasicQueue< T >::put ( T *  elem )

inline

Put a pointer to an element (T*) on to the queue.

Definition at line 36 of file BasicQueue_T.h.

Referenced by OpenDDS::DCPS::ThreadPerConnectionSendTask::add_request(), OpenDDS::DCPS::TransportSendStrategy::get_packet_elems_from_queue(), OpenDDS::DCPS::TransportSendStrategy::send(), and OpenDDS::DCPS::CopyChainVisitor::visit_element().

                   {
    elements_.push_back(elem);
    return 0;
  }

replace_head()

template<typename T>

void OpenDDS::DCPS::BasicQueue< T >::replace_head ( T *  value )

inline

Definition at line 47 of file BasicQueue_T.h.

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

                              {
    if (elements_.size()) {
      elements_[0] = value;
    }
  }

size()

template<typename T>

size_t OpenDDS::DCPS::BasicQueue< T >::size ( void  ) const

inline

Accessor for the current number of elements in the queue.

Definition at line 65 of file BasicQueue_T.h.

Referenced by OpenDDS::DCPS::TransportSendStrategy::do_remove_sample(), OpenDDS::DCPS::TransportSendStrategy::get_packet_elems_from_queue(), OpenDDS::DCPS::SingleSendBuffer::insert(), OpenDDS::DCPS::TransportSendStrategy::perform_work(), OpenDDS::DCPS::TransportSendStrategy::resume_send(), OpenDDS::DCPS::TransportSendStrategy::send(), OpenDDS::DCPS::TransportSendStrategy::send_stop(), OpenDDS::DCPS::TransportSendStrategy::stop(), and OpenDDS::DCPS::ThreadPerConnectionSendTask::svc().

                      {
    return elements_.size();
  }

swap()

template<typename T>

void OpenDDS::DCPS::BasicQueue< T >::swap ( BasicQueue< T > &  other )

inline

Definition at line 122 of file BasicQueue_T.h.

Referenced by OpenDDS::DCPS::TransportSendStrategy::clear(), OpenDDS::DCPS::TransportSendStrategy::resume_send(), and OpenDDS::DCPS::TransportSendStrategy::stop().

  {
    elements_.swap(other.elements_);
  }

Member Data Documentation

elements_

template<typename T>

QueueImpl OpenDDS::DCPS::BasicQueue< T >::elements_

private

Definition at line 33 of file BasicQueue_T.h.

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

---

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

• BasicQueue_T.h