OpenDDS::DCPS::InternalDataReader< T >::Instance Class Reference

Collaboration diagram for OpenDDS::DCPS::InternalDataReader< T >::Instance:

Classes
struct	SampleHolder

Public Member Functions
	Instance ()
DDS::ViewStateKind	view_state () const
DDS::InstanceStateKind	instance_state () const
void	purge_samples (const DDS::DataReaderQos &qos)
bool	can_purge_instance (const DDS::DataReaderQos &qos) const
void	read (const T &key, SampleSequence &samples, InternalSampleInfoSequence &infos, CORBA::Long max_samples, DDS::SampleStateMask sample_states, DDS::ViewStateMask view_states, DDS::InstanceStateMask instance_states)
void	take (const T &key, SampleSequence &samples, InternalSampleInfoSequence &infos, CORBA::Long max_samples, DDS::SampleStateMask sample_states, DDS::ViewStateMask view_states, DDS::InstanceStateMask instance_states)
void	write (InternalEntity_wrch publication_handle, const T &sample, const DDS::DataReaderQos &qos)
bool	dispose (InternalEntity_wrch publication_handle, const DDS::DataReaderQos &qos)
bool	unregister_instance (InternalEntity_wrch publication_handle, const DDS::DataReaderQos &qos)

Private Member Functions
typedef	OPENDDS_LIST (SampleHolder) SampleList
void	compute_ranks (CORBA::Long sample_count, InternalSampleInfoSequence &infos)

Private Attributes
SampleList	read_samples_
SampleList	not_read_samples_
PublicationSet	publication_set_
DDS::ViewStateKind	view_state_
DDS::InstanceStateKind	instance_state_
DDS::Time_t	disposed_expiration_date_
DDS::Time_t	no_writers_expiration_date_
CORBA::Long	disposed_generation_count_
CORBA::Long	no_writers_generation_count_
bool	informed_of_not_alive_

Detailed Description

template<typename T>
class OpenDDS::DCPS::InternalDataReader< T >::Instance

Definition at line 297 of file InternalDataReader.h.

Constructor & Destructor Documentation

Instance()

template<typename T>

OpenDDS::DCPS::InternalDataReader< T >::Instance::Instance ( )

inline

Definition at line 300 of file InternalDataReader.h.

      : view_state_(DDS::NEW_VIEW_STATE)
      , instance_state_(DDS::ALIVE_INSTANCE_STATE)
      , disposed_generation_count_(0)
      , no_writers_generation_count_(0)
      , informed_of_not_alive_(false)
    {
      disposed_expiration_date_.sec = 0;
      disposed_expiration_date_.nanosec = 0;
      no_writers_expiration_date_.sec = 0;
      no_writers_expiration_date_.nanosec = 0;
    }

Member Function Documentation

can_purge_instance()

template<typename T>

bool OpenDDS::DCPS::InternalDataReader< T >::Instance::can_purge_instance ( const DDS::DataReaderQos &  qos ) const

inline

Definition at line 327 of file InternalDataReader.h.

References DDS::ALIVE_INSTANCE_STATE, DDS::ReaderDataLifecycleQosPolicy::autopurge_nowriter_samples_delay, OpenDDS::DCPS::is_infinite(), DDS::NOT_ALIVE_NO_WRITERS_INSTANCE_STATE, OpenDDS::DCPS::TimePoint_T< SystemClock >::now(), DDS::DataReaderQos::reader_data_lifecycle, and OpenDDS::DCPS::TimePoint_T< AceClock >::to_dds_time().

    {
      if (instance_state_ != DDS::ALIVE_INSTANCE_STATE &&
          not_read_samples_.empty() &&
          read_samples_.empty() &&
          publication_set_.empty()) {
        return true;
      }

      if (instance_state_ == DDS::NOT_ALIVE_NO_WRITERS_INSTANCE_STATE &&
          !is_infinite(qos.reader_data_lifecycle.autopurge_nowriter_samples_delay) &&
          SystemTimePoint::now().to_dds_time() > no_writers_expiration_date_) {
        return true;
      }

      return false;
    }

compute_ranks()

template<typename T>

void OpenDDS::DCPS::InternalDataReader< T >::Instance::compute_ranks ( CORBA::Long  sample_count, InternalSampleInfoSequence &  infos  )

inlineprivate

Definition at line 544 of file InternalDataReader.h.

References OPENDDS_MAP_T.

    {
      if (sample_count == 0) {
        return;
      }

      typename InternalSampleInfoSequence::reverse_iterator pos = infos.rbegin();
      const CORBA::Long mrsic = pos->disposed_generation_count + pos->no_writers_generation_count;
      const CORBA::Long mrs = disposed_generation_count_ + no_writers_generation_count_;

      for (CORBA::Long rank = 0; rank != sample_count; ++rank, ++pos) {
        pos->sample_rank = rank;
        pos->generation_rank = mrsic - (pos->disposed_generation_count + pos->no_writers_generation_count);
        pos->absolute_generation_rank = mrs - (pos->disposed_generation_count + pos->no_writers_generation_count);
      }
    }

