#include <ZeroCopySeq_T.h>

Collaboration diagram for TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >:

[legend]

Classes
class	PrivateMemberAccess
	Only used by the FooDataReaderImpl and tests. More...

class	ZeroCopyVector

Public Types
typedef Sample_T	value_type

Public Member Functions
	ZeroCopyDataSeq (CORBA::ULong maximum=0, CORBA::ULong init_size=DEF_MAX, ACE_Allocator *alloc=0)

	ZeroCopyDataSeq (CORBA::ULong maximum, CORBA::ULong length, Sample_T *buffer, CORBA::Boolean release=false)

	ZeroCopyDataSeq (const ZeroCopyDataSeq &frm)

ZeroCopyDataSeq &	operator= (const ZeroCopyDataSeq &frm)

void	swap (ZeroCopyDataSeq &frm)

	~ZeroCopyDataSeq ()

CORBA::ULong	maximum () const

void	length (CORBA::ULong length)

CORBA::ULong	length () const

const Sample_T &	operator[] (CORBA::ULong i) const

Sample_T &	operator[] (CORBA::ULong i)

CORBA::Boolean	release () const

void	replace (CORBA::ULong max, CORBA::ULong length, Sample_T *buffer, CORBA::Boolean release=false)

Sample_T *	get_buffer (CORBA::Boolean orphan=false)

const Sample_T *	get_buffer () const

void	increment_references ()

Static Public Member Functions
static Sample_T *	allocbuf (CORBA::ULong nelems)

static void	freebuf (Sample_T *buffer)

Private Types
typedef ZeroCopyVector	Ptr_Seq_Type

Private Member Functions
CORBA::ULong	max_slots () const

void	internal_set_length (CORBA::ULong len)

void	set_loaner (OpenDDS::DCPS::DataReaderImpl *loaner)

void	assign_ptr (CORBA::ULong ii, OpenDDS::DCPS::ReceivedDataElement *item)

OpenDDS::DCPS::ReceivedDataElement *	get_ptr (CORBA::ULong ii) const

void	assign_sample (CORBA::ULong ii, const Sample_T &sample)

bool	is_zero_copy () const

void	make_single_copy (CORBA::ULong maximum)

Private Attributes
OpenDDS::DCPS::DataReaderImpl *	loaner_
	The loaner that loaned its samples. More...

OpenDDS::DCPS::FirstTimeFastAllocator< OpenDDS::DCPS::ReceivedDataElement *, DEF_MAX >	default_allocator_
	the default allocator More...

Ptr_Seq_Type	ptrs_
	array of pointers if the sequence is supporting zero-copy reads More...

CORBA::ULong	sc_maximum_

CORBA::ULong	sc_length_

Sample_T *	sc_buffer_

CORBA::Boolean	sc_release_

Static Private Attributes
static Sample_T	default_

Friends
class	PrivateMemberAccess

Detailed Description

template<class Sample_T, size_t DEF_MAX = DCPS_ZERO_COPY_SEQ_DEFAULT_SIZE>
class TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >

Provides [] operators returning sample references but it is implemented as an "array" of pointers to the samples so they can be "loaned" to the application code.

Design Goals:

Provide enhanced performance known as "zero-copy" in the DDS spec
Conform to the C++ CORBA mapping for sequences
- When necessary, certain uncommon sequence operations (resize, get_buffer, replace) will cause copies. Performance impacts are noted in comments on the individual methods.

Definition at line 53 of file ZeroCopySeq_T.h.

Member Typedef Documentation

◆ Ptr_Seq_Type

template<class Sample_T, size_t DEF_MAX = DCPS_ZERO_COPY_SEQ_DEFAULT_SIZE>

typedef ZeroCopyVector TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::Ptr_Seq_Type

private

Definition at line 202 of file ZeroCopySeq_T.h.

◆ value_type

