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

Queue class that provides a means to reset the underlying ACE_Allocator. More...

#include <DurabilityQueue.h>

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

[legend]

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

[legend]

List of all members.

Public Member Functions
	DurabilityQueue (ACE_Allocator *allocator)
	DurabilityQueue (DurabilityQueue< T > const &rhs)
	~DurabilityQueue ()
void	operator= (DurabilityQueue< T > const &rhs)
void	set_allocator (ACE_Allocator *allocator)
	Reset allocator.
void	swap (DurabilityQueue< T > &rhs)
typedef	OPENDDS_VECTOR (OPENDDS_STRING) fs_path_t
Public Attributes
fs_path_t	fs_path_

---

Detailed Description

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

Queue class that provides a means to reset the underlying ACE_Allocator.

This class only exists to provide a means to reset the allocator used by the ACE_Unbounded_Queue base class. It has a specific use case, namely to correctly support instances created by a persistent allocator. The allocator address may change between process runs, meaning the allocator address stored in the persistent ACE_Unbounded_Queue instance will be invalid. Use the set_allocator() method to reset the allocator address before performing any operations that will require use of the allocator (e.g. enqueuing new items).

Definition at line 38 of file DurabilityQueue.h.

---

Constructor & Destructor Documentation

template<typename T>

OpenDDS::DCPS::DurabilityQueue< T >::DurabilityQueue

(

ACE_Allocator *

allocator

)

[inline]

Definition at line 41 of file DurabilityQueue.h.

    : ACE_Unbounded_Queue<T> (allocator)
  {}

template<typename T>

OpenDDS::DCPS::DurabilityQueue< T >::DurabilityQueue

(

DurabilityQueue< T > const &

rhs

)

[inline]

Definition at line 45 of file DurabilityQueue.h.

References ACE_Unbounded_Queue< T >::delete_nodes(), ACE_Unbounded_Queue< T >::enqueue_tail(), ACE_Unbounded_Queue< T >::head_, and ACE_Node< T, C >::next_.

    : ACE_Unbounded_Queue<T> (rhs.allocator_)
    , fs_path_(rhs.fs_path_)
  {
    // Copied from ACE_Unbounded_Queue<>::copy_nodes().
    for (ACE_Node<T> *curr = rhs.head_->next_;
         curr != rhs.head_;
         curr = curr->next_)
      if (this->enqueue_tail(curr->item_) == -1)
        this->delete_nodes();
  }

Here is the call graph for this function:

template<typename T>

OpenDDS::DCPS::DurabilityQueue< T >::~DurabilityQueue

(

)

[inline]

Definition at line 57 of file DurabilityQueue.h.

{}

---

Member Function Documentation

template<typename T>

typedef OpenDDS::DCPS::DurabilityQueue< T >::OPENDDS_VECTOR

(

OPENDDS_STRING

)

template<typename T>

void OpenDDS::DCPS::DurabilityQueue< T >::operator=

(

DurabilityQueue< T > const &

rhs

)

[inline]

Reimplemented from ACE_Unbounded_Queue< T >.

Definition at line 59 of file DurabilityQueue.h.

References OpenDDS::DCPS::DurabilityQueue< T >::swap().

                                                  {
    DurabilityQueue tmp(rhs);
    this->swap(rhs);
  }

Here is the call graph for this function:

template<typename T>

void OpenDDS::DCPS::DurabilityQueue< T >::set_allocator

(

ACE_Allocator *

allocator

)

[inline]

Reset allocator.

Definition at line 65 of file DurabilityQueue.h.

References ACE_Unbounded_Queue< T >::allocator_, and ACE_Allocator::instance().

                                                {
    if (allocator == 0)
      allocator = ACE_Allocator::instance();

    this->allocator_ = allocator;
  }

Here is the call graph for this function:

template<typename T>

void OpenDDS::DCPS::DurabilityQueue< T >::swap

(

DurabilityQueue< T > &

rhs

)

[inline]

Definition at line 72 of file DurabilityQueue.h.

References ACE_Unbounded_Queue< T >::allocator_, ACE_Unbounded_Queue< T >::cur_size_, OpenDDS::DCPS::DurabilityQueue< T >::fs_path_, and ACE_Unbounded_Queue< T >::head_.

Referenced by OpenDDS::DCPS::DurabilityQueue< T >::operator=().

                                      {
    std::swap(this->head_, rhs.head_);
    std::swap(this->cur_size_, rhs.current_size_);
    std::swap(this->allocator_, rhs.allocator_);
    std::swap(this->fs_path_, rhs.fs_path_);
  }

Here is the caller graph for this function:

---

Member Data Documentation

template<typename T>

fs_path_t OpenDDS::DCPS::DurabilityQueue< T >::fs_path_

Definition at line 81 of file DurabilityQueue.h.

Referenced by OpenDDS::DCPS::DurabilityQueue< T >::swap().

---

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

• DurabilityQueue.h