#include <ReceivedDataElementList.h>

Inheritance diagram for OpenDDS::DCPS::ReceivedDataElement:

Collaboration diagram for OpenDDS::DCPS::ReceivedDataElement:

[legend]

Public Member Functions
	ReceivedDataElement (const DataSampleHeader &header, void received_data, ACE_Recursive_Thread_Mutex mx)

virtual	~ReceivedDataElement ()

void	dec_ref ()

void	inc_ref ()

long	ref_count ()

void *	operator new (size_t size, ACE_New_Allocator &pool)

void	operator delete (void *memory)

void	operator delete (void *memory, ACE_New_Allocator &pool)

Public Attributes
GUID_t	pub_

void *const	registered_data_

DDS::SampleStateKind	sample_state_

DDS::Time_t	source_timestamp_
	Source time stamp for this data sample. More...

DDS::Time_t	destination_timestamp_
	Reception time stamp for this data sample. More...

bool	coherent_change_
	Sample belongs to an active coherent change set. More...

bool	group_coherent_
	Sample belongs to a group coherent changes. More...

GUID_t	publisher_id_
	Publisher id represent group identifier. More...

bool	valid_data_
	Do we contain valid data. More...

size_t	disposed_generation_count_

size_t	no_writers_generation_count_

Atomic< long >	zero_copy_cnt_

SequenceNumber	sequence_
	The data sample's sequence number. More...

ReceivedDataElement *	previous_data_sample_
	the previous data sample in the ReceivedDataElementList More...

ReceivedDataElement *	next_data_sample_
	the next data sample in the ReceivedDataElementList More...

Protected Attributes
ACE_Recursive_Thread_Mutex *	mx_

Private Attributes
Atomic< long >	ref_count_

Detailed Description

Definition at line 33 of file ReceivedDataElementList.h.

Constructor & Destructor Documentation

◆ ReceivedDataElement()

OpenDDS::DCPS::ReceivedDataElement::ReceivedDataElement	(	const DataSampleHeader &	header,
		void *	received_data,
		ACE_Recursive_Thread_Mutex *	mx
	)

inline

Definition at line 35 of file ReceivedDataElementList.h.

References OpenDDS::DCPS::TimePoint_T< SystemClock >::now(), DDS::Time_t::sec, OpenDDS::DCPS::DataSampleHeader::source_timestamp_nanosec_, OpenDDS::DCPS::DataSampleHeader::source_timestamp_sec_, OpenDDS::DCPS::TimePoint_T< AceClock >::to_dds_time(), and OpenDDS::DCPS::DataSampleHeader::valid_data().

     : pub_(header.publication_id_),
       registered_data_(received_data),
       sample_state_(DDS::NOT_READ_SAMPLE_STATE),
 #ifndef OPENDDS_NO_OBJECT_MODEL_PROFILE
       coherent_change_(header.coherent_change_),
       group_coherent_(header.group_coherent_),
       publisher_id_(header.publisher_id_),
 #endif
       valid_data_(received_data != 0),
       disposed_generation_count_(0),
       no_writers_generation_count_(0),
       zero_copy_cnt_(0),
       sequence_(header.sequence_),
       previous_data_sample_(0),
       next_data_sample_(0),
       ref_count_(1),
       mx_(mx)
   {
     destination_timestamp_ = SystemTimePoint::now().to_dds_time();
 
     source_timestamp_.sec = header.source_timestamp_sec_;
     source_timestamp_.nanosec = header.source_timestamp_nanosec_;
 
     /*
      * In some situations, we will not have data to give to the user and
      * valid_data is how we communcate that to the user through a SampleInfo.
      */
     if (!header.valid_data()) {
       valid_data_ = false;
     }
   }

◆ ~ReceivedDataElement()

virtual OpenDDS::DCPS::ReceivedDataElement::~ReceivedDataElement ( )

inlinevirtual

Definition at line 68 of file ReceivedDataElementList.h.

68 {}

Member Function Documentation

◆ dec_ref()

void OpenDDS::DCPS::ReceivedDataElement::dec_ref ( )

inline

Definition at line 70 of file ReceivedDataElementList.h.