template<class Sample_T, size_t DEF_MAX = DCPS_ZERO_COPY_SEQ_DEFAULT_SIZE>

typedef Sample_T TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::value_type

Definition at line 56 of file ZeroCopySeq_T.h.

Constructor & Destructor Documentation

◆ ZeroCopyDataSeq() [1/3]

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ZeroCopyDataSeq	(	CORBA::ULong	maximum = `0`,
		CORBA::ULong	init_size = `DEF_MAX`,
		ACE_Allocator *	alloc = `0`
	)

explicit

Construct a sequence of sample data values that supports zero-copy reads.

Parameters

maximum	Maximum number of samples to insert into the sequence. If == 0 then use zero-copy reading. Defaults to zero hence supporting zero-copy reads/takes.
init_size	Initial size of the underlying array of pointers.
alloc	The allocator used to allocate the array of pointers to samples. If zero then use the default allocator.

This constructor also serves as the "maximum" ctor and default ctor in the CORBA spec.

Definition at line 44 of file ZeroCopySeq_T.inl.

References ACE_INLINE.

   : loaner_(0)
   , ptrs_((maximum == 0) ? init_size : 0
             , alloc ? alloc : &default_allocator_)
   , sc_maximum_(maximum)
   , sc_length_(0)
   , sc_buffer_(sc_maximum_ ? allocbuf(sc_maximum_) : 0)
   , sc_release_(sc_maximum_)
 {
 }

◆ ZeroCopyDataSeq() [2/3]

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ZeroCopyDataSeq	(	CORBA::ULong	maximum,
		CORBA::ULong	length,
		Sample_T *	buffer,
		CORBA::Boolean	release = `false`
	)

Definition at line 59 of file ZeroCopySeq_T.inl.

References ACE_INLINE.

   : loaner_(0)
   , ptrs_(0)
   , sc_maximum_(maximum)
   , sc_length_(length)
   , sc_buffer_(buffer)
   , sc_release_(release)
 {
 }

◆ ZeroCopyDataSeq() [3/3]

template<class Sample_T , size_t DEF_MAX>

TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ZeroCopyDataSeq ( const ZeroCopyDataSeq< Sample_T, DEF_MAX > & frm )

Definition at line 30 of file ZeroCopySeq_T.cpp.

References TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::is_zero_copy(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ptrs_, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_buffer_, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_length_, and ACE_Vector< T, DEFAULT_SIZE >::size().

   : loaner_(frm.loaner_)
   , ptrs_(frm.ptrs_.size(),
             (frm.ptrs_.allocator_ ==
              static_cast<const ACE_Allocator*>(&frm.default_allocator_))
             ? &default_allocator_
             : const_cast<ACE_Allocator*>(frm.ptrs_.allocator_))
     //The constructor of ptrs_ requires a non-const ptr to ACE_Alloc.
   , sc_maximum_(frm.sc_maximum_)
   , sc_length_(0) //initialized below
   , sc_buffer_(frm.sc_maximum_ ? allocbuf(frm.sc_maximum_) : 0)
   , sc_release_(frm.sc_maximum_)
 {
   if (frm.is_zero_copy()) {
     ptrs_ = frm.ptrs_;
 
     //ptrs_ doesn't manage the ref count for its elements
     for (size_t ii = 0; ii < frm.ptrs_.size(); ++ii) {
       ptrs_[ii]->inc_ref();
       ++ptrs_[ii]->zero_copy_cnt_;
     }
 
   } else {
     for (CORBA::ULong i = 0; i < frm.sc_length_; ++i) {
       sc_buffer_[i] = frm.sc_buffer_[i];
       ++sc_length_;
     }
   }
 }

◆ ~ZeroCopyDataSeq()

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::~ZeroCopyDataSeq ( )

Definition at line 113 of file ZeroCopySeq_T.inl.

References ACE_INLINE, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::freebuf(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::length(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::release(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_buffer_, and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_release_.

 {
   if (!this->release())
   {
     this->length(0);
   }
 
   if (sc_release_ && sc_buffer_) freebuf(sc_buffer_);
 }

Member Function Documentation

◆ allocbuf()

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE Sample_T * TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::allocbuf ( CORBA::ULong nelems )

static

Definition at line 237 of file ZeroCopySeq_T.inl.

References ACE_INLINE.

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::get_buffer().

 {
   return new Sample_T[nelems];
 }

◆ assign_ptr()

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE void TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::assign_ptr	(	CORBA::ULong	ii,
		OpenDDS::DCPS::ReceivedDataElement *	item
	)

private

Definition at line 275 of file ZeroCopySeq_T.inl.

References ACE_INLINE, OpenDDS::DCPS::ReceivedDataElement::inc_ref(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::is_zero_copy(), OPENDDS_ASSERT, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ptrs_, and OpenDDS::DCPS::ReceivedDataElement::zero_copy_cnt_.

 {
   OPENDDS_ASSERT(is_zero_copy());
   if (ptrs_[ii]) {
     --ptrs_[ii]->zero_copy_cnt_;
     ptrs_[ii]->dec_ref();
   }
 
   item->inc_ref();
   ++item->zero_copy_cnt_;
   ptrs_[ii] = item;
 }

◆ assign_sample()

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE void TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::assign_sample	(	CORBA::ULong	ii,
		const Sample_T &	sample
	)

private

Definition at line 300 of file ZeroCopySeq_T.inl.

References TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::is_zero_copy(), OPENDDS_ASSERT, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_buffer_, and TAO_END_VERSIONED_NAMESPACE_DECL.

 {
   OPENDDS_ASSERT(!is_zero_copy());
   sc_buffer_[ii] = sample;
 }

◆ freebuf()

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE void TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::freebuf ( Sample_T * buffer )

static

Definition at line 245 of file ZeroCopySeq_T.inl.

References ACE_INLINE.

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::~ZeroCopyDataSeq().

 {
   delete[] buffer;
 }

◆ get_buffer() [1/2]

template<class Sample_T , size_t DEF_MAX>

Sample_T * TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::get_buffer ( CORBA::Boolean orphan = false )

Definition at line 127 of file ZeroCopySeq_T.cpp.

 {
   //Case 1: I can't give away what's not mine
   //  (includes zero-copy since sc_release_ is always false for zero-copy
   if (orphan && !sc_release_) return 0;
 
   // (preparation for cases 2-3)
   if (is_zero_copy()) make_single_copy(max_slots());
 
   if (!sc_buffer_) {
     sc_buffer_ = allocbuf(sc_maximum_);
 
     if (!orphan) sc_release_ = true;
   }
 
   //Case 2: Keeping the buffer but letting client use it too
   if (!orphan) return sc_buffer_;
 
   //Case 3: Orphaning the buffer to the client, leaves "this" in the
   //  default-constructed state (which in our case is ZC-enabled)
   ZeroCopyDataSeq<Sample_T, DEF_MAX> yours;
   swap(yours);
   yours.sc_release_ = false; //don't freebuf in dtor
   return yours.sc_buffer_;
 }

◆ get_buffer() [2/2]

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE const Sample_T * TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::get_buffer ( ) const

Definition at line 218 of file ZeroCopySeq_T.inl.

References ACE_INLINE, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::allocbuf(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::is_zero_copy(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::make_single_copy(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::max_slots(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_buffer_, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_maximum_, and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_release_.

 {
   //If we're currently zero-copy we must become single copy in order to return
   //a contiguous buffer.  The only way to do this and meet the CORBA/C++ spec
   //interface is to cast-away the constness.
   if (is_zero_copy())
     const_cast<ZeroCopyDataSeq*>(this)->make_single_copy(max_slots());
 
   if (!sc_buffer_) {
     sc_buffer_ = allocbuf(sc_maximum_);
     sc_release_ = true;
   }
 
   return sc_buffer_;
 }

◆ get_ptr()

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE OpenDDS::DCPS::ReceivedDataElement * TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::get_ptr ( CORBA::ULong ii ) const

private

Definition at line 292 of file ZeroCopySeq_T.inl.

References ACE_INLINE, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::is_zero_copy(), OPENDDS_ASSERT, and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ptrs_.

 {
   OPENDDS_ASSERT(is_zero_copy());
   return ptrs_[ii];
 }

◆ increment_references()

template<class Sample_T , size_t DEF_MAX>

void TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::increment_references ( )

Definition at line 159 of file ZeroCopySeq_T.cpp.

References TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::is_zero_copy(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ptrs_, ACE_Vector< T, DEFAULT_SIZE >::size(), and TAO_END_VERSIONED_NAMESPACE_DECL.

 {
   if (is_zero_copy()) {
     for (size_t ii = 0; ii < ptrs_.size(); ++ii) {
       ptrs_[ii]->inc_ref();
     }
   }
 }

◆ internal_set_length()

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE void TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::internal_set_length ( CORBA::ULong len )

private

Definition at line 252 of file ZeroCopySeq_T.inl.

References ACE_INLINE, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::is_zero_copy(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::length(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ptrs_, ACE_Vector< T, DEFAULT_SIZE >::resize(), and ACE_Vector< T, DEFAULT_SIZE >::size().

 {
   if (!is_zero_copy() || len < ptrs_.size()) {
     length(len);
 
   } else if (len > ptrs_.size()) {
     //We need the vector to grow efficiently (not reallocate on each call)...
     ptrs_.resize((std::max)(len, CORBA::ULong(ptrs_.size()) * 2), 0);
     //...but maintain the invariant that the size of ptrs_ is our length
     ptrs_.resize(len, 0);
   }
 }

◆ is_zero_copy()

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE bool TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::is_zero_copy ( ) const

private

Definition at line 125 of file ZeroCopySeq_T.inl.

References ACE_INLINE, and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_maximum_.

 {
   return sc_maximum_ == 0;
 }

◆ length() [1/2]

template<class Sample_T , size_t DEF_MAX>

void TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::length ( CORBA::ULong length )

Performance note: increasing the length of a zero-copy sequence past its current length may cause a copy (the sequence will no longer be zero-copy enabled).

Definition at line 66 of file ZeroCopySeq_T.cpp.

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::make_single_copy().

 {
   using std::fill;
   using std::max;
   using std::copy;
 
   if (length == this->length()) {
     return;
   }
 
   if (is_zero_copy()) {
     if (length < ptrs_.size()) {
       if (!loaner_) {
         make_single_copy(length);
         this->length(length);
         return;
       }
 
       for (size_t i(length); i < ptrs_.size(); ++i) {
         --ptrs_[i]->zero_copy_cnt_;
         ptrs_[i]->dec_ref();
       }
 
       ptrs_.resize(length, 0);
       // At this point, there is no longer a loan
       this->set_loaner(0);
 
     } else {
       //There's no way we can expand the size (logical) of the zero-copy
       //array and have the user do any meaningful operations on the new
       //elements.  The fact that they're pointers to ReceivedDataElement
       //is hidden from the user.  Thus we need to make the sequence
       //single-copy at this point.
       make_single_copy(length);
       sc_length_ = length;
     }
 
   } else {
     if (length < sc_length_) { //shrink
       sc_length_ = length;
 
     } else if (length <= sc_maximum_) { //grow within buffer
       fill(&sc_buffer_[sc_length_], &sc_buffer_[length], Sample_T());
       sc_length_ = length;
 
     } else { //grow to larger buffer
       ZeroCopyDataSeq<Sample_T, DEF_MAX> grow(max(length, sc_maximum_*2));
       grow.sc_length_ = length;
       copy(sc_buffer_, &sc_buffer_[sc_length_], grow.sc_buffer_);
       fill(&grow.sc_buffer_[sc_length_], &grow.sc_buffer_[length],
            Sample_T());
       swap(grow);
     }
   }
 }

◆ length() [2/2]

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE CORBA::ULong TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::length ( void ) const

Definition at line 147 of file ZeroCopySeq_T.inl.

References ACE_INLINE, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::is_zero_copy(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ptrs_, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_length_, and ACE_Vector< T, DEFAULT_SIZE >::size().

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::internal_set_length(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::length(), and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::~ZeroCopyDataSeq().

 {
   return is_zero_copy() ? static_cast<CORBA::ULong>(ptrs_.size()) : sc_length_;
 }

◆ make_single_copy()

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE void TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::make_single_copy ( CORBA::ULong maximum )

private

Definition at line 203 of file ZeroCopySeq_T.inl.

References ACE_INLINE, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::length(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ptrs_, ACE_Vector< T, DEFAULT_SIZE >::size(), and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::swap().

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::get_buffer(), and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::length().

 {
   CORBA::ULong currentSize(static_cast<CORBA::ULong>(ptrs_.size()));
   ZeroCopyDataSeq<Sample_T, DEF_MAX> sc((std::max)(maximum, currentSize));
   sc.length(currentSize);
 
   for (CORBA::ULong i(0); i < ptrs_.size(); ++i) {
     sc[i] = (*this)[i];
   }
 
   swap(sc);
 }

◆ max_slots()

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE CORBA::ULong TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::max_slots ( ) const

private

Current allocated number of sample slots.

Note: The DDS specification's use of maximum=0 to designate zero-copy read request requires some way of knowing the internally allocated slots for sample pointers that is not "maximum".

Definition at line 139 of file ZeroCopySeq_T.inl.

References ACE_INLINE, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::is_zero_copy(), ACE_Array_Base< T >::max_size(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ptrs_, and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_maximum_.

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::get_buffer().

 {
   return is_zero_copy() ? static_cast<CORBA::ULong>(ptrs_.max_size())
     : sc_maximum_;
 }

◆ maximum()

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE CORBA::ULong TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::maximum ( ) const

Definition at line 132 of file ZeroCopySeq_T.inl.

References ACE_INLINE, and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_maximum_.

 {
   return sc_maximum_;
 }

◆ operator=()

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE ZeroCopyDataSeq< Sample_T, DEF_MAX > & TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::operator= ( const ZeroCopyDataSeq< Sample_T, DEF_MAX > & frm )

Definition at line 75 of file ZeroCopySeq_T.inl.

References ACE_INLINE, and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::swap().

 {
   if (this != &frm) {
     ZeroCopyDataSeq<Sample_T, DEF_MAX> temp(frm);
     swap(temp);
   }
 
   return *this;
 }

◆ operator[]() [1/2]

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE const Sample_T & TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::operator[] ( CORBA::ULong i ) const

Definition at line 154 of file ZeroCopySeq_T.inl.

References ACE_INLINE, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::default_, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::is_zero_copy(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ptrs_, and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_buffer_.

 {
   if (is_zero_copy()) {
     if (ptrs_[i]->registered_data_) {
       return *static_cast<const Sample_T*>(ptrs_[i]->registered_data_);
     }
     return default_;
 
   } else {
     return sc_buffer_[i];
   }
 }

◆ operator[]() [2/2]

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE Sample_T & TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::operator[] ( CORBA::ULong i )

Definition at line 169 of file ZeroCopySeq_T.inl.

References ACE_INLINE, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::default_, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::is_zero_copy(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ptrs_, and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_buffer_.

 {
   if (is_zero_copy()) {
     if (ptrs_[i]->registered_data_) {
       return *static_cast<Sample_T*>(ptrs_[i]->registered_data_);
     }
     return default_;
 
   } else {
     return sc_buffer_[i];
   }
 }

◆ release()

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE CORBA::Boolean TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::release ( void ) const

Definition at line 184 of file ZeroCopySeq_T.inl.

References ACE_INLINE, and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_release_.

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::~ZeroCopyDataSeq().

 {
   return sc_release_; //will always be false in zero-copy mode
 }

◆ replace()

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE void TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::replace	(	CORBA::ULong	max,
		CORBA::ULong	length,
		Sample_T *	buffer,
		CORBA::Boolean	release = `false`
	)

Definition at line 191 of file ZeroCopySeq_T.inl.

References ACE_INLINE, and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::swap().

 {
   ZeroCopyDataSeq<Sample_T, DEF_MAX> newOne(maximum, length, buffer, release);
   swap(newOne);
 }

◆ set_loaner()

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE void TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::set_loaner ( OpenDDS::DCPS::DataReaderImpl * loaner )

private

Definition at line 267 of file ZeroCopySeq_T.inl.

References ACE_INLINE, and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::loaner_.

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::length().

 {
   loaner_ = loaner;
 }

◆ swap()

template<class Sample_T , size_t DEF_MAX>

ACE_INLINE void TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::swap ( ZeroCopyDataSeq< Sample_T, DEF_MAX > & frm )

Definition at line 88 of file ZeroCopySeq_T.inl.

References ACE_INLINE, ACE_Array_Base< T >::allocator_, ACE_Array_Base< T >::array_, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::default_allocator_, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::loaner_, OpenDDS::DCPS::FirstTimeFastAllocator< T, N >::pool(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ptrs_, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_buffer_, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_length_, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_maximum_, TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_release_, OpenDDS::DCPS::swap(), and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ZeroCopyVector::swap().

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::get_buffer(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::length(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::make_single_copy(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::operator=(), and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::replace().

 {
   bool thisUsedDefAlloc = ptrs_.allocator_ == &default_allocator_;
   bool thisUsedLocalBuffer = ptrs_.array_ == default_allocator_.pool();
   bool frmUsedDefAlloc = frm.ptrs_.allocator_ == &frm.default_allocator_;
   bool frmUsedLocalBuffer = frm.ptrs_.array_ == frm.default_allocator_.pool();
 
   std::swap(loaner_, frm.loaner_);
   std::swap(default_allocator_, frm.default_allocator_);
   ptrs_.swap(frm.ptrs_);
   std::swap(sc_maximum_, frm.sc_maximum_);
   std::swap(sc_length_, frm.sc_length_);
   std::swap(sc_buffer_, frm.sc_buffer_);
   std::swap(sc_release_, frm.sc_release_);
 
   if (thisUsedDefAlloc) frm.ptrs_.allocator_ = &frm.default_allocator_;
 
   if (thisUsedLocalBuffer) frm.ptrs_.array_ = frm.default_allocator_.pool();
 
   if (frmUsedDefAlloc) ptrs_.allocator_ = &default_allocator_;
 
   if (frmUsedLocalBuffer) ptrs_.array_ = default_allocator_.pool();
 }

Friends And Related Function Documentation

◆ PrivateMemberAccess

template<class Sample_T, size_t DEF_MAX = DCPS_ZERO_COPY_SEQ_DEFAULT_SIZE>

friend class PrivateMemberAccess

friend

Definition at line 148 of file ZeroCopySeq_T.h.

Member Data Documentation

◆ default_

template<class Sample_T, size_t DEF_MAX = DCPS_ZERO_COPY_SEQ_DEFAULT_SIZE>

Sample_T TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::default_

staticprivate

Definition at line 206 of file ZeroCopySeq_T.h.

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::operator[]().

◆ default_allocator_

template<class Sample_T, size_t DEF_MAX = DCPS_ZERO_COPY_SEQ_DEFAULT_SIZE>

OpenDDS::DCPS::FirstTimeFastAllocator<OpenDDS::DCPS::ReceivedDataElement*, DEF_MAX> TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::default_allocator_

private

the default allocator

Definition at line 200 of file ZeroCopySeq_T.h.

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::swap().

◆ loaner_

template<class Sample_T, size_t DEF_MAX = DCPS_ZERO_COPY_SEQ_DEFAULT_SIZE>

OpenDDS::DCPS::DataReaderImpl* TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::loaner_

private

The loaner that loaned its samples.

Definition at line 196 of file ZeroCopySeq_T.h.

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::length(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::set_loaner(), and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::swap().

◆ ptrs_

template<class Sample_T, size_t DEF_MAX = DCPS_ZERO_COPY_SEQ_DEFAULT_SIZE>

Ptr_Seq_Type TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ptrs_

private

array of pointers if the sequence is supporting zero-copy reads

Definition at line 205 of file ZeroCopySeq_T.h.

◆ sc_buffer_

template<class Sample_T, size_t DEF_MAX = DCPS_ZERO_COPY_SEQ_DEFAULT_SIZE>

Sample_T* TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_buffer_

mutableprivate

Definition at line 211 of file ZeroCopySeq_T.h.

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::assign_sample(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::get_buffer(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::length(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::operator[](), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::swap(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ZeroCopyDataSeq(), and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::~ZeroCopyDataSeq().

◆ sc_length_

template<class Sample_T, size_t DEF_MAX = DCPS_ZERO_COPY_SEQ_DEFAULT_SIZE>

CORBA::ULong TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_length_

private

Definition at line 210 of file ZeroCopySeq_T.h.

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::length(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::swap(), and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::ZeroCopyDataSeq().

◆ sc_maximum_

template<class Sample_T, size_t DEF_MAX = DCPS_ZERO_COPY_SEQ_DEFAULT_SIZE>

CORBA::ULong TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_maximum_

private

Definition at line 209 of file ZeroCopySeq_T.h.

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::get_buffer(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::is_zero_copy(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::length(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::max_slots(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::maximum(), and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::swap().

◆ sc_release_

template<class Sample_T, size_t DEF_MAX = DCPS_ZERO_COPY_SEQ_DEFAULT_SIZE>

CORBA::Boolean TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::sc_release_

mutableprivate

Definition at line 212 of file ZeroCopySeq_T.h.

Referenced by TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::get_buffer(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::release(), TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::swap(), and TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >::~ZeroCopyDataSeq().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

template<class Sample_T, size_t DEF_MAX = DCPS_ZERO_COPY_SEQ_DEFAULT_SIZE> class TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >

Member Typedef Documentation

◆ Ptr_Seq_Type

◆ value_type

Constructor & Destructor Documentation

◆ ZeroCopyDataSeq() [1/3]

◆ ZeroCopyDataSeq() [2/3]

◆ ZeroCopyDataSeq() [3/3]

◆ ~ZeroCopyDataSeq()

Member Function Documentation

◆ allocbuf()

◆ assign_ptr()

◆ assign_sample()

◆ freebuf()

◆ get_buffer() [1/2]

◆ get_buffer() [2/2]

◆ get_ptr()

◆ increment_references()

◆ internal_set_length()

◆ is_zero_copy()

◆ length() [1/2]

◆ length() [2/2]

◆ make_single_copy()

◆ max_slots()

◆ maximum()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ release()

◆ replace()

◆ set_loaner()

◆ swap()

Friends And Related Function Documentation

◆ PrivateMemberAccess

Member Data Documentation

◆ default_

◆ default_allocator_

◆ loaner_

◆ ptrs_

◆ sc_buffer_

◆ sc_length_

◆ sc_maximum_

◆ sc_release_

template<class Sample_T, size_t DEF_MAX = DCPS_ZERO_COPY_SEQ_DEFAULT_SIZE>
class TAO::DCPS::ZeroCopyDataSeq< Sample_T, DEF_MAX >