#include <ReceivedDataElementList.h>

Collaboration diagram for OpenDDS::DCPS::ReceivedDataElementList:

[legend]

Public Member Functions
	ReceivedDataElementList (const DataReaderImpl_rch &reader, const InstanceState_rch &instance_state=InstanceState_rch())

	~ReceivedDataElementList ()

void	apply_all (ReceivedDataFilter &match, ReceivedDataOperation &func)

void	add (ReceivedDataElement *data_sample)

void	add_by_timestamp (ReceivedDataElement *data_sample)

bool	remove (ReceivedDataElement *data_sample)

bool	remove (ReceivedDataFilter &match, bool eval_all)

const ReceivedDataElement *	peek_tail ()

ReceivedDataElement *	remove_head ()

ReceivedDataElement *	remove_tail ()

size_t	size () const

bool	has_zero_copies () const

bool	matches (CORBA::ULong sample_states) const

ReceivedDataElement *	get_next_match (CORBA::ULong sample_states, ReceivedDataElement *prev)

void	mark_read (ReceivedDataElement *item)

void	accept_coherent_change (ReceivedDataElement *item)

Private Member Functions
void	increment_read_count ()

void	decrement_read_count ()

void	increment_not_read_count ()

void	decrement_not_read_count ()

bool	sanity_check ()

bool	sanity_check (ReceivedDataElement *item)

Private Attributes
DataReaderImpl_wrch	reader_

ReceivedDataElement *	head_
	The first element of the list. More...

ReceivedDataElement *	tail_
	The last element of the list. More...

size_t	size_
	Number of elements in the list. More...

CORBA::ULong	read_sample_count_

CORBA::ULong	not_read_sample_count_

CORBA::ULong	sample_states_

InstanceState_rch	instance_state_

Detailed Description

Definition at line 190 of file ReceivedDataElementList.h.

Constructor & Destructor Documentation

◆ ReceivedDataElementList()

OpenDDS::DCPS::ReceivedDataElementList::ReceivedDataElementList	(	const DataReaderImpl_rch &	reader,
		const InstanceState_rch &	instance_state = `InstanceState_rch()`
	)

explicit

Definition at line 57 of file ReceivedDataElementList.cpp.

   : reader_(reader), head_(0), tail_(0), size_(0)
   , read_sample_count_(0), not_read_sample_count_(0), sample_states_(0)
   , instance_state_(instance_state)
 {
 }

◆ ~ReceivedDataElementList()

OpenDDS::DCPS::ReceivedDataElementList::~ReceivedDataElementList ( )

Definition at line 64 of file ReceivedDataElementList.cpp.

 {
   // The memory pointed to by instance_state_ is owned by
   // another object.
 }

Member Function Documentation

◆ accept_coherent_change()

void OpenDDS::DCPS::ReceivedDataElementList::accept_coherent_change ( ReceivedDataElement * item )

Definition at line 255 of file ReceivedDataElementList.cpp.

References OpenDDS::DCPS::ReceivedDataElement::coherent_change_, increment_not_read_count(), OPENDDS_ASSERT, and sanity_check().

 {
   OPENDDS_ASSERT(sanity_check(item));
   if (item->coherent_change_) {
     item->coherent_change_ = false;
     increment_not_read_count();
   }
 }

◆ add()

ACE_INLINE void OpenDDS::DCPS::ReceivedDataElementList::add ( ReceivedDataElement * data_sample )

Definition at line 13 of file ReceivedDataElementList.inl.

References ACE_INLINE, OpenDDS::DCPS::ReceivedDataElement::coherent_change_, OpenDDS::DCPS::InstanceState::empty(), head_, increment_not_read_count(), increment_read_count(), instance_state_, OpenDDS::DCPS::ReceivedDataElement::next_data_sample_, DDS::NOT_READ_SAMPLE_STATE, OpenDDS::DCPS::ReceivedDataElement::previous_data_sample_, OpenDDS::DCPS::ReceivedDataElement::sample_state_, size_, and tail_.

