OpenDDS::DCPS::SendStateDataSampleList Class Reference

#include <SendStateDataSampleList.h>

Collaboration diagram for OpenDDS::DCPS::SendStateDataSampleList:

Public Types
typedef SendStateDataSampleListIterator	iterator
	STL-style bidirectional iterator and const-iterator types. More...
typedef SendStateDataSampleListConstIterator	const_iterator
typedef std::reverse_iterator< iterator >	reverse_iterator
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator

Public Member Functions
	SendStateDataSampleList ()
	Default constructor clears the list. More...
	~SendStateDataSampleList ()
void	reset ()
	Reset to initial state. More...
ssize_t	size () const
DataSampleElement *	head () const
DataSampleElement *	tail () const
void	enqueue_head (const DataSampleElement *element)
void	enqueue_tail (const DataSampleElement *element)
void	enqueue_tail (SendStateDataSampleList list)
bool	dequeue_head (DataSampleElement *&stale)
bool	dequeue (const DataSampleElement *stale)
iterator	begin ()
	Return iterator to beginning of list. More...
const_iterator	begin () const
iterator	end ()
	Return iterator to end of list. More...
const_iterator	end () const
reverse_iterator	rbegin ()
const_reverse_iterator	rbegin () const
reverse_iterator	rend ()
const_reverse_iterator	rend () const

Static Public Member Functions
template<size_t N>
static const SendStateDataSampleList *	send_list_containing_element (const DataSampleElement *element, SendStateDataSampleList *(&send_lists)[N])
static void	remove (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...

Static Private Member Functions
static const SendStateDataSampleList *	send_list_containing_element (const DataSampleElement *element, SendStateDataSampleList **begin, SendStateDataSampleList **end)

Friends
class	::DDS_TEST

Detailed Description

A list of DataSampleElement pointers to be queued by the order the samples are to be transmitted over the transport layer. Cache the number of elements in the list so that list traversal is not required to find this information. The Publisher may use this to maintain a list of samples to be sent with PRESENTATION.access_scope==GROUP by obtaining data from each DataWriter as it becomes available and concatenating the data in the order in which it was written. Manages DataSampleElement's previous_send_sample/next_send_sample pointers

Definition at line 153 of file SendStateDataSampleList.h.

Member Typedef Documentation

const_iterator

typedef SendStateDataSampleListConstIterator OpenDDS::DCPS::SendStateDataSampleList::const_iterator

Definition at line 166 of file SendStateDataSampleList.h.

const_reverse_iterator

typedef std::reverse_iterator<const_iterator> OpenDDS::DCPS::SendStateDataSampleList::const_reverse_iterator

Definition at line 169 of file SendStateDataSampleList.h.

iterator

typedef SendStateDataSampleListIterator OpenDDS::DCPS::SendStateDataSampleList::iterator

STL-style bidirectional iterator and const-iterator types.

Definition at line 165 of file SendStateDataSampleList.h.

reverse_iterator

typedef std::reverse_iterator<iterator> OpenDDS::DCPS::SendStateDataSampleList::reverse_iterator

Definition at line 168 of file SendStateDataSampleList.h.

Constructor & Destructor Documentation

SendStateDataSampleList()

ACE_INLINE OpenDDS::DCPS::SendStateDataSampleList::SendStateDataSampleList

(

)

Default constructor clears the list.

Definition at line 18 of file SendStateDataSampleList.inl.

References ACE_INLINE.

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

~SendStateDataSampleList()

OpenDDS::DCPS::SendStateDataSampleList::~SendStateDataSampleList ( )

inline

Definition at line 173 of file SendStateDataSampleList.h.

{}

Member Function Documentation

begin() [1/2]

ACE_INLINE SendStateDataSampleList::iterator OpenDDS::DCPS::SendStateDataSampleList::begin

(

void

)

Return iterator to beginning of list.

Definition at line 144 of file SendStateDataSampleList.inl.

References ACE_INLINE, head_, and tail_.

Referenced by OpenDDS::DCPS::DataWriterImpl::association_complete_i(), OpenDDS::DCPS::WriteDataContainer::get_unsent_data(), OpenDDS::DCPS::DataDurabilityCache::insert(), OpenDDS::DCPS::WriteDataContainer::reenqueue_all(), rend(), and OpenDDS::DCPS::DataWriterImpl::replay_durable_data_for().

{
  return iterator(this->head_, this->tail_, this->head_);
}

begin() [2/2]

ACE_INLINE SendStateDataSampleList::const_iterator OpenDDS::DCPS::SendStateDataSampleList::begin

(

void

)

const

Definition at line 158 of file SendStateDataSampleList.inl.

References ACE_INLINE, head_, and tail_.

{
  return const_iterator(this->head_, this->tail_, this->head_);
}

dequeue()

bool OpenDDS::DCPS::SendStateDataSampleList::dequeue

(

const DataSampleElement *

stale

)

Definition at line 47 of file SendStateDataSampleList.cpp.

References dequeue_head(), head_, OpenDDS::DCPS::DataSampleElement::next_send_sample_, OpenDDS::DCPS::DataSampleElement::previous_send_sample_, size_, and tail_.

Referenced by OpenDDS::DCPS::WriteDataContainer::data_delivered(), OpenDDS::DCPS::WriteDataContainer::data_dropped(), OpenDDS::DCPS::WriteDataContainer::remove_excess_durable(), OpenDDS::DCPS::WriteDataContainer::remove_oldest_sample(), and OpenDDS::DCPS::ReplayerImpl::write().

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

  // Same as dequeue from head.
  if (stale == head_) {
    DataSampleElement* tmp = head_;
    return dequeue_head(tmp);
  }

  // Search from head_->next_send_sample_.
  DataSampleElement* toRemove = 0;
  for (DataSampleElement* item = head_->next_send_sample_;
       item != 0 && toRemove == 0;
       item = item->next_send_sample_) {
    if (item == stale) {
      toRemove = item;
    }
  }

  if (toRemove) {
    --size_;
    // Remove from the previous element.
    toRemove->previous_send_sample_->next_send_sample_ = toRemove->next_send_sample_;

    // Remove from the next element.
    if (toRemove->next_send_sample_ != 0) {
      // Remove from the inside of the list.
      toRemove->next_send_sample_->previous_send_sample_ = toRemove->previous_send_sample_;

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

    toRemove->next_send_sample_ = 0;
    toRemove->previous_send_sample_ = 0;
  }

  return toRemove != 0;
}

dequeue_head()

ACE_INLINE bool OpenDDS::DCPS::SendStateDataSampleList::dequeue_head

(

DataSampleElement *&

stale

)

Definition at line 101 of file SendStateDataSampleList.inl.

References ACE_INLINE, head_, OpenDDS::DCPS::DataSampleElement::next_send_sample_, OpenDDS::DCPS::DataSampleElement::previous_send_sample_, size_, and tail_.

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

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

  if (head_ == 0) {
    return false;

  } else {
    --size_;

    head_ = head_->next_send_sample_;

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

    } else {
      head_->previous_send_sample_ = 0;
    }

    stale->next_send_sample_ = 0;
    stale->previous_send_sample_ = 0;

    return true;
  }
}