dispose()

template<typename T>

bool OpenDDS::DCPS::InternalDataReader< T >::Instance::dispose ( InternalEntity_wrch  publication_handle, const DDS::DataReaderQos &  qos  )

inline

Definition at line 485 of file InternalDataReader.h.

References DDS::ReaderDataLifecycleQosPolicy::autopurge_disposed_samples_delay, DDS::NOT_ALIVE_DISPOSED_INSTANCE_STATE, OpenDDS::DCPS::TimePoint_T< SystemClock >::now(), DDS::DataReaderQos::reader_data_lifecycle, and OpenDDS::DCPS::TimePoint_T< AceClock >::to_dds_time().

    {
      publication_set_.insert(publication_handle);

      if (instance_state_ != DDS::NOT_ALIVE_DISPOSED_INSTANCE_STATE) {
        instance_state_ = DDS::NOT_ALIVE_DISPOSED_INSTANCE_STATE;
        disposed_expiration_date_ = SystemTimePoint::now().to_dds_time() + qos.reader_data_lifecycle.autopurge_disposed_samples_delay;
        informed_of_not_alive_ = false;
        return true;
      }

      return false;
    }

instance_state()

template<typename T>

DDS::InstanceStateKind OpenDDS::DCPS::InternalDataReader< T >::Instance::instance_state ( ) const

inline

Definition at line 315 of file InternalDataReader.h.

{ return instance_state_; }

OPENDDS_LIST()

template<typename T>

typedef OpenDDS::DCPS::InternalDataReader< T >::Instance::OPENDDS_LIST ( SampleHolder  )

private

purge_samples()

template<typename T>

void OpenDDS::DCPS::InternalDataReader< T >::Instance::purge_samples ( const DDS::DataReaderQos &  qos )

inline

Definition at line 317 of file InternalDataReader.h.

References DDS::ReaderDataLifecycleQosPolicy::autopurge_disposed_samples_delay, OpenDDS::DCPS::is_infinite(), DDS::NOT_ALIVE_DISPOSED_INSTANCE_STATE, OpenDDS::DCPS::TimePoint_T< SystemClock >::now(), DDS::DataReaderQos::reader_data_lifecycle, and OpenDDS::DCPS::TimePoint_T< AceClock >::to_dds_time().

    {
      if (instance_state_ == DDS::NOT_ALIVE_DISPOSED_INSTANCE_STATE &&
          !is_infinite(qos.reader_data_lifecycle.autopurge_disposed_samples_delay) &&
          SystemTimePoint::now().to_dds_time() > disposed_expiration_date_) {
        not_read_samples_.clear();
        read_samples_.clear();
      }
    }

read()

template<typename T>

void OpenDDS::DCPS::InternalDataReader< T >::Instance::read ( const T &  key, SampleSequence &  samples, InternalSampleInfoSequence &  infos, CORBA::Long  max_samples, DDS::SampleStateMask  sample_states, DDS::ViewStateMask  view_states, DDS::InstanceStateMask  instance_states  )

inline

Definition at line 345 of file InternalDataReader.h.

References DDS::ALIVE_INSTANCE_STATE, DDS::LENGTH_UNLIMITED, OpenDDS::DCPS::make_sample_info(), max_samples, DDS::NOT_NEW_VIEW_STATE, DDS::NOT_READ_SAMPLE_STATE, and DDS::READ_SAMPLE_STATE.

    {
      if (!((view_states & view_state_) && (instance_states & instance_state_))) {
        return;
      }

      CORBA::Long sample_count = 0;

      if (sample_states & DDS::READ_SAMPLE_STATE) {
        for (typename SampleList::const_iterator pos = read_samples_.begin(), limit = read_samples_.end();
             pos != limit && (max_samples == DDS::LENGTH_UNLIMITED || sample_count < max_samples); ++pos) {
          samples.push_back(pos->sample);
          infos.push_back(make_sample_info(DDS::READ_SAMPLE_STATE, view_state_, instance_state_, pos->disposed_generation_count, pos->no_writers_generation_count, 0, 0, 0, true));
          ++sample_count;
        }
      }

      if (sample_states & DDS::NOT_READ_SAMPLE_STATE) {
        typename SampleList::iterator pos = not_read_samples_.begin();
        for (typename SampleList::iterator limit = not_read_samples_.end();
             pos != limit && (max_samples == DDS::LENGTH_UNLIMITED || sample_count < max_samples); ++pos) {
          samples.push_back(pos->sample);
          infos.push_back(make_sample_info(DDS::NOT_READ_SAMPLE_STATE, view_state_, instance_state_, pos->disposed_generation_count, pos->no_writers_generation_count, 0, 0, 0, true));
          ++sample_count;
        }
        read_samples_.splice(read_samples_.end(), not_read_samples_, not_read_samples_.begin(), pos);

        // Generate a synthetic sample for not alive states.
        if (sample_count == 0 &&
            instance_state_ != DDS::ALIVE_INSTANCE_STATE &&
            !informed_of_not_alive_) {
          samples.push_back(key);
          infos.push_back(make_sample_info(DDS::NOT_READ_SAMPLE_STATE, view_state_, instance_state_, disposed_generation_count_, no_writers_generation_count_, 0, 0, 0, false));
          ++sample_count;
        }
      }

      compute_ranks(sample_count, infos);

      if (sample_count) {
        view_state_ = DDS::NOT_NEW_VIEW_STATE;
        informed_of_not_alive_ = true;
      }
    }