Referenced by OpenDDS::DCPS::ReceivedDataStrategy::add(), and add_by_timestamp().

 {
   // The default action is to simply add to the
   // tail - in the future we may want to add
   // to the middle of the list based on sequence
   // number and/or source timestamp
 
   data_sample->previous_data_sample_ = 0;
   data_sample->next_data_sample_ = 0;
 
   ++size_;
 
 #ifndef OPENDDS_NO_OBJECT_MODEL_PROFILE
   if (!data_sample->coherent_change_)
 #endif
   {
     if (data_sample->sample_state_ == DDS::NOT_READ_SAMPLE_STATE) {
       increment_not_read_count();
     } else {
       increment_read_count();
     }
   }
 
   if (!head_) {
     // First sample in the list.
     head_ = tail_ = data_sample;
 
   } else {
     // Add to existing list.
     tail_->next_data_sample_ = data_sample;
     data_sample->previous_data_sample_ = tail_;
     tail_ = data_sample;
   }
 
   if (instance_state_) {
     instance_state_->empty(false);
   }
 }

◆ add_by_timestamp()

void OpenDDS::DCPS::ReceivedDataElementList::add_by_timestamp ( ReceivedDataElement * data_sample )

Definition at line 71 of file ReceivedDataElementList.cpp.

References add(), OpenDDS::DCPS::ReceivedDataElement::coherent_change_, head_, increment_not_read_count(), increment_read_count(), OpenDDS::DCPS::ReceivedDataElement::next_data_sample_, DDS::NOT_READ_SAMPLE_STATE, OpenDDS::DCPS::ReceivedDataElement::previous_data_sample_, OpenDDS::DCPS::ReceivedDataElement::sample_state_, size_, and OpenDDS::DCPS::ReceivedDataElement::source_timestamp_.

Referenced by OpenDDS::DCPS::SourceDataStrategy::add().

 {
   data_sample->previous_data_sample_ = 0;
   data_sample->next_data_sample_ = 0;
 
   for (ReceivedDataElement* it = head_; it != 0; it = it->next_data_sample_) {
     if (data_sample->source_timestamp_ < it->source_timestamp_) {
       data_sample->previous_data_sample_ = it->previous_data_sample_;
       data_sample->next_data_sample_ = it;
 
       // Are we replacing the head?
       if (it->previous_data_sample_ == 0) {
         head_ = data_sample;
       } else {
         it->previous_data_sample_->next_data_sample_ = data_sample;
       }
       it->previous_data_sample_ = data_sample;
 
       ++size_;
 #ifndef OPENDDS_NO_OBJECT_MODEL_PROFILE
       if (!data_sample->coherent_change_)
 #endif
       {
         if (data_sample->sample_state_ == DDS::NOT_READ_SAMPLE_STATE) {
           increment_not_read_count();
         } else {
           increment_read_count();
         }
       }
 
       return;
     }
   }
 
   add(data_sample);
 }

◆ apply_all()

void OpenDDS::DCPS::ReceivedDataElementList::apply_all	(	ReceivedDataFilter &	match,
		ReceivedDataOperation &	func
	)

Definition at line 109 of file ReceivedDataElementList.cpp.

References head_, and OpenDDS::DCPS::ReceivedDataElement::next_data_sample_.

Referenced by OpenDDS::DCPS::ReceivedDataStrategy::accept_coherent().

 {
   for (ReceivedDataElement* it = head_; it != 0; it = it->next_data_sample_) {
     if (match(it)) {
       op(it);
     }
   }
 }

◆ decrement_not_read_count()

void OpenDDS::DCPS::ReceivedDataElementList::decrement_not_read_count ( )

private

Definition at line 302 of file ReceivedDataElementList.cpp.

References OpenDDS::DCPS::InstanceState::instance_handle(), instance_state_, OpenDDS::DCPS::WeakRcHandle< T >::lock(), not_read_sample_count_, DDS::NOT_READ_SAMPLE_STATE, OPENDDS_ASSERT, reader_, and sample_states_.