end() [1/2]

ACE_INLINE SendStateDataSampleList::iterator OpenDDS::DCPS::SendStateDataSampleList::end

(

void

)

Return iterator to end of list.

Definition at line 151 of file SendStateDataSampleList.inl.

References ACE_INLINE, head_, and tail_.

Referenced by OpenDDS::DCPS::DataWriterImpl::association_complete_i(), OpenDDS::DCPS::WriteDataContainer::get_unsent_data(), OpenDDS::DCPS::DataDurabilityCache::insert(), rbegin(), OpenDDS::DCPS::WriteDataContainer::reenqueue_all(), OpenDDS::DCPS::DataWriterImpl::replay_durable_data_for(), and send_list_containing_element().

{
  return iterator(this->head_, this->tail_, 0);
}

end() [2/2]

ACE_INLINE SendStateDataSampleList::const_iterator OpenDDS::DCPS::SendStateDataSampleList::end

(

void

)

const

Definition at line 165 of file SendStateDataSampleList.inl.

References ACE_INLINE, head_, and tail_.

{
  return const_iterator(this->head_, this->tail_, 0);
}

enqueue_head()

ACE_INLINE void OpenDDS::DCPS::SendStateDataSampleList::enqueue_head

(

const DataSampleElement *

element

)

Definition at line 55 of file SendStateDataSampleList.inl.

References ACE_INLINE, head_, OpenDDS::DCPS::DataSampleElement::next_send_sample_, OpenDDS::DCPS::DataSampleElement::previous_send_sample_, size_, and tail_.

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