take()

template<typename T>

void OpenDDS::DCPS::InternalDataReader< T >::Instance::take ( const T &  key, SampleSequence &  samples, InternalSampleInfoSequence &  infos, CORBA::Long  max_samples, DDS::SampleStateMask  sample_states, DDS::ViewStateMask  view_states, DDS::InstanceStateMask  instance_states  )

inline

Definition at line 396 of file InternalDataReader.h.

References DDS::ALIVE_INSTANCE_STATE, DDS::LENGTH_UNLIMITED, OpenDDS::DCPS::make_sample_info(), max_samples, DDS::NOT_NEW_VIEW_STATE, DDS::NOT_READ_SAMPLE_STATE, and DDS::READ_SAMPLE_STATE.

    {
      if (!((view_states & view_state_) && (instance_states & instance_state_))) {
        return;
      }

      CORBA::Long sample_count = 0;

      if (sample_states & DDS::READ_SAMPLE_STATE) {
        typename SampleList::iterator pos = read_samples_.begin();
        for (typename SampleList::iterator limit = read_samples_.end();
             pos != limit && (max_samples == DDS::LENGTH_UNLIMITED || sample_count < max_samples); ++pos) {
          samples.push_back(pos->sample);
          infos.push_back(make_sample_info(DDS::READ_SAMPLE_STATE, view_state_, instance_state_, pos->disposed_generation_count, pos->no_writers_generation_count, 0, 0, 0, true));
          ++sample_count;
        }
        read_samples_.erase(read_samples_.begin(), pos);
      }

      if (sample_states & DDS::NOT_READ_SAMPLE_STATE) {
        typename SampleList::iterator pos = not_read_samples_.begin();
        for (typename SampleList::iterator limit = not_read_samples_.end();
             pos != limit && (max_samples == DDS::LENGTH_UNLIMITED || sample_count < max_samples); ++pos) {
          samples.push_back(pos->sample);
          infos.push_back(make_sample_info(DDS::NOT_READ_SAMPLE_STATE, view_state_, instance_state_, pos->disposed_generation_count, pos->no_writers_generation_count, 0, 0, 0, true));
          ++sample_count;
        }
        not_read_samples_.erase(not_read_samples_.begin(), pos);

        // Generate a synthetic sample for not alive states.
        if (sample_count == 0 &&
            instance_state_ != DDS::ALIVE_INSTANCE_STATE &&
            !informed_of_not_alive_) {
          samples.push_back(key);
          infos.push_back(make_sample_info(DDS::NOT_READ_SAMPLE_STATE, view_state_, instance_state_, disposed_generation_count_, no_writers_generation_count_, 0, 0, 0, false));
          ++sample_count;
        }
      }

      compute_ranks(sample_count, infos);

      if (sample_count) {
        view_state_ = DDS::NOT_NEW_VIEW_STATE;
        informed_of_not_alive_ = true;
      }
    }

unregister_instance()

template<typename T>

bool OpenDDS::DCPS::InternalDataReader< T >::Instance::unregister_instance ( InternalEntity_wrch  publication_handle, const DDS::DataReaderQos &  qos  )

inline

Definition at line 500 of file InternalDataReader.h.

References DDS::ALIVE_INSTANCE_STATE, DDS::ReaderDataLifecycleQosPolicy::autopurge_nowriter_samples_delay, DDS::NOT_ALIVE_NO_WRITERS_INSTANCE_STATE, OpenDDS::DCPS::TimePoint_T< SystemClock >::now(), DDS::DataReaderQos::reader_data_lifecycle, and OpenDDS::DCPS::TimePoint_T< AceClock >::to_dds_time().

    {
      publication_set_.erase(publication_handle);

      if (publication_set_.empty() && instance_state_ == DDS::ALIVE_INSTANCE_STATE) {
        instance_state_ = DDS::NOT_ALIVE_NO_WRITERS_INSTANCE_STATE;
        no_writers_expiration_date_ = SystemTimePoint::now().to_dds_time() + qos.reader_data_lifecycle.autopurge_nowriter_samples_delay;
        informed_of_not_alive_ = false;
        return true;
      }

      return false;
    }

