OpenDDS::DCPS::InstanceDataSampleList Class Reference

#include <InstanceDataSampleList.h>

Collaboration diagram for OpenDDS::DCPS::InstanceDataSampleList:

Public Member Functions
	InstanceDataSampleList ()
	~InstanceDataSampleList ()
void	reset ()
	Reset to initial state. More...
ssize_t	size () const
DataSampleElement *	head () const
DataSampleElement *	tail () const
void	enqueue_tail (const DataSampleElement *element)
bool	dequeue_head (DataSampleElement *&stale)
bool	dequeue (const DataSampleElement *stale)

Static Public Member Functions
static bool	on_some_list (const DataSampleElement *iter)
static DataSampleElement *	next (const DataSampleElement *iter)
static DataSampleElement *	prev (const DataSampleElement *iter)

Protected Attributes
DataSampleElement *	head_
	The first element of the list. More...
DataSampleElement *	tail_
	The last element of the list. More...
ssize_t	size_
	Number of elements in the list. More...

Detailed Description

A list of DataSampleElement pointers to be queued by the order the samples are written to the instance (within PRESENTATION.access_scope==INSTANCE). It is mainly used on the send side to count the depth of instance data and to allow the removal of elements by instance. Manages DataSampleElement's next_instance_sample pointer

Definition at line 35 of file InstanceDataSampleList.h.

Constructor & Destructor Documentation

InstanceDataSampleList()

ACE_INLINE OpenDDS::DCPS::InstanceDataSampleList::InstanceDataSampleList

(

)

Definition at line 17 of file InstanceDataSampleList.inl.

References ACE_INLINE.

  : head_(0),
    tail_(0),
    size_(0)
{
}

~InstanceDataSampleList()

OpenDDS::DCPS::InstanceDataSampleList::~InstanceDataSampleList ( )

inline

Definition at line 38 of file InstanceDataSampleList.h.

{}

Member Function Documentation

dequeue()

bool OpenDDS::DCPS::InstanceDataSampleList::dequeue

(

const DataSampleElement *

stale

)

Definition at line 33 of file InstanceDataSampleList.cpp.

References dequeue_head(), head_, OpenDDS::DCPS::DataSampleElement::next_instance_sample_, OPENDDS_END_VERSIONED_NAMESPACE_DECL, OpenDDS::DCPS::DataSampleElement::previous_instance_sample_, size_, and tail_.

Referenced by OpenDDS::DCPS::WriteDataContainer::data_delivered(), and OpenDDS::DCPS::WriteDataContainer::remove_excess_durable().

{
  if (head_ == 0) {
    return false;
  }

  if (stale == head_) {
    DataSampleElement* tmp;
    return dequeue_head(tmp);
  }

  if (stale == tail_) {
    tail_ = tail_->previous_instance_sample_;
    tail_->next_instance_sample_ = 0;

  } else {
    stale->previous_instance_sample_->next_instance_sample_ =
      stale->next_instance_sample_;
    stale->next_instance_sample_->previous_instance_sample_ =
      stale->previous_instance_sample_;
  }

  stale->next_instance_sample_ = stale->previous_instance_sample_ = 0;
  --size_;
  return true;
}

dequeue_head()

ACE_INLINE bool OpenDDS::DCPS::InstanceDataSampleList::dequeue_head

(

DataSampleElement *&

stale

)

Definition at line 94 of file InstanceDataSampleList.inl.

References head_, OpenDDS::DCPS::DataSampleElement::next_instance_sample_, OPENDDS_END_VERSIONED_NAMESPACE_DECL, OpenDDS::DCPS::DataSampleElement::previous_instance_sample_, size_, and tail_.

Referenced by dequeue(), and OpenDDS::DCPS::WriteDataContainer::remove_oldest_sample().

{
  //
  // Remove the oldest sample from the instance list.
  //
  stale = head_;

  if (head_ == 0) {
    // try to dequeue empty instance list.
    return false;

  } else {
    --size_;
    head_ = head_->next_instance_sample_;

    if (head_ == 0) {
      tail_ = 0;
    } else {
      head_->previous_instance_sample_ = 0;
    }

    stale->next_instance_sample_ = 0;
    return true;
  }
}

enqueue_tail()

ACE_INLINE void OpenDDS::DCPS::InstanceDataSampleList::enqueue_tail

(

const DataSampleElement *

element

)

Definition at line 68 of file InstanceDataSampleList.inl.

References ACE_INLINE, head_, OpenDDS::DCPS::DataSampleElement::next_instance_sample_, OpenDDS::DCPS::DataSampleElement::previous_instance_sample_, size_, and tail_.