{
  ++size_;

  // 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);

  if (head_ == 0) {
    head_ = tail_ = mSample;
    sample->next_send_sample_ = sample->previous_send_sample_ = 0;

  } else {
    sample->next_send_sample_ = head_;
    sample->previous_send_sample_ = 0;
    head_->previous_send_sample_ = mSample;
    head_ = mSample;
  }
}

enqueue_tail() [1/2]

ACE_INLINE void OpenDDS::DCPS::SendStateDataSampleList::enqueue_tail

(

const DataSampleElement *

element

)

Definition at line 78 of file SendStateDataSampleList.inl.

References ACE_INLINE, head_, OpenDDS::DCPS::DataSampleElement::next_send_sample_, OpenDDS::DCPS::DataSampleElement::previous_send_sample_, size_, and tail_.

Referenced by OpenDDS::DCPS::DataWriterImpl::association_complete_i(), OpenDDS::DCPS::WriteDataContainer::data_delivered(), OpenDDS::DCPS::WriteDataContainer::data_dropped(), OpenDDS::DCPS::WriteDataContainer::enqueue(), OpenDDS::DCPS::WriteDataContainer::enqueue_control(), OpenDDS::DCPS::WriteDataContainer::get_unsent_data(), OpenDDS::DCPS::DataWriterImpl::replay_durable_data_for(), OpenDDS::RTPS::Sedp::Writer::send_sample_i(), OpenDDS::DCPS::ReplayerImpl::write(), and OpenDDS::DCPS::DataWriterImpl::write().

{
  ++size_;

  // 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);

  if (head_ == 0) {
    head_ = tail_ = mSample;
    sample->next_send_sample_ = sample->previous_send_sample_ = 0;

  } else {
    sample->previous_send_sample_ = tail_;
    sample->next_send_sample_ = 0;
    tail_->next_send_sample_ = mSample;
    tail_ = mSample;
  }
}

enqueue_tail() [2/2]

void OpenDDS::DCPS::SendStateDataSampleList::enqueue_tail

(

SendStateDataSampleList

list

)

Definition at line 92 of file SendStateDataSampleList.cpp.

References head_, OpenDDS::DCPS::DataSampleElement::next_send_sample_, OpenDDS::DCPS::DataSampleElement::previous_send_sample_, size_, and tail_.

{
  if (head_ == 0) {
    head_ = list.head_;
    tail_ = list.tail_;
    size_ = list.size_;

  } else {
    tail_->next_send_sample_ = list.head_;
    list.head_->previous_send_sample_ = tail_;
    tail_ = list.tail_;
    size_ = size_ + list.size_;
  }
}

head()

ACE_INLINE DataSampleElement * OpenDDS::DCPS::SendStateDataSampleList::head

(

void

)

const

Definition at line 41 of file SendStateDataSampleList.inl.

References ACE_INLINE, and head_.

Referenced by OpenDDS::DCPS::TransportClient::send(), OpenDDS::DCPS::TransportClient::send_i(), send_list_containing_element(), and OpenDDS::DCPS::TransportClient::send_w_control().

{
  return head_;
}

rbegin() [1/2]

ACE_INLINE SendStateDataSampleList::reverse_iterator OpenDDS::DCPS::SendStateDataSampleList::rbegin

(

void

)

Definition at line 172 of file SendStateDataSampleList.inl.

References ACE_INLINE, and end().

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

{
  return reverse_iterator(end());
}

rbegin() [2/2]

ACE_INLINE SendStateDataSampleList::const_reverse_iterator OpenDDS::DCPS::SendStateDataSampleList::rbegin

(

void

)

const

Definition at line 186 of file SendStateDataSampleList.inl.

References ACE_INLINE, and end().

{
  return const_reverse_iterator(end());
}

remove()

ACE_INLINE void OpenDDS::DCPS::SendStateDataSampleList::remove ( DataSampleElement *  stale )

static

Remove from whichever list "stale" belongs to, without needing a reference to the SendStateDataSampleList object itself. That SendStateDataSampleList is no longer accurate and can't be used.

Definition at line 132 of file SendStateDataSampleList.inl.

References ACE_INLINE, OpenDDS::DCPS::DataSampleElement::next_send_sample_, and OpenDDS::DCPS::DataSampleElement::previous_send_sample_.

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

{
  if (stale->previous_send_sample_) {
    stale->previous_send_sample_->next_send_sample_ = stale->next_send_sample_;
  }
  if (stale->next_send_sample_) {
    stale->next_send_sample_->previous_send_sample_ = stale->previous_send_sample_;
  }
}

