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

#include <DurabilityQueue.h>

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

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

[legend]

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. More...

void	swap (DurabilityQueue< T > &rhs)

typedef	OPENDDS_VECTOR (OPENDDS_STRING) fs_path_t

Public Member Functions inherited from ACE_Unbounded_Queue< T >
	ACE_Unbounded_Queue (ACE_Allocator *alloc=0)

	ACE_Unbounded_Queue (const ACE_Unbounded_Queue< T > &)

void	operator= (const ACE_Unbounded_Queue< T > &)

	~ACE_Unbounded_Queue (void)

bool	is_empty (void) const

bool	is_full (void) const

int	enqueue_tail (const T &new_item)

int	enqueue_head (const T &new_item)

int	dequeue_head (T &item)

void	reset (void)

int	get (T *&item, size_t slot=0) const

int	set (const T &item, size_t slot)

size_t	size (void) const

void	dump (void) const

ACE_Unbounded_Queue_Iterator< T >	begin (void)

ACE_Unbounded_Queue_Iterator< T >	end (void)

Public Attributes
fs_path_t	fs_path_

Public Attributes inherited from ACE_Unbounded_Queue< T >
	ACE_ALLOC_HOOK_DECLARE

Additional Inherited Members
Public Types inherited from ACE_Unbounded_Queue< T >
typedef ACE_Unbounded_Queue_Iterator< T >	ITERATOR

typedef ACE_Unbounded_Queue_Const_Iterator< T >	CONST_ITERATOR

Protected Member Functions inherited from ACE_Unbounded_Queue< T >
void	delete_nodes (void)

void	copy_nodes (const ACE_Unbounded_Queue< T > &)

Protected Attributes inherited from ACE_Unbounded_Queue< T >
ACE_Node< T > *	head_

size_t	cur_size_

ACE_Allocator *	allocator_

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

◆ DurabilityQueue() [1/2]

template<typename T>

OpenDDS::DCPS::DurabilityQueue< T >::DurabilityQueue ( ACE_Allocator * allocator )

inline

Definition at line 41 of file DurabilityQueue.h.

42 : ACE_Unbounded_Queue<T> (allocator)

43 {}

ACE_Unbounded_Queue

◆ DurabilityQueue() [2/2]

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 >::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();
   }

◆ ~DurabilityQueue()

template<typename T>

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

inline

Definition at line 57 of file DurabilityQueue.h.

57 {}

Member Function Documentation

◆ OPENDDS_VECTOR()

template<typename T>

typedef OpenDDS::DCPS::DurabilityQueue< T >::OPENDDS_VECTOR ( OPENDDS_STRING )

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

◆ operator=()

template<typename T>

void OpenDDS::DCPS::DurabilityQueue< T >::operator= ( DurabilityQueue< T > const & rhs )

inline

Definition at line 59 of file DurabilityQueue.h.

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

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

◆ set_allocator()

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;
   }

◆ swap()

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_, ACE_Unbounded_Queue< T >::head_, OPENDDS_STRING, OpenDDS::DCPS::DurabilityQueue< T >::OPENDDS_VECTOR(), and OpenDDS::DCPS::swap().

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_);
   }