OpenDDS::DCPS::ReceivedDataSample Class Reference

Holds a data sample received by the transport. More...

#include <ReceivedDataSample.h>

Collaboration diagram for OpenDDS::DCPS::ReceivedDataSample:

[legend]List of all members.

Public Member Functions
	ReceivedDataSample (ACE_Message_Block *payload)
	ReceivedDataSample (const ReceivedDataSample &)
ReceivedDataSample &	operator= (const ReceivedDataSample &)
	~ReceivedDataSample ()
Public Attributes
DataSampleHeader	header_
	The demarshalled sample header.
ACE_Message_Block *	sample_
	The "data" part (ie, no "header" part) of the sample.

---

Detailed Description

Holds a data sample received by the transport.

This is the type of object that is delivered to the TransportReceiveListener objects by the transport. Note that the data sample header has already been demarshalled by the transport, and the ACE_Message_Block (chain) represents the "data" portion of the sample.

Definition at line 32 of file ReceivedDataSample.h.

---

Constructor & Destructor Documentation

ACE_INLINE OpenDDS::DCPS::ReceivedDataSample::ReceivedDataSample

(

ACE_Message_Block *

payload

)

[explicit]

Definition at line 15 of file ReceivedDataSample.inl.

References DBG_ENTRY_LVL.

  : sample_(payload)
{
  DBG_ENTRY_LVL("ReceivedDataSample", "ReceivedDataSample",6);
}

ACE_INLINE OpenDDS::DCPS::ReceivedDataSample::ReceivedDataSample

(

const ReceivedDataSample &

)

Definition at line 22 of file ReceivedDataSample.inl.

References DBG_ENTRY_LVL.

  : header_(other.header_)
  , sample_(ACE_Message_Block::duplicate(other.sample_))
{
  DBG_ENTRY_LVL("ReceivedDataSample", "ReceivedDataSample(copy)", 6);
}

ACE_INLINE OpenDDS::DCPS::ReceivedDataSample::~ReceivedDataSample

(

)

Definition at line 39 of file ReceivedDataSample.inl.

References DBG_ENTRY_LVL, and sample_.

{
  DBG_ENTRY_LVL("ReceivedDataSample", "~ReceivedDataSample", 6);

  // Release the sample_ (ACE_Message_Block chain) back to its allocator.
  if (this->sample_ != 0) {
    this->sample_->release();
  }
}

---

Member Function Documentation

ACE_INLINE ReceivedDataSample & OpenDDS::DCPS::ReceivedDataSample::operator=

(

const ReceivedDataSample &

)

Definition at line 30 of file ReceivedDataSample.inl.

References DBG_ENTRY_LVL, and OpenDDS::DCPS::swap().

{
  DBG_ENTRY_LVL("ReceivedDataSample", "operator=", 6);
  ReceivedDataSample cpy(other);
  swap(*this, cpy);
  return *this;
}

---

Member Data Documentation

DataSampleHeader OpenDDS::DCPS::ReceivedDataSample::header_

The demarshalled sample header.

Definition at line 43 of file ReceivedDataSample.h.

Referenced by OpenDDS::DCPS::DataReaderImpl::check_historic(), OpenDDS::RTPS::Sedp::Reader::data_received(), OpenDDS::DCPS::RecorderImpl::data_received(), OpenDDS::DCPS::DataReaderImpl::data_received(), OpenDDS::DCPS::DataLink::data_received_i(), OpenDDS::DCPS::DataReaderImpl_T< MessageType >::dds_demarshal(), OpenDDS::RTPS::decode_parameter_list(), OpenDDS::DCPS::DataReaderImpl::deliver_historic(), OpenDDS::DCPS::UdpReceiveStrategy::deliver_sample(), OpenDDS::DCPS::TcpReceiveStrategy::deliver_sample(), OpenDDS::DCPS::ShmemReceiveStrategy::deliver_sample(), OpenDDS::DCPS::RtpsUdpReceiveStrategy::deliver_sample(), OpenDDS::DCPS::DataReaderImpl_T< MessageType >::dispose_unregister(), OpenDDS::DCPS::TransportReassembly::insert(), OpenDDS::DCPS::RtpsSampleHeader::into_received_data_sample(), OpenDDS::DCPS::DataSampleHeader::into_received_data_sample(), OpenDDS::DCPS::DataReaderImpl_T< MessageType >::lookup_instance(), OpenDDS::DCPS::DataReaderImpl::process_latency(), OpenDDS::DCPS::ReliableSession::ready_to_deliver(), OpenDDS::DCPS::RtpsUdpReceiveStrategy::reassemble(), OpenDDS::DCPS::TransportReassembly::reassemble_i(), OpenDDS::DCPS::MulticastDataLink::sample_received(), and OpenDDS::DCPS::swap().

ACE_Message_Block* OpenDDS::DCPS::ReceivedDataSample::sample_

The "data" part (ie, no "header" part) of the sample.

Definition at line 46 of file ReceivedDataSample.h.

Referenced by OpenDDS::DCPS::UdpDataLink::control_received(), OpenDDS::RTPS::Sedp::Reader::data_received(), OpenDDS::DCPS::RecorderImpl::data_received(), OpenDDS::DCPS::ReceiveListenerSet::data_received(), OpenDDS::DCPS::DataReaderImpl::data_received(), OpenDDS::DCPS::DataReaderImpl_T< MessageType >::dds_demarshal(), OpenDDS::DCPS::TransportReassembly::insert(), OpenDDS::DCPS::RtpsSampleHeader::into_received_data_sample(), OpenDDS::DCPS::DataReaderImpl_T< MessageType >::lookup_instance(), OpenDDS::DCPS::RtpsUdpReceiveStrategy::reassemble(), OpenDDS::DCPS::TransportReassembly::reassemble_i(), OpenDDS::DCPS::MulticastDataLink::sample_received(), OpenDDS::DCPS::swap(), and ~ReceivedDataSample().

---

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

• ReceivedDataSample.h
• ReceivedDataSample.inl

---