rend() [1/2]

ACE_INLINE SendStateDataSampleList::reverse_iterator OpenDDS::DCPS::SendStateDataSampleList::rend

(

void

)

Definition at line 179 of file SendStateDataSampleList.inl.

References ACE_INLINE, and begin().

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

{
  return reverse_iterator(begin());
}

rend() [2/2]

ACE_INLINE SendStateDataSampleList::const_reverse_iterator OpenDDS::DCPS::SendStateDataSampleList::rend

(

void

)

const

Definition at line 193 of file SendStateDataSampleList.inl.

References begin(), and OPENDDS_END_VERSIONED_NAMESPACE_DECL.

{
  return const_reverse_iterator(begin());
}

reset()

ACE_INLINE void OpenDDS::DCPS::SendStateDataSampleList::reset

(

void

)

Reset to initial state.

Definition at line 26 of file SendStateDataSampleList.inl.

References ACE_INLINE, head_, size_, and tail_.

Referenced by OpenDDS::DCPS::WriteDataContainer::get_resend_data(), OpenDDS::DCPS::WriteDataContainer::get_unsent_data(), and OpenDDS::DCPS::DataWriterImpl::send_suspended_data().

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

send_list_containing_element() [1/2]

const SendStateDataSampleList * OpenDDS::DCPS::SendStateDataSampleList::send_list_containing_element ( const DataSampleElement *  element, SendStateDataSampleList **  begin, SendStateDataSampleList **  end  )

staticprivate

Definition at line 27 of file SendStateDataSampleList.cpp.

References end(), head(), and OpenDDS::DCPS::DataSampleElement::previous_send_sample_.

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

{
  const DataSampleElement* head = element;

  while (head->previous_send_sample_ != 0) {
    head = head->previous_send_sample_;
  }

  for (SendStateDataSampleList** it = begin; it != end; ++it) {
    if ((*it)->head_ == head) {
      return *it;
    }
  }
  return 0;
}

send_list_containing_element() [2/2]

template<size_t N>

static const SendStateDataSampleList* OpenDDS::DCPS::SendStateDataSampleList::send_list_containing_element ( const DataSampleElement *  element, SendStateDataSampleList *(&)  send_lists[N]  )

inlinestatic

Returns a pointer to the SendStateDataSampleList containing a given DataSampleElement for use in the typical situation where the send state of a DataSampleElement is tracked by shifting it between distinct SendStateDataSampleLists, one for each state

Definition at line 181 of file SendStateDataSampleList.h.

  {
    return send_list_containing_element(element,
                                        &send_lists[0], &send_lists[N]);
  }

size()

ACE_INLINE ssize_t OpenDDS::DCPS::SendStateDataSampleList::size

(

void

)

const

Definition at line 34 of file SendStateDataSampleList.inl.

References ACE_INLINE, and size_.

Referenced by OpenDDS::DCPS::DataDurabilityCache::insert(), OpenDDS::DCPS::WriteDataContainer::log_send_state_lists(), OpenDDS::DCPS::WriteDataContainer::pending_data(), OpenDDS::DCPS::WriteDataContainer::reenqueue_all(), and OpenDDS::DCPS::WriteDataContainer::~WriteDataContainer().

{
  return size_;
}

tail()

ACE_INLINE DataSampleElement * OpenDDS::DCPS::SendStateDataSampleList::tail

(

void

)

const

Definition at line 48 of file SendStateDataSampleList.inl.

References ACE_INLINE, and tail_.

Referenced by OpenDDS::DCPS::TransportClient::send_i().

{
  return tail_;
}

Friends And Related Function Documentation

::DDS_TEST

friend class ::DDS_TEST

friend

Definition at line 155 of file SendStateDataSampleList.h.

Member Data Documentation

head_

DataSampleElement* OpenDDS::DCPS::SendStateDataSampleList::head_

protected

The first element of the list.

Definition at line 225 of file SendStateDataSampleList.h.

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

size_

ssize_t OpenDDS::DCPS::SendStateDataSampleList::size_

protected

Number of elements in the list.

Definition at line 231 of file SendStateDataSampleList.h.

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

tail_

DataSampleElement* OpenDDS::DCPS::SendStateDataSampleList::tail_

protected

The last element of the list.

Definition at line 228 of file SendStateDataSampleList.h.

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

---

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

• SendStateDataSampleList.h
• SendStateDataSampleList.cpp
• SendStateDataSampleList.inl