Referenced by OpenDDS::DCPS::RakeResults< MessageType >::copy_into(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::finish_store_instance_data(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::purge_data(), and OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::take_next_sample().

   {
     if (0 == --ref_count_) {
       delete this;
     }
   }

◆ inc_ref()

void OpenDDS::DCPS::ReceivedDataElement::inc_ref ( )

inline

Definition at line 77 of file ReceivedDataElementList.h.

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

   {
     ++ref_count_;
   }

◆ operator delete() [1/2]

void OpenDDS::DCPS::ReceivedDataElement::operator delete ( void * memory )

Definition at line 44 of file ReceivedDataElementList.cpp.

References OpenDDS::DCPS::ReceivedDataElementMemoryBlock::allocator_, and ACE_New_Allocator::free().

 {
   if (memory) {
     OpenDDS::DCPS::ReceivedDataElementMemoryBlock* block = static_cast<OpenDDS::DCPS::ReceivedDataElementMemoryBlock*>(memory);
     block->allocator_->free(block);
   }
 }

◆ operator delete() [2/2]

void OpenDDS::DCPS::ReceivedDataElement::operator delete	(	void *	memory,
		ACE_New_Allocator &	pool
	)

Definition at line 52 of file ReceivedDataElementList.cpp.

 {
   operator delete(memory);
 }

◆ operator new()

void * OpenDDS::DCPS::ReceivedDataElement::operator new	(	size_t	size,
		ACE_New_Allocator &	pool
	)

Definition at line 37 of file ReceivedDataElementList.cpp.

References OpenDDS::DCPS::ReceivedDataElementMemoryBlock::allocator_.

 {
   OpenDDS::DCPS::ReceivedDataElementMemoryBlock* block =  static_cast<OpenDDS::DCPS::ReceivedDataElementMemoryBlock*>(pool.malloc(sizeof(OpenDDS::DCPS::ReceivedDataElementMemoryBlock)));
   block->allocator_ = &pool;
   return block;
 }

◆ ref_count()

long OpenDDS::DCPS::ReceivedDataElement::ref_count ( )

inline

Definition at line 82 of file ReceivedDataElementList.h.

   {
     return ref_count_;
   }

Member Data Documentation

◆ coherent_change_

bool OpenDDS::DCPS::ReceivedDataElement::coherent_change_

Sample belongs to an active coherent change set.

Definition at line 107 of file ReceivedDataElementList.h.

Referenced by OpenDDS::DCPS::ReceivedDataElementList::accept_coherent_change(), OpenDDS::DCPS::ReceivedDataElementList::add(), OpenDDS::DCPS::ReceivedDataElementList::add_by_timestamp(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::finish_store_instance_data(), OpenDDS::DCPS::ReceivedDataElementList::get_next_match(), OpenDDS::DCPS::ReceivedDataElementList::mark_read(), and OpenDDS::DCPS::ReceivedDataElementList::remove().

◆ destination_timestamp_

DDS::Time_t OpenDDS::DCPS::ReceivedDataElement::destination_timestamp_

Reception time stamp for this data sample.

Definition at line 103 of file ReceivedDataElementList.h.

◆ disposed_generation_count_

size_t OpenDDS::DCPS::ReceivedDataElement::disposed_generation_count_

The data sample's instance's disposed_generation_count_ at the time the sample was received

Definition at line 121 of file ReceivedDataElementList.h.

Referenced by OpenDDS::DCPS::RakeResults< MessageType >::copy_into(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::finish_store_instance_data(), OpenDDS::DCPS::InstanceState::most_recent_generation(), OpenDDS::DCPS::InstanceState::sample_info(), and OpenDDS::DCPS::DataReaderImpl::sample_info().

◆ group_coherent_

bool OpenDDS::DCPS::ReceivedDataElement::group_coherent_

Sample belongs to a group coherent changes.

Definition at line 110 of file ReceivedDataElementList.h.

◆ mx_

ACE_Recursive_Thread_Mutex* OpenDDS::DCPS::ReceivedDataElement::mx_

protected

Definition at line 147 of file ReceivedDataElementList.h.

◆ next_data_sample_

ReceivedDataElement* OpenDDS::DCPS::ReceivedDataElement::next_data_sample_

the next data sample in the ReceivedDataElementList

Definition at line 138 of file ReceivedDataElementList.h.

Referenced by OpenDDS::DCPS::ReceivedDataElementList::add(), OpenDDS::DCPS::ReceivedDataElementList::add_by_timestamp(), OpenDDS::DCPS::ReceivedDataElementList::apply_all(), OpenDDS::DCPS::ReceivedDataElementList::get_next_match(), OpenDDS::DCPS::ReceivedDataElementList::has_zero_copies(), OpenDDS::DCPS::ReceivedDataElementList::remove(), and OpenDDS::DCPS::ReceivedDataElementList::sanity_check().

◆ no_writers_generation_count_

size_t OpenDDS::DCPS::ReceivedDataElement::no_writers_generation_count_

The data sample's instance's no_writers_generation_count_ at the time the sample was received

Definition at line 125 of file ReceivedDataElementList.h.

Referenced by OpenDDS::DCPS::RakeResults< MessageType >::copy_into(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::finish_store_instance_data(), OpenDDS::DCPS::InstanceState::most_recent_generation(), OpenDDS::DCPS::InstanceState::sample_info(), and OpenDDS::DCPS::DataReaderImpl::sample_info().

◆ previous_data_sample_

ReceivedDataElement* OpenDDS::DCPS::ReceivedDataElement::previous_data_sample_

the previous data sample in the ReceivedDataElementList

Definition at line 135 of file ReceivedDataElementList.h.

Referenced by OpenDDS::DCPS::ReceivedDataElementList::add(), OpenDDS::DCPS::ReceivedDataElementList::add_by_timestamp(), OpenDDS::DCPS::ReceivedDataElementList::remove(), and OpenDDS::DCPS::ReceivedDataElementList::sanity_check().

◆ pub_

GUID_t OpenDDS::DCPS::ReceivedDataElement::pub_

Definition at line 87 of file ReceivedDataElementList.h.

Referenced by OpenDDS::DCPS::InstanceState::sample_info().

◆ publisher_id_

GUID_t OpenDDS::DCPS::ReceivedDataElement::publisher_id_

Publisher id represent group identifier.

Definition at line 113 of file ReceivedDataElementList.h.

◆ ref_count_

Atomic<long> OpenDDS::DCPS::ReceivedDataElement::ref_count_

private

Definition at line 145 of file ReceivedDataElementList.h.

◆ registered_data_

void* const OpenDDS::DCPS::ReceivedDataElement::registered_data_

Data sample received, could only be the key fields in case we received dispose and/or unregister message.

Definition at line 93 of file ReceivedDataElementList.h.

Referenced by OpenDDS::DCPS::RakeResults< MessageType >::copy_into(), OpenDDS::DCPS::RakeResults< MessageType >::insert_sample(), OpenDDS::DCPS::RakeResults< MessageType >::SortedSetCmp::operator()(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::read_i(), and OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::take_next_sample().

◆ sample_state_

DDS::SampleStateKind OpenDDS::DCPS::ReceivedDataElement::sample_state_

Sample state for this data sample: DDS::NOT_READ_SAMPLE_STATE/DDS::READ_SAMPLE_STATE

Definition at line 97 of file ReceivedDataElementList.h.

Referenced by OpenDDS::DCPS::ReceivedDataElementList::add(), OpenDDS::DCPS::ReceivedDataElementList::add_by_timestamp(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::finish_store_instance_data(), OpenDDS::DCPS::ReceivedDataElementList::get_next_match(), OpenDDS::DCPS::ReceivedDataElementList::mark_read(), OpenDDS::DCPS::ReceivedDataElementList::remove(), and OpenDDS::DCPS::InstanceState::sample_info().

◆ sequence_

SequenceNumber OpenDDS::DCPS::ReceivedDataElement::sequence_

The data sample's sequence number.

Definition at line 132 of file ReceivedDataElementList.h.

Referenced by OpenDDS::DCPS::InstanceState::sample_info(), and OpenDDS::DCPS::DataReaderImpl::sample_info().

◆ source_timestamp_

DDS::Time_t OpenDDS::DCPS::ReceivedDataElement::source_timestamp_

Source time stamp for this data sample.

Definition at line 100 of file ReceivedDataElementList.h.

Referenced by OpenDDS::DCPS::ReceivedDataElementList::add_by_timestamp(), OpenDDS::DCPS::GroupRakeData::SortedSetCmp::operator()(), OpenDDS::DCPS::RakeResults< MessageType >::SortedSetCmp::operator()(), and OpenDDS::DCPS::InstanceState::sample_info().

◆ valid_data_

bool OpenDDS::DCPS::ReceivedDataElement::valid_data_

Do we contain valid data.

Definition at line 117 of file ReceivedDataElementList.h.

Referenced by OpenDDS::DCPS::GroupRakeData::insert_sample(), OpenDDS::DCPS::RakeResults< MessageType >::insert_sample(), and OpenDDS::DCPS::InstanceState::sample_info().

◆ zero_copy_cnt_

Atomic<long> OpenDDS::DCPS::ReceivedDataElement::zero_copy_cnt_

This is needed to know if delete DataReader should fail with PRECONDITION_NOT_MET because there are outstanding loans.

Definition at line 129 of file ReceivedDataElementList.h.

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

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

Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ReceivedDataElement()

◆ ~ReceivedDataElement()

Member Function Documentation

◆ dec_ref()

◆ inc_ref()

◆ operator delete() [1/2]

◆ operator delete() [2/2]

◆ operator new()

◆ ref_count()

Member Data Documentation

◆ coherent_change_

◆ destination_timestamp_

◆ disposed_generation_count_

◆ group_coherent_

◆ mx_

◆ next_data_sample_

◆ no_writers_generation_count_

◆ previous_data_sample_

◆ pub_

◆ publisher_id_

◆ ref_count_

◆ registered_data_

◆ sample_state_

◆ sequence_

◆ source_timestamp_

◆ valid_data_

◆ zero_copy_cnt_