Referenced by mark_read(), and remove().

 {
   OPENDDS_ASSERT(not_read_sample_count_);
   --not_read_sample_count_;
   if (!not_read_sample_count_) {
     sample_states_ &= (~DDS::NOT_READ_SAMPLE_STATE);
     DataReaderImpl_rch reader(reader_.lock());
     if (reader) {
       reader->state_updated(instance_state_->instance_handle());
     }
   }
 }

◆ decrement_read_count()

void OpenDDS::DCPS::ReceivedDataElementList::decrement_read_count ( )

private

Definition at line 277 of file ReceivedDataElementList.cpp.

References OpenDDS::DCPS::InstanceState::instance_handle(), instance_state_, OpenDDS::DCPS::WeakRcHandle< T >::lock(), OPENDDS_ASSERT, read_sample_count_, DDS::READ_SAMPLE_STATE, reader_, and sample_states_.

Referenced by remove().

 {
   OPENDDS_ASSERT(read_sample_count_);
   --read_sample_count_;
   if (!read_sample_count_) {
     sample_states_ &= (~DDS::READ_SAMPLE_STATE);
     DataReaderImpl_rch reader(reader_.lock());
     if (reader) {
       reader->state_updated(instance_state_->instance_handle());
     }
   }
 }

◆ get_next_match()

OpenDDS::DCPS::ReceivedDataElement * OpenDDS::DCPS::ReceivedDataElementList::get_next_match	(	CORBA::ULong	sample_states,
		ReceivedDataElement *	prev
	)

Definition at line 218 of file ReceivedDataElementList.cpp.

References OpenDDS::DCPS::ReceivedDataElement::coherent_change_, head_, OpenDDS::DCPS::ReceivedDataElement::next_data_sample_, OPENDDS_ASSERT, OpenDDS::DCPS::ReceivedDataElement::sample_state_, sanity_check(), and tail_.

