OpenDDS::DCPS::WriterDataSampleList Class Reference

#include <WriterDataSampleList.h>

Collaboration diagram for OpenDDS::DCPS::WriterDataSampleList:

Public Member Functions
	WriterDataSampleList ()
	Default constructor clears the list. More...
	~WriterDataSampleList ()
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)

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 DataWriter (within PRESENTATION.access_scope==TOPIC). Cache the number of elements in the list so that list traversal is not required to find this information. Manages DataSampleElement's previous_writer_sample/next_writer_sample pointers

Definition at line 29 of file WriterDataSampleList.h.

Constructor & Destructor Documentation

WriterDataSampleList()

ACE_INLINE OpenDDS::DCPS::WriterDataSampleList::WriterDataSampleList

(

)

Default constructor clears the list.

Definition at line 18 of file WriterDataSampleList.inl.

References ACE_INLINE.

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

~WriterDataSampleList()

OpenDDS::DCPS::WriterDataSampleList::~WriterDataSampleList ( )

inline

Definition at line 34 of file WriterDataSampleList.h.

{}

Member Function Documentation

dequeue()

bool OpenDDS::DCPS::WriterDataSampleList::dequeue

(

const DataSampleElement *

stale

)

Definition at line 22 of file WriterDataSampleList.cpp.

References dequeue_head(), head(), head_, OpenDDS::DCPS::DataSampleElement::next_writer_sample_, OPENDDS_END_VERSIONED_NAMESPACE_DECL, OpenDDS::DCPS::DataSampleElement::previous_writer_sample_, size_, and tail_.

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

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

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

  // Search from head_->next_writer_sample_.
  bool found = false;

  for (DataSampleElement* item = head_->next_writer_sample_;
       item != 0;
       item = item->next_writer_sample_) {
    if (item == stale) {
      found = true;
      break;
    }
  }

  if (found) {
    // Adjust list size.
    -- size_ ;

    //
    // Remove from the previous element.
    //
    stale->previous_writer_sample_->next_writer_sample_ = stale->next_writer_sample_ ;

    //
    // Remove from the next element.
    //
    if (stale->next_writer_sample_ != 0) {
      // Remove the inside of the list.
      stale->next_writer_sample_->previous_writer_sample_ = stale->previous_writer_sample_ ;

    } else {
      // Remove from the tail of the list.
      tail_ = stale->previous_writer_sample_ ;
    }

    stale->next_writer_sample_ = 0;
    stale->previous_writer_sample_ = 0;
  }

  return found;
}

dequeue_head()

ACE_INLINE bool OpenDDS::DCPS::WriterDataSampleList::dequeue_head

(

DataSampleElement *&

stale

)

Definition at line 81 of file WriterDataSampleList.inl.

References head_, OpenDDS::DCPS::DataSampleElement::next_writer_sample_, OPENDDS_END_VERSIONED_NAMESPACE_DECL, OpenDDS::DCPS::DataSampleElement::previous_writer_sample_, size_, and tail_.

Referenced by dequeue().

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

  if (head_ == 0) {
    return false;

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

    if (head_ == 0) {
      tail_ = 0;

    } else {
      head_->previous_writer_sample_ = 0;
    }

    stale->next_writer_sample_ = 0;
    stale->previous_writer_sample_ = 0;
    return true;
  }
}

enqueue_tail()

ACE_INLINE void OpenDDS::DCPS::WriterDataSampleList::enqueue_tail

(

const DataSampleElement *

element

)

Definition at line 55 of file WriterDataSampleList.inl.

References ACE_INLINE, head_, OpenDDS::DCPS::DataSampleElement::next_writer_sample_, OpenDDS::DCPS::DataSampleElement::previous_writer_sample_, size_, and tail_.

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

{
  // 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_writer_sample_ = 0;

  ++size_ ;

  if (head_ == 0) {
    // First sample in the list.
    head_ = tail_ = mSample ;
    mSample->previous_writer_sample_ = 0;

  } else {
    // Add to existing list.
    tail_->next_writer_sample_ = mSample ;
    mSample->previous_writer_sample_ = tail_;
    tail_ = mSample;
  }
}

head()

ACE_INLINE DataSampleElement * OpenDDS::DCPS::WriterDataSampleList::head

(

void

)

const

Definition at line 41 of file WriterDataSampleList.inl.

References ACE_INLINE, and head_.

Referenced by dequeue().

{
  return head_;
}

reset()

ACE_INLINE void OpenDDS::DCPS::WriterDataSampleList::reset

(

void

)

Reset to initial state.

Definition at line 26 of file WriterDataSampleList.inl.

References ACE_INLINE, head_, size_, and tail_.

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

size()

ACE_INLINE ssize_t OpenDDS::DCPS::WriterDataSampleList::size

(

void

)

const

Definition at line 34 of file WriterDataSampleList.inl.

References ACE_INLINE, and size_.

{
  return size_;
}

tail()

ACE_INLINE DataSampleElement * OpenDDS::DCPS::WriterDataSampleList::tail

(

void

)

const

Definition at line 48 of file WriterDataSampleList.inl.

References ACE_INLINE, and tail_.

{
  return tail_;
}

Member Data Documentation

head_

DataSampleElement* OpenDDS::DCPS::WriterDataSampleList::head_

protected

The first element of the list.

Definition at line 52 of file WriterDataSampleList.h.

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

size_

ssize_t OpenDDS::DCPS::WriterDataSampleList::size_

protected

Number of elements in the list.

Definition at line 58 of file WriterDataSampleList.h.

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

tail_

DataSampleElement* OpenDDS::DCPS::WriterDataSampleList::tail_

protected

The last element of the list.

Definition at line 55 of file WriterDataSampleList.h.

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

---

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

• WriterDataSampleList.h
• WriterDataSampleList.cpp
• WriterDataSampleList.inl