view_state()

template<typename T>

DDS::ViewStateKind OpenDDS::DCPS::InternalDataReader< T >::Instance::view_state ( ) const

inline

Definition at line 313 of file InternalDataReader.h.

{ return view_state_; }

write()

template<typename T>

void OpenDDS::DCPS::InternalDataReader< T >::Instance::write ( InternalEntity_wrch  publication_handle, const T &  sample, const DDS::DataReaderQos &  qos  )

inline

Definition at line 449 of file InternalDataReader.h.

References DDS::ALIVE_INSTANCE_STATE, DDS::HistoryQosPolicy::depth, DDS::DataReaderQos::history, DDS::KEEP_LAST_HISTORY_QOS, DDS::HistoryQosPolicy::kind, DDS::NEW_VIEW_STATE, DDS::NOT_ALIVE_DISPOSED_INSTANCE_STATE, DDS::NOT_ALIVE_NO_WRITERS_INSTANCE_STATE, and DDS::NOT_NEW_VIEW_STATE.

    {
      publication_set_.insert(publication_handle);

      if (view_state_ == DDS::NOT_NEW_VIEW_STATE && instance_state_ != DDS::ALIVE_INSTANCE_STATE) {
        view_state_ = DDS::NEW_VIEW_STATE;
      }

      switch (instance_state_) {
      case DDS::ALIVE_INSTANCE_STATE:
        break;
      case DDS::NOT_ALIVE_DISPOSED_INSTANCE_STATE:
        ++disposed_generation_count_;
        break;
      case DDS::NOT_ALIVE_NO_WRITERS_INSTANCE_STATE:
        ++no_writers_generation_count_;
        break;
      }

      instance_state_ = DDS::ALIVE_INSTANCE_STATE;

      if (qos.history.kind == DDS::KEEP_LAST_HISTORY_QOS) {
        while (read_samples_.size() + not_read_samples_.size() >= static_cast<size_t>(qos.history.depth)) {
          if (!read_samples_.empty()) {
            read_samples_.pop_front();
          } else {
            not_read_samples_.pop_front();
          }
        }
      }

      not_read_samples_.push_back(SampleHolder(sample, disposed_generation_count_, no_writers_generation_count_));
    }

Member Data Documentation

disposed_expiration_date_

template<typename T>

DDS::Time_t OpenDDS::DCPS::InternalDataReader< T >::Instance::disposed_expiration_date_

private

Definition at line 538 of file InternalDataReader.h.

disposed_generation_count_

template<typename T>

CORBA::Long OpenDDS::DCPS::InternalDataReader< T >::Instance::disposed_generation_count_

private

Definition at line 540 of file InternalDataReader.h.

informed_of_not_alive_

template<typename T>

bool OpenDDS::DCPS::InternalDataReader< T >::Instance::informed_of_not_alive_

private

Definition at line 542 of file InternalDataReader.h.

instance_state_

template<typename T>

DDS::InstanceStateKind OpenDDS::DCPS::InternalDataReader< T >::Instance::instance_state_

private

Definition at line 537 of file InternalDataReader.h.

no_writers_expiration_date_

template<typename T>

DDS::Time_t OpenDDS::DCPS::InternalDataReader< T >::Instance::no_writers_expiration_date_

private

Definition at line 539 of file InternalDataReader.h.

no_writers_generation_count_

template<typename T>

CORBA::Long OpenDDS::DCPS::InternalDataReader< T >::Instance::no_writers_generation_count_

private

Definition at line 541 of file InternalDataReader.h.

not_read_samples_

template<typename T>

SampleList OpenDDS::DCPS::InternalDataReader< T >::Instance::not_read_samples_

private

Definition at line 532 of file InternalDataReader.h.

publication_set_

template<typename T>

PublicationSet OpenDDS::DCPS::InternalDataReader< T >::Instance::publication_set_

private

Definition at line 534 of file InternalDataReader.h.

read_samples_

template<typename T>

SampleList OpenDDS::DCPS::InternalDataReader< T >::Instance::read_samples_

private

Definition at line 531 of file InternalDataReader.h.

view_state_

template<typename T>

DDS::ViewStateKind OpenDDS::DCPS::InternalDataReader< T >::Instance::view_state_

private

Definition at line 536 of file InternalDataReader.h.

---

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

• InternalDataReader.h