Referenced by OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::contains_sample_filtered(), OpenDDS::DCPS::DataReaderImpl::get_ordered_data(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::read_i(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::read_instance_i(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::read_next_sample(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::take_i(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::take_instance_i(), and OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::take_next_sample().

 {
   OPENDDS_ASSERT(sanity_check(prev));
   if (prev == tail_) {
     return 0;
   }
   ReceivedDataElement* item = prev ? prev->next_data_sample_ : head_;
   for (; item != 0; item = item->next_data_sample_) {
     if ((item->sample_state_ & sample_states)
 #ifndef OPENDDS_NO_OBJECT_MODEL_PROFILE
       && !item->coherent_change_
 #endif
       ) {
       return item;
     }
   }
   return 0;
 }

◆ has_zero_copies()

bool OpenDDS::DCPS::ReceivedDataElementList::has_zero_copies ( ) const

Definition at line 201 of file ReceivedDataElementList.cpp.

References head_, and OpenDDS::DCPS::ReceivedDataElement::next_data_sample_.

Referenced by OpenDDS::DCPS::DataReaderImpl::has_zero_copies().

 {
   for (ReceivedDataElement* item = head_; item != 0; item = item->next_data_sample_) {
     if (item->zero_copy_cnt_) {
       return true;
     }
   }
   return false;
 }

◆ increment_not_read_count()

void OpenDDS::DCPS::ReceivedDataElementList::increment_not_read_count ( )

private

Definition at line 290 of file ReceivedDataElementList.cpp.

References OpenDDS::DCPS::InstanceState::instance_handle(), instance_state_, OpenDDS::DCPS::WeakRcHandle< T >::lock(), not_read_sample_count_, DDS::NOT_READ_SAMPLE_STATE, reader_, and sample_states_.

Referenced by accept_coherent_change(), add(), and add_by_timestamp().

 {
   if (!not_read_sample_count_) {
     sample_states_ |= DDS::NOT_READ_SAMPLE_STATE;
     DataReaderImpl_rch reader(reader_.lock());
     if (reader) {
       reader->state_updated(instance_state_->instance_handle());
     }
   }
   ++not_read_sample_count_;
 }

◆ increment_read_count()

void OpenDDS::DCPS::ReceivedDataElementList::increment_read_count ( )

private

Definition at line 265 of file ReceivedDataElementList.cpp.

References OpenDDS::DCPS::InstanceState::instance_handle(), instance_state_, OpenDDS::DCPS::WeakRcHandle< T >::lock(), read_sample_count_, DDS::READ_SAMPLE_STATE, reader_, and sample_states_.

Referenced by add(), add_by_timestamp(), and mark_read().

 {
   if (!read_sample_count_) {
     sample_states_ |= DDS::READ_SAMPLE_STATE;
     DataReaderImpl_rch reader(reader_.lock());
     if (reader) {
       reader->state_updated(instance_state_->instance_handle());
     }
   }
   ++read_sample_count_;
 }

◆ mark_read()

void OpenDDS::DCPS::ReceivedDataElementList::mark_read ( ReceivedDataElement * item )

Definition at line 238 of file ReceivedDataElementList.cpp.

References OpenDDS::DCPS::ReceivedDataElement::coherent_change_, decrement_not_read_count(), increment_read_count(), DDS::NOT_READ_SAMPLE_STATE, OPENDDS_ASSERT, DDS::READ_SAMPLE_STATE, OpenDDS::DCPS::ReceivedDataElement::sample_state_, and sanity_check().

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

 {
   OPENDDS_ASSERT(sanity_check(item));
 #ifndef OPENDDS_NO_OBJECT_MODEL_PROFILE
   if (!item->coherent_change_)
 #endif
   {
     if (item->sample_state_ & DDS::NOT_READ_SAMPLE_STATE) {
       item->sample_state_ = DDS::READ_SAMPLE_STATE;
       decrement_not_read_count();
       increment_read_count();
     }
   }
 }

◆ matches()

bool OpenDDS::DCPS::ReceivedDataElementList::matches ( CORBA::ULong sample_states ) const

Definition at line 212 of file ReceivedDataElementList.cpp.

References sample_states, and sample_states_.

Referenced by OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::finish_store_instance_data(), and OpenDDS::DCPS::SubscriptionInstance::matches().

 {
   return sample_states_ & sample_states;
 }

◆ peek_tail()

const ReceivedDataElement* OpenDDS::DCPS::ReceivedDataElementList::peek_tail ( )

inline

Definition at line 208 of file ReceivedDataElementList.h.

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

208 { return tail_; }

OpenDDS::DCPS::ReceivedDataElementList::tail_

ReceivedDataElement * tail_

The last element of the list.

Definition: ReceivedDataElementList.h:231

◆ remove() [1/2]

bool OpenDDS::DCPS::ReceivedDataElementList::remove ( ReceivedDataElement * data_sample )

Definition at line 142 of file ReceivedDataElementList.cpp.

References OpenDDS::DCPS::ReceivedDataElement::coherent_change_, decrement_not_read_count(), decrement_read_count(), OpenDDS::DCPS::InstanceState::empty(), head_, instance_state_, OpenDDS::DCPS::ReceivedDataElement::next_data_sample_, DDS::NOT_READ_SAMPLE_STATE, OPENDDS_ASSERT, OpenDDS::DCPS::ReceivedDataElement::previous_data_sample_, OpenDDS::DCPS::ReceivedDataElement::sample_state_, sanity_check(), size_, and tail_.

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

 {
   OPENDDS_ASSERT(sanity_check(item));
 
   if (!head_) {
     return false;
   }
 
   bool released = false;
 
   size_--;
 #ifndef OPENDDS_NO_OBJECT_MODEL_PROFILE
   if (!item->coherent_change_)
 #endif
   {
     if (item->sample_state_ == DDS::NOT_READ_SAMPLE_STATE) {
       decrement_not_read_count();
     } else {
       decrement_read_count();
     }
   }
   if (item == head_) {
     if (head_ == tail_) {
       head_ = tail_ = 0;
 
     } else {
       head_ = item->next_data_sample_;
 
       if (head_) {
         head_->previous_data_sample_ = 0;
       }
     }
 
   } else if (item == tail_) {
     tail_ = item->previous_data_sample_;
 
     if (tail_) {
       tail_->next_data_sample_ = 0;
     }
 
   } else {
     item->previous_data_sample_->next_data_sample_ =
       item->next_data_sample_;
     item->next_data_sample_->previous_data_sample_ =
       item->previous_data_sample_;
   }
 
   item->previous_data_sample_ = 0;
   item->next_data_sample_ = 0;
 
   if (instance_state_ && size_ == 0) {
     // let the instance know it is empty
     released = instance_state_->empty(true);
   }
 
   return released;
 }

◆ remove() [2/2]

bool OpenDDS::DCPS::ReceivedDataElementList::remove	(	ReceivedDataFilter &	match,
		bool	eval_all
	)

Definition at line 121 of file ReceivedDataElementList.cpp.

References head_, and OpenDDS::DCPS::ReceivedDataElement::next_data_sample_.

 {
   if (!head_) {
     return false;
   }
 
   bool released = false;
 
   for (ReceivedDataElement* item = head_; item != 0; item = item->next_data_sample_) {
     if (match(item)) {
       released = released || remove(item);
       if (!eval_all) break;
     }
   }
 
   return released;
 }

◆ remove_head()

ACE_INLINE OpenDDS::DCPS::ReceivedDataElement * OpenDDS::DCPS::ReceivedDataElementList::remove_head ( )

Definition at line 54 of file ReceivedDataElementList.inl.

References ACE_INLINE, head_, and size_.

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

 {
   if (!size_) {
     return 0;
   }
 
   OpenDDS::DCPS::ReceivedDataElement *ptr = head_;
   remove(head_);
   return ptr;
 }

◆ remove_tail()

ACE_INLINE OpenDDS::DCPS::ReceivedDataElement * OpenDDS::DCPS::ReceivedDataElementList::remove_tail ( )

Definition at line 67 of file ReceivedDataElementList.inl.

References size_, and tail_.

 {
   if (!size_) {
     return 0;
   }
 
   OpenDDS::DCPS::ReceivedDataElement* ptr = tail_;
   remove(tail_);
   return ptr;
 }

◆ sanity_check() [1/2]

bool OpenDDS::DCPS::ReceivedDataElementList::sanity_check ( )

private

Definition at line 315 of file ReceivedDataElementList.cpp.

References head_, OpenDDS::DCPS::ReceivedDataElement::next_data_sample_, OPENDDS_ASSERT, OpenDDS::DCPS::ReceivedDataElement::previous_data_sample_, and tail_.

Referenced by accept_coherent_change(), get_next_match(), mark_read(), and remove().

 {
   OPENDDS_ASSERT(head_ == 0 || head_->previous_data_sample_ == 0);
   for (ReceivedDataElement* item = head_; item != 0; item = item->next_data_sample_) {
     OPENDDS_ASSERT(sanity_check(item));
   }
   OPENDDS_ASSERT(tail_ == 0 || tail_->next_data_sample_ == 0);
   return true;
 }

◆ sanity_check() [2/2]

bool OpenDDS::DCPS::ReceivedDataElementList::sanity_check ( ReceivedDataElement * item )

private

Definition at line 325 of file ReceivedDataElementList.cpp.

References head_, OpenDDS::DCPS::ReceivedDataElement::next_data_sample_, OPENDDS_ASSERT, OpenDDS::DCPS::ReceivedDataElement::previous_data_sample_, and tail_.

 {
   ACE_UNUSED_ARG(item);
   OPENDDS_ASSERT(item == 0 || (item->next_data_sample_ == 0 && item == tail_) || (item->next_data_sample_ && item->next_data_sample_->previous_data_sample_ == item));
   OPENDDS_ASSERT(item == 0 || (item->previous_data_sample_ == 0 && item == head_) || (item->previous_data_sample_ && item->previous_data_sample_->next_data_sample_ == item));
   return true;
 }

◆ size()

size_t OpenDDS::DCPS::ReceivedDataElementList::size ( void ) const

inline

Definition at line 213 of file ReceivedDataElementList.h.

References sample_states, and size_.

Referenced by OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::finish_store_instance_data(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::purge_data(), and OpenDDS::DCPS::DataReaderImpl::total_samples().

213 { return size_; }

OpenDDS::DCPS::ReceivedDataElementList::size_

size_t size_

Number of elements in the list.

Definition: ReceivedDataElementList.h:234

Member Data Documentation

◆ head_

ReceivedDataElement* OpenDDS::DCPS::ReceivedDataElementList::head_

private

The first element of the list.

Definition at line 228 of file ReceivedDataElementList.h.

Referenced by add(), add_by_timestamp(), apply_all(), get_next_match(), has_zero_copies(), remove(), remove_head(), and sanity_check().

◆ instance_state_

InstanceState_rch OpenDDS::DCPS::ReceivedDataElementList::instance_state_

private

Definition at line 244 of file ReceivedDataElementList.h.

Referenced by add(), decrement_not_read_count(), decrement_read_count(), increment_not_read_count(), increment_read_count(), and remove().

◆ not_read_sample_count_

CORBA::ULong OpenDDS::DCPS::ReceivedDataElementList::not_read_sample_count_

private

Definition at line 237 of file ReceivedDataElementList.h.

Referenced by decrement_not_read_count(), and increment_not_read_count().

◆ read_sample_count_

CORBA::ULong OpenDDS::DCPS::ReceivedDataElementList::read_sample_count_

private

Definition at line 236 of file ReceivedDataElementList.h.

Referenced by decrement_read_count(), and increment_read_count().

◆ reader_

DataReaderImpl_wrch OpenDDS::DCPS::ReceivedDataElementList::reader_

private

Definition at line 225 of file ReceivedDataElementList.h.

Referenced by decrement_not_read_count(), decrement_read_count(), increment_not_read_count(), and increment_read_count().

◆ sample_states_

CORBA::ULong OpenDDS::DCPS::ReceivedDataElementList::sample_states_

private

Definition at line 238 of file ReceivedDataElementList.h.

Referenced by decrement_not_read_count(), decrement_read_count(), increment_not_read_count(), increment_read_count(), and matches().

◆ size_

size_t OpenDDS::DCPS::ReceivedDataElementList::size_

private

Number of elements in the list.

Definition at line 234 of file ReceivedDataElementList.h.

Referenced by add(), add_by_timestamp(), remove(), remove_head(), and remove_tail().

◆ tail_

ReceivedDataElement* OpenDDS::DCPS::ReceivedDataElementList::tail_

private

The last element of the list.

Definition at line 231 of file ReceivedDataElementList.h.

Referenced by add(), get_next_match(), remove(), remove_tail(), and sanity_check().

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ReceivedDataElementList()

◆ ~ReceivedDataElementList()

Member Function Documentation

◆ accept_coherent_change()

◆ add()

◆ add_by_timestamp()

◆ apply_all()

◆ decrement_not_read_count()

◆ decrement_read_count()

◆ get_next_match()

◆ has_zero_copies()

◆ increment_not_read_count()

◆ increment_read_count()

◆ mark_read()

◆ matches()

◆ peek_tail()

◆ remove() [1/2]

◆ remove() [2/2]

◆ remove_head()

◆ remove_tail()

◆ sanity_check() [1/2]

◆ sanity_check() [2/2]

◆ size()

Member Data Documentation

◆ head_

◆ instance_state_

◆ not_read_sample_count_

◆ read_sample_count_

◆ reader_

◆ sample_states_

◆ size_

◆ tail_