Referenced by OpenDDS::DCPS::WriteDataContainer::enqueue().

{
  // const_cast here so that higher layers don't need to pass around so many
  // non-const pointers to DataSampleElement.  Ideally the design would be
  // changed to accommodate const-correctness throughout.
  DataSampleElement* mSample = const_cast<DataSampleElement*>(sample);

  mSample->next_instance_sample_ = 0;

  ++size_;

  if (head_ == 0) {
    // First sample on queue.
    head_ = tail_ = mSample;
    mSample->previous_instance_sample_ = 0;

  } else {
    // Another sample on an existing queue.
    tail_->next_instance_sample_ = mSample;
    mSample->previous_instance_sample_ = tail_;
    tail_ = mSample;
  }
}

head()

ACE_INLINE DataSampleElement * OpenDDS::DCPS::InstanceDataSampleList::head

(

void

)

const

Definition at line 40 of file InstanceDataSampleList.inl.

References ACE_INLINE, and head_.

{
  return head_;
}

next()

ACE_INLINE DataSampleElement * OpenDDS::DCPS::InstanceDataSampleList::next ( const DataSampleElement *  iter )

static

Definition at line 54 of file InstanceDataSampleList.inl.

References ACE_INLINE, and OpenDDS::DCPS::DataSampleElement::next_instance_sample_.

{
  return iter->next_instance_sample_;
}

on_some_list()

bool OpenDDS::DCPS::InstanceDataSampleList::on_some_list ( const DataSampleElement *  iter )

static

Definition at line 26 of file InstanceDataSampleList.cpp.

References OpenDDS::DCPS::DataSampleElement::handle_, head_, OpenDDS::DCPS::DataSampleElement::next_instance_sample_, OpenDDS::DCPS::DataSampleElement::previous_instance_sample_, and OpenDDS::DCPS::PublicationInstance::samples_.

Referenced by OpenDDS::DCPS::WriteDataContainer::data_delivered(), and OpenDDS::DCPS::WriteDataContainer::data_dropped().

{
  return iter->next_instance_sample_ || iter->previous_instance_sample_
    || (iter->handle_ && iter->handle_->samples_.head_ == iter);
}

prev()

ACE_INLINE DataSampleElement * OpenDDS::DCPS::InstanceDataSampleList::prev ( const DataSampleElement *  iter )

static

Definition at line 61 of file InstanceDataSampleList.inl.

References ACE_INLINE, and OpenDDS::DCPS::DataSampleElement::previous_instance_sample_.

Referenced by OpenDDS::DCPS::WriteDataContainer::remove_excess_durable().

{
  return iter->previous_instance_sample_;
}

reset()

ACE_INLINE void OpenDDS::DCPS::InstanceDataSampleList::reset

(

void

)

Reset to initial state.

Definition at line 25 of file InstanceDataSampleList.inl.

References ACE_INLINE, head_, size_, and tail_.

{
  head_ = tail_ = 0;
  size_ = 0;
}

size()

ACE_INLINE ssize_t OpenDDS::DCPS::InstanceDataSampleList::size

(

void

)

const

Definition at line 33 of file InstanceDataSampleList.inl.

References ACE_INLINE, and size_.

Referenced by OpenDDS::DCPS::WriteDataContainer::num_samples(), and OpenDDS::DCPS::WriteDataContainer::remove_instance().

{
  return size_;
}

tail()

ACE_INLINE DataSampleElement * OpenDDS::DCPS::InstanceDataSampleList::tail

(

void

)

const

Definition at line 47 of file InstanceDataSampleList.inl.

References ACE_INLINE, and tail_.

Referenced by OpenDDS::DCPS::WriteDataContainer::remove_excess_durable().

{
  return tail_;
}

Member Data Documentation

head_

DataSampleElement* OpenDDS::DCPS::InstanceDataSampleList::head_

protected

The first element of the list.

Definition at line 60 of file InstanceDataSampleList.h.

Referenced by dequeue(), dequeue_head(), enqueue_tail(), head(), on_some_list(), and reset().

size_

ssize_t OpenDDS::DCPS::InstanceDataSampleList::size_

protected

Number of elements in the list.

Definition at line 66 of file InstanceDataSampleList.h.

Referenced by dequeue(), dequeue_head(), enqueue_tail(), reset(), and size().

tail_

DataSampleElement* OpenDDS::DCPS::InstanceDataSampleList::tail_

protected

The last element of the list.

Definition at line 63 of file InstanceDataSampleList.h.

Referenced by dequeue(), dequeue_head(), enqueue_tail(), reset(), and tail().

---

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

• InstanceDataSampleList.h
• InstanceDataSampleList.cpp
• InstanceDataSampleList.inl