OpenDDS::DCPS::DataSampleHeader Struct Reference

#include <DataSampleHeader.h>

Inheritance diagram for OpenDDS::DCPS::DataSampleHeader:

Collaboration diagram for OpenDDS::DCPS::DataSampleHeader:

Classes
struct	MaybeGuard

Public Types
enum	{ MESSAGE_ID_OFFSET = 0, SUBMESSAGE_ID_OFFSET = 1, FLAGS_OFFSET = 2 }

Public Member Functions
	DataSampleHeader ()
	DataSampleHeader (ACE_Message_Block &buffer)
	Construct with values extracted from a buffer. More...
DataSampleHeader &	operator= (ACE_Message_Block &buffer)
	Assignment from an ACE_Message_Block. More...
size_t	get_serialized_size () const
	Amount of data read when initializing from a buffer. More...
void	init (ACE_Message_Block *buffer)
	Implement load from buffer. More...
bool	into_received_data_sample (ReceivedDataSample &rds)
ACE_UINT32	message_length () const
bool	more_fragments () const
void	pdu_remaining (size_t)
bool	valid_data () const
	Returns true if the sample has a complete serialized payload. More...
DDS::InstanceStateKind	instance_state () const

Static Public Member Functions
static ACE_UINT8	mask_flag (DataSampleHeaderFlag flag)
static ACE_UINT8	mask_flag (DataSampleHeaderFlag2 flag)
static void	clear_flag (DataSampleHeaderFlag flag, ACE_Message_Block *buffer)
static void	set_flag (DataSampleHeaderFlag flag, ACE_Message_Block *buffer)
static bool	test_flag (DataSampleHeaderFlag flag, const ACE_Message_Block *buffer)
static bool	partial (const ACE_Message_Block &mb)
	Does the data in this mb constitute a partial Sample Header? More...
static void	add_cfentries (const GUIDSeq *guids, ACE_Message_Block *mb)
static void	split (const ACE_Message_Block &orig, size_t size, Message_Block_Ptr &head, Message_Block_Ptr &tail)
static bool	join (const DataSampleHeader &first, const DataSampleHeader &second, DataSampleHeader &result)
static size_t	get_max_serialized_size ()
	Similar to IDL compiler generated methods. More...
static ACE_Message_Block *	alloc_msgblock (const ACE_Message_Block &mb, size_t size, bool use_data_alloc)
static void	split_payload (const ACE_Message_Block &orig, size_t size, Message_Block_Ptr &head, Message_Block_Ptr &tail)

Public Attributes
char	message_id_
	The enum MessageId. More...
char	submessage_id_
	Implementation-specific sub-message Ids. More...
bool	byte_order_: 1
bool	coherent_change_: 1
bool	historic_sample_: 1
bool	lifespan_duration_: 1
bool	group_coherent_: 1
bool	content_filter_: 1
bool	sequence_repair_: 1
bool	more_fragments_: 1
	The current "Data Sample" needs reassembly before further processing. More...
bool	cdr_encapsulation_: 1
bool	key_fields_only_: 1
	Only the key fields of the data sample are present in the payload. More...
bool	reserved_1: 1
bool	reserved_2: 1
bool	reserved_3: 1
bool	reserved_4: 1
bool	reserved_5: 1
bool	reserved_6: 1
ACE_UINT32	message_length_
SequenceNumber	sequence_
ACE_INT32	source_timestamp_sec_
ACE_UINT32	source_timestamp_nanosec_
ACE_INT32	lifespan_duration_sec_
ACE_UINT32	lifespan_duration_nanosec_
GUID_t	publication_id_
GUID_t	publisher_id_
GUIDSeq	content_filter_entries_

Private Attributes
size_t	serialized_size_
	Keep track of the amount of data read from a buffer. More...

Detailed Description

The header message of a data sample. This header and the data sample are in different message block and will be chained together.

Definition at line 79 of file DataSampleHeader.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
MESSAGE_ID_OFFSET
SUBMESSAGE_ID_OFFSET
FLAGS_OFFSET

Definition at line 80 of file DataSampleHeader.h.

       {
    MESSAGE_ID_OFFSET = 0,
    SUBMESSAGE_ID_OFFSET = 1,
    FLAGS_OFFSET = 2 // message_id_ + submessage_id_
  };

Constructor & Destructor Documentation

DataSampleHeader() [1/2]

ACE_INLINE OpenDDS::DCPS::DataSampleHeader::DataSampleHeader

(

)

Definition at line 9 of file DataSampleHeader.inl.

References ACE_CDR_BYTE_ORDER, and ACE_INLINE.

  : message_id_(0)
  , submessage_id_(0)
  , byte_order_(ACE_CDR_BYTE_ORDER)
  , coherent_change_(0)
  , historic_sample_(0)
  , lifespan_duration_(0)
  , group_coherent_(0)
  , content_filter_(0)
  , sequence_repair_(0)
  , more_fragments_(0)
  , cdr_encapsulation_(0)
  , key_fields_only_(0)
  , reserved_1(0)
  , reserved_2(0)
  , reserved_3(0)
  , reserved_4(0)
  , reserved_5(0)
  , reserved_6(0)
  , message_length_(0)
  , sequence_()
  , source_timestamp_sec_(0)
  , source_timestamp_nanosec_(0)
  , lifespan_duration_sec_(0)
  , lifespan_duration_nanosec_(0)
  , publication_id_(GUID_UNKNOWN)
  , publisher_id_(GUID_UNKNOWN)
  , serialized_size_(0)
{
}

DataSampleHeader() [2/2]

ACE_INLINE OpenDDS::DCPS::DataSampleHeader::DataSampleHeader ( ACE_Message_Block &  buffer )

explicit

Construct with values extracted from a buffer.

Definition at line 41 of file DataSampleHeader.inl.

References ACE_CDR_BYTE_ORDER, ACE_INLINE, and init().

  : message_id_(0)
  , submessage_id_(0)
  , byte_order_(ACE_CDR_BYTE_ORDER)
  , coherent_change_(0)
  , historic_sample_(0)
  , lifespan_duration_(0)
  , group_coherent_(0)
  , content_filter_(0)
  , sequence_repair_(0)
  , more_fragments_(0)
  , cdr_encapsulation_(0)
  , key_fields_only_(0)
  , reserved_1(0)
  , reserved_2(0)
  , reserved_3(0)
  , reserved_4(0)
  , reserved_5(0)
  , reserved_6(0)
  , message_length_(0)
  , sequence_()
  , source_timestamp_sec_(0)
  , source_timestamp_nanosec_(0)
  , lifespan_duration_sec_(0)
  , lifespan_duration_nanosec_(0)
  , publication_id_(GUID_UNKNOWN)
  , publisher_id_(GUID_UNKNOWN)
{
  this->init(&buffer);
}

Member Function Documentation

add_cfentries()

void OpenDDS::DCPS::DataSampleHeader::add_cfentries ( const GUIDSeq *  guids, ACE_Message_Block *  mb  )

static

Marshal the "guids" as an optional header chained as to the continuation of "mb" (which must already be a valid DataSampleHeader serialization). Any existing payload of "mb" (its continuation) will be chained after the new optional header part. "guids" may be null, same serialization as 0.

Definition at line 331 of file DataSampleHeader.cpp.

References ACE_CDR_BYTE_ORDER, alloc_msgblock(), OpenDDS::DCPS::BYTE_ORDER_FLAG, ACE_Message_Block::cont(), OpenDDS::STUN::encoding(), OpenDDS::DCPS::int32_cdr_size, OpenDDS::DCPS::serialized_size(), and test_flag().

Referenced by OpenDDS::DCPS::DataLinkSet::send(), and split().

{
  Encoding encoding(encoding_kind,
    ACE_CDR_BYTE_ORDER != test_flag(BYTE_ORDER_FLAG, mb));
  size_t size = 0;
  if (guids) {
    serialized_size(encoding, size, *guids);
  } else {
    size = int32_cdr_size;
  }
  ACE_Message_Block* optHdr = alloc_msgblock(*mb, size, false);

  Serializer ser(optHdr, encoding);
  if (guids) {
    ser << *guids;
  } else {
    ser << CORBA::ULong(0);
  }

  // New chain: mb (DataSampleHeader), optHdr (GUIDSeq), data (Foo or control)
  optHdr->cont(mb->cont());
  mb->cont(optHdr);
}

alloc_msgblock()

ACE_Message_Block * OpenDDS::DCPS::DataSampleHeader::alloc_msgblock ( const ACE_Message_Block &  mb, size_t  size, bool  use_data_alloc  )

static

Definition at line 90 of file DataSampleHeader.cpp.

References ACE_Message_Block::access_allocators(), ACE_DEFAULT_MESSAGE_BLOCK_PRIORITY, ACE_NEW_MALLOC_RETURN, OpenDDS::RTPS::DATA, ACE_Message_Block::locking_strategy(), malloc(), ACE_Time_Value::max_time, ACE_Message_Block::MB_DATA, and ACE_Time_Value::zero.

Referenced by add_cfentries(), and split().

{
  enum { DATA, DB, MB, N_ALLOC };
  ACE_Allocator* allocators[N_ALLOC];
  // It's an ACE bug that access_allocators isn't const
  ACE_Message_Block& mut_mb = const_cast<ACE_Message_Block&>(mb);
  mut_mb.access_allocators(allocators[DATA], allocators[DB], allocators[MB]);
  if (allocators[MB]) {
    ACE_Message_Block* result;
    ACE_NEW_MALLOC_RETURN(result,
      static_cast<ACE_Message_Block*>(
        allocators[MB]->malloc(sizeof(ACE_Message_Block))),
      ACE_Message_Block(size,
                        ACE_Message_Block::MB_DATA,
                        0, // cont
                        0, // data
                        use_data_alloc ? allocators[DATA] : 0,
                        mut_mb.locking_strategy(), // locking_strategy
                        ACE_DEFAULT_MESSAGE_BLOCK_PRIORITY,
                        ACE_Time_Value::zero,
                        ACE_Time_Value::max_time,
                        allocators[DB],
                        allocators[MB]),
      0);
    return result;
  } else {
    return new ACE_Message_Block(size,
                                  ACE_Message_Block::MB_DATA,
                                  0, // cont
                                  0, // data
                                  use_data_alloc ? allocators[DATA] : 0,
                                  mut_mb.locking_strategy(), // locking_strategy
                                  ACE_DEFAULT_MESSAGE_BLOCK_PRIORITY,
                                  ACE_Time_Value::zero,
                                  ACE_Time_Value::max_time,
                                  allocators[DB]);
  }
}

clear_flag()

ACE_INLINE void OpenDDS::DCPS::DataSampleHeader::clear_flag ( DataSampleHeaderFlag  flag, ACE_Message_Block *  buffer  )

static

The clear_flag and set_flag methods are a hack to update the header flags after a sample has been serialized without deserializing the entire message. This method will break if the current Serializer behavior changes.

Definition at line 111 of file DataSampleHeader.inl.

References ACE_ERROR, ACE_INLINE, ACE_TEXT(), ACE_Message_Block::base(), ACE_Message_Block::end(), FLAGS_OFFSET, LM_ERROR, ACE_Message_Block::locking_strategy(), and mask_flag().

{
  char* base = buffer->base();

  // verify sufficient length exists:
  if (static_cast<size_t>(buffer->end() - base) < FLAGS_OFFSET + 1) {
    ACE_ERROR((LM_ERROR,
               ACE_TEXT("(%P|%t) ERROR: DataSampleHeader::clear_flag: ")
               ACE_TEXT("ACE_Message_Block too short (missing flags octet).\n")));
    return;
  }

  MaybeGuard g(buffer->locking_strategy());
  base[FLAGS_OFFSET] &= ~mask_flag(flag);
}

get_max_serialized_size()

ACE_INLINE size_t OpenDDS::DCPS::DataSampleHeader::get_max_serialized_size ( )

static

Similar to IDL compiler generated methods.

Definition at line 87 of file DataSampleHeader.inl.

References ACE_INLINE.

Referenced by OpenDDS::DCPS::DataLink::create_control(), OpenDDS::DCPS::DataWriterImpl::create_control_message(), OpenDDS::DCPS::ReplayerImpl::create_sample_data_message(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), OpenDDS::RTPS::Sedp::Writer::end_historic_samples(), OpenDDS::DCPS::UdpDataLink::open(), partial(), OpenDDS::RTPS::Sedp::Writer::request_ack(), OpenDDS::DCPS::TcpDataLink::request_ack_received(), OpenDDS::DCPS::TransportSendStrategy::send(), OpenDDS::DCPS::ShmemDataLink::send_association_msg(), OpenDDS::DCPS::TcpDataLink::send_association_msg(), OpenDDS::DCPS::TcpDataLink::send_graceful_disconnect_message(), OpenDDS::RTPS::Sedp::TypeLookupReplyWriter::send_type_lookup_reply(), OpenDDS::RTPS::Sedp::TypeLookupRequestWriter::send_type_lookup_request(), split(), OpenDDS::RTPS::Sedp::Writer::write_parameter_list(), OpenDDS::RTPS::Sedp::LivelinessWriter::write_participant_message(), OpenDDS::RTPS::Sedp::SecurityWriter::write_stateless_message(), OpenDDS::RTPS::Sedp::DiscoveryWriter::write_unregister_dispose(), and OpenDDS::RTPS::Sedp::SecurityWriter::write_volatile_message_secure().

{
  return 1 + // message_id_;
         1 + // submessage_id_;
         2 + // flags
         4 + // message_length_;
         8 + // sequence_;
         4 + // source_timestamp_sec_;
         4 + // source_timestamp_nanosec_;
         4 + // lifespan_duration_sec_;
         4 + // lifespan_duration_nanosec_;
        16 + // publication_id_;
        16 ; // publisher_id_;
  // content_filter_entries_ is not marsahled into the same Data Block
  // so it is not part of the max_serialized_size() which is used to allocate
}

get_serialized_size()

ACE_INLINE size_t OpenDDS::DCPS::DataSampleHeader::get_serialized_size

(

)

const

Amount of data read when initializing from a buffer.

Definition at line 81 of file DataSampleHeader.inl.

References ACE_INLINE, and serialized_size_.

{
  return serialized_size_;
}

init()

void OpenDDS::DCPS::DataSampleHeader::init

(

ACE_Message_Block *

buffer

)

Implement load from buffer.

Definition at line 180 of file DataSampleHeader.cpp.

References ACE_CDR_BYTE_ORDER, OpenDDS::DCPS::byte_cdr_size, byte_order_, OpenDDS::DCPS::BYTE_ORDER_FLAG, OpenDDS::DCPS::CDR_ENCAP_FLAG, cdr_encapsulation_, coherent_change_, OpenDDS::DCPS::COHERENT_CHANGE_FLAG, content_filter_, content_filter_entries_, OpenDDS::DCPS::CONTENT_FILTER_FLAG, OpenDDS::STUN::encoding(), group_coherent_, OpenDDS::DCPS::GROUP_COHERENT_FLAG, historic_sample_, OpenDDS::DCPS::HISTORIC_SAMPLE_FLAG, key_fields_only_, OpenDDS::DCPS::KEY_ONLY_FLAG, lifespan_duration_, OpenDDS::DCPS::LIFESPAN_DURATION_FLAG, lifespan_duration_nanosec_, lifespan_duration_sec_, mask_flag(), message_id_, message_length_, more_fragments_, OpenDDS::DCPS::MORE_FRAGMENTS_FLAG, publication_id_, publisher_id_, sequence_, sequence_repair_, OpenDDS::DCPS::SEQUENCE_REPAIR_FLAG, OpenDDS::DCPS::serialized_size(), serialized_size_, source_timestamp_nanosec_, source_timestamp_sec_, submessage_id_, and OpenDDS::DCPS::Serializer::swap_bytes().

Referenced by DataSampleHeader(), and operator=().

{
  Encoding encoding(encoding_kind);
  Serializer reader(buffer, encoding);
  serialized_size_ = 0;

  // Only byte-sized reads until we get the byte_order_ flag.

  if (!(reader >> this->message_id_)) {
    return;
  }
  serialized_size_ += byte_cdr_size;

  if (!(reader >> this->submessage_id_)) {
    return;
  }
  serialized_size_ += byte_cdr_size;

  // Extract the flag values.
  ACE_CDR::Octet byte;
  if (!(reader >> ACE_InputCDR::to_octet(byte))) {
    return;
  }
  serialized_size_ += byte_cdr_size;

  this->byte_order_         = byte & mask_flag(BYTE_ORDER_FLAG);
  this->coherent_change_    = byte & mask_flag(COHERENT_CHANGE_FLAG);
  this->historic_sample_    = byte & mask_flag(HISTORIC_SAMPLE_FLAG);
  this->lifespan_duration_  = byte & mask_flag(LIFESPAN_DURATION_FLAG);
  this->group_coherent_     = byte & mask_flag(GROUP_COHERENT_FLAG);
  this->content_filter_     = byte & mask_flag(CONTENT_FILTER_FLAG);
  this->sequence_repair_    = byte & mask_flag(SEQUENCE_REPAIR_FLAG);
  this->more_fragments_     = byte & mask_flag(MORE_FRAGMENTS_FLAG);

  // Set swap_bytes flag to the Serializer if data sample from
  // the publisher is in different byte order.
  reader.swap_bytes(this->byte_order_ != ACE_CDR_BYTE_ORDER);

  if (!(reader >> ACE_InputCDR::to_octet(byte))) {
    return;
  }
  serialized_size_ += sizeof(byte);
  this->cdr_encapsulation_ = byte & mask_flag(CDR_ENCAP_FLAG);
  this->key_fields_only_   = byte & mask_flag(KEY_ONLY_FLAG);

  if (!(reader >> this->message_length_)) {
    return;
  }
  serialized_size_ += sizeof(message_length_);

  if (!(reader >> this->sequence_)) {
    return;
  }
  serialized_size(encoding, serialized_size_, sequence_);

  if (!(reader >> this->source_timestamp_sec_)) {
    return;
  }
  serialized_size_ += sizeof(source_timestamp_sec_);

  if (!(reader >> this->source_timestamp_nanosec_)) {
    return;
  }
  serialized_size_ += sizeof(source_timestamp_nanosec_);

  if (this->lifespan_duration_) {
    if (!(reader >> this->lifespan_duration_sec_)) {
      return;
    }
    serialized_size_ += sizeof(lifespan_duration_sec_);

    if (!(reader >> this->lifespan_duration_nanosec_)) {
      return;
    }
    serialized_size_ += sizeof(lifespan_duration_nanosec_);
  }

  if (!(reader >> this->publication_id_)) {
    return;
  }
  serialized_size(encoding, serialized_size_, publication_id_);

#ifndef OPENDDS_NO_OBJECT_MODEL_PROFILE
  if (this->group_coherent_) {
    if (!(reader >> this->publisher_id_)) {
      return;
    }
    serialized_size(encoding, serialized_size_, publisher_id_);
  }
#endif

  if (this->content_filter_) {
    if (!(reader >> this->content_filter_entries_)) {
      return;
    }
    serialized_size(encoding, serialized_size_, content_filter_entries_);
  }
}

instance_state()

DDS::InstanceStateKind OpenDDS::DCPS::DataSampleHeader::instance_state ( ) const

inline

Definition at line 254 of file DataSampleHeader.h.

References DDS::ALIVE_INSTANCE_STATE, OpenDDS::DCPS::DISPOSE_INSTANCE, OpenDDS::DCPS::DISPOSE_UNREGISTER_INSTANCE, DDS::NOT_ALIVE_DISPOSED_INSTANCE_STATE, DDS::NOT_ALIVE_NO_WRITERS_INSTANCE_STATE, and OpenDDS::DCPS::UNREGISTER_INSTANCE.

Referenced by OpenDDS::DCPS::DataReaderImpl::data_received(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::store_synthetic_data(), and OpenDDS::DCPS::DataWriterImpl::write().

  {
    switch (message_id_) {
    case UNREGISTER_INSTANCE:
      return DDS::NOT_ALIVE_NO_WRITERS_INSTANCE_STATE;
    case DISPOSE_INSTANCE:
    case DISPOSE_UNREGISTER_INSTANCE:
      return DDS::NOT_ALIVE_DISPOSED_INSTANCE_STATE;
    default:
      return DDS::ALIVE_INSTANCE_STATE;
    }
  }

into_received_data_sample()

bool OpenDDS::DCPS::DataSampleHeader::into_received_data_sample

(

ReceivedDataSample &

rds

)

Definition at line 693 of file DataSampleHeader.cpp.

References OpenDDS::DCPS::ReceivedDataSample::header_, OpenDDS::DCPS::DataSampleHeader::MaybeGuard::non_lock, and OPENDDS_END_VERSIONED_NAMESPACE_DECL.

{
  rds.header_ = *this;
  return true;
}

join()

bool OpenDDS::DCPS::DataSampleHeader::join ( const DataSampleHeader &  first, const DataSampleHeader &  second, DataSampleHeader &  result  )

static

If "first" and "second" are two fragments of the same original message (as created by split()), return true and set up the "result" header to match the original header. Joining the data payload is the responsibility of the caller (manipulate the continuation chain).

Definition at line 454 of file DataSampleHeader.cpp.

References content_filter_, content_filter_entries_, message_length_, more_fragments_, and sequence_.

Referenced by OpenDDS::DCPS::TransportReassembly::FragInfo::insert().

{
  if (!first.more_fragments_ || first.sequence_ != second.sequence_) {
    return false;
  }
  result = second;
  result.message_length_ += first.message_length_;
  if (first.content_filter_) {
    result.content_filter_ = true;
    const CORBA::ULong entries = first.content_filter_entries_.length();
    CORBA::ULong x = result.content_filter_entries_.length();
    result.content_filter_entries_.length(x + entries);
    for (CORBA::ULong i(entries); i > 0;) {
      result.content_filter_entries_[x++] = first.content_filter_entries_[--i];
    }
  }
  return true;
}

mask_flag() [1/2]

static ACE_UINT8 OpenDDS::DCPS::DataSampleHeader::mask_flag ( DataSampleHeaderFlag  flag )

inlinestatic

Definition at line 187 of file DataSampleHeader.h.

Referenced by clear_flag(), init(), partial(), set_flag(), and test_flag().

{ return 1 << flag; }

mask_flag() [2/2]

static ACE_UINT8 OpenDDS::DCPS::DataSampleHeader::mask_flag ( DataSampleHeaderFlag2  flag )

inlinestatic

Definition at line 188 of file DataSampleHeader.h.

References init().

{ return 1 << flag; }

message_length()

ACE_UINT32 OpenDDS::DCPS::DataSampleHeader::message_length ( void  ) const

inline

Definition at line 239 of file DataSampleHeader.h.

{ return this->message_length_; }

more_fragments()

bool OpenDDS::DCPS::DataSampleHeader::more_fragments ( void  ) const

inline

Definition at line 241 of file DataSampleHeader.h.

{ return this->more_fragments_; }

operator=()

ACE_INLINE OpenDDS::DCPS::DataSampleHeader & OpenDDS::DCPS::DataSampleHeader::operator=

(

ACE_Message_Block &

buffer

)

Assignment from an ACE_Message_Block.

Definition at line 74 of file DataSampleHeader.inl.

References ACE_INLINE, and init().

{
  this->init(&buffer);
  return *this;
}

partial()

bool OpenDDS::DCPS::DataSampleHeader::partial ( const ACE_Message_Block &  mb )

static

Does the data in this mb constitute a partial Sample Header?

Definition at line 130 of file DataSampleHeader.cpp.

References OpenDDS::DCPS::BYTE_ORDER_FLAG, OpenDDS::DCPS::CONTENT_FILTER_FLAG, OpenDDS::STUN::encoding(), OpenDDS::DCPS::Encoding::endianness(), FLAGS_OFFSET, get_max_serialized_size(), OpenDDS::DCPS::GROUP_COHERENT_FLAG, OpenDDS::DCPS::guid_cdr_size, OpenDDS::DCPS::int32_cdr_size, OpenDDS::DCPS::LIFESPAN_DURATION_FLAG, mask_flag(), OpenDDS::DCPS::MESSAGE_ID_MAX, MESSAGE_ID_OFFSET, OpenDDS::DCPS::SUBMESSAGE_ID_MAX, SUBMESSAGE_ID_OFFSET, and ACE_Message_Block::total_length().

{
  static const unsigned int LIFESPAN_MASK = mask_flag(LIFESPAN_DURATION_FLAG),
    LIFESPAN_LENGTH = 8,
    COHERENT_MASK = mask_flag(GROUP_COHERENT_FLAG),
    COHERENT_LENGTH = 16,
    CONTENT_FILT_MASK = mask_flag(CONTENT_FILTER_FLAG),
    BYTE_ORDER_MASK = mask_flag(BYTE_ORDER_FLAG);

  const size_t len = mb.total_length();

  if (len <= FLAGS_OFFSET) return true;

  Encoding encoding(encoding_kind);
  unsigned char msg_id;
  if (!mb_peek(msg_id, mb, MESSAGE_ID_OFFSET, encoding)
      || int(msg_id) >= MESSAGE_ID_MAX) {
    // This check, and the similar one below for submessage id, are actually
    // indicating an invalid header (and not a partial header) but we can
    // treat it the same as partial for the sake of the TransportRecvStrategy.
    return true;
  }

  if (!mb_peek(msg_id, mb, SUBMESSAGE_ID_OFFSET, encoding)
      || int(msg_id) >= SUBMESSAGE_ID_MAX) {
    return true;
  }

  char flags;
  if (!mb_peek(flags, mb, FLAGS_OFFSET, encoding)) {
    return true;
  }

  size_t expected = get_max_serialized_size();
  if (!(flags & LIFESPAN_MASK)) expected -= LIFESPAN_LENGTH;
  if (!(flags & COHERENT_MASK)) expected -= COHERENT_LENGTH;

  if (flags & CONTENT_FILT_MASK) {
    CORBA::ULong seqLen;
    encoding.endianness(static_cast<Endianness>(flags & BYTE_ORDER_MASK));
    if (!mb_peek(seqLen, mb, expected, encoding)) {
      return true;
    }
    expected += int32_cdr_size + guid_cdr_size * seqLen;
  }

  return len < expected;
}

pdu_remaining()

void OpenDDS::DCPS::DataSampleHeader::pdu_remaining ( size_t  )

inline

Definition at line 243 of file DataSampleHeader.h.

{ /* ignored, only RTPS uses this */ }

set_flag()

ACE_INLINE void OpenDDS::DCPS::DataSampleHeader::set_flag ( DataSampleHeaderFlag  flag, ACE_Message_Block *  buffer  )

static

Definition at line 130 of file DataSampleHeader.inl.

References ACE_ERROR, ACE_INLINE, ACE_TEXT(), ACE_Message_Block::base(), ACE_Message_Block::end(), FLAGS_OFFSET, LM_ERROR, ACE_Message_Block::locking_strategy(), and mask_flag().

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

{
  char* base = buffer->base();

  // verify sufficient length exists:
  if (static_cast<size_t>(buffer->end() - base) < FLAGS_OFFSET + 1) {
    ACE_ERROR((LM_ERROR,
               ACE_TEXT("(%P|%t) ERROR: DataSampleHeader::set_flag: ")
               ACE_TEXT("ACE_Message_Block too short (missing flags octet).\n")));
    return;
  }

  MaybeGuard g(buffer->locking_strategy());
  base[FLAGS_OFFSET] |= mask_flag(flag);
}

split()

void OpenDDS::DCPS::DataSampleHeader::split ( const ACE_Message_Block &  orig, size_t  size, Message_Block_Ptr &  head, Message_Block_Ptr &  tail  )

static

Create two new serialized headers (owned by caller), the "head" having at most "size" bytes (header + data) and the "tail" having the rest.

Definition at line 382 of file DataSampleHeader.cpp.

References add_cfentries(), alloc_msgblock(), ACE_Message_Block::cont(), dup(), ACE_Message_Block::duplicate(), OpenDDS::STUN::encoding(), OpenDDS::DCPS::unique_ptr< T, Deleter >::get(), get_max_serialized_size(), OpenDDS::DCPS::guid_cdr_size, ACE_Message_Block::length(), message_length_, more_fragments_, OpenDDS::DCPS::unique_ptr< T, Deleter >::release(), OpenDDS::DCPS::unique_ptr< T, Deleter >::reset(), split_payload(), and ACE_Message_Block::total_length().

Referenced by OpenDDS::DCPS::TransportQueueElement::fragment().

{
  Message_Block_Ptr dup (orig.duplicate());
  const Encoding encoding(encoding_kind);

  const size_t length = dup->total_length();
  DataSampleHeader hdr(*dup); // deserialize entire header (with cfentries)
  const size_t hdr_len = length - dup->total_length();
  const size_t this_max_serialized_size = get_max_serialized_size();

  ACE_Message_Block* payload = dup.get();
  //skip zero length message blocks
  ACE_Message_Block* prev = 0;
  for (; payload->length() == 0; payload = payload->cont()) {
    prev = payload;
  }
  prev->cont(0);
  Message_Block_Ptr payload_head(payload);

  if (size < hdr_len) { // need to fragment the content_filter_entries_
    head.reset(alloc_msgblock(*dup, this_max_serialized_size, true));
    hdr.more_fragments_ = true;
    hdr.message_length_ = 0; // no room for payload data
    *head << hdr;
    const size_t avail = size - head->length() - 4 /* sequence length */;
    const CORBA::ULong n_entries = static_cast<CORBA::ULong>(avail / guid_cdr_size);
    GUIDSeq entries(n_entries);
    entries.length(n_entries);
    // remove from the end of hdr's entries (order doesn't matter)
    for (CORBA::ULong i(0), x(hdr.content_filter_entries_.length());
         i < n_entries; ++i) {
      entries[i] = hdr.content_filter_entries_[--x];
      hdr.content_filter_entries_.length(x);
    }
    add_cfentries(&entries, head.get());

    tail.reset(alloc_msgblock(*dup, this_max_serialized_size, true));
    hdr.more_fragments_ = false;
    hdr.content_filter_ = (hdr.content_filter_entries_.length() > 0);
    hdr.message_length_ = static_cast<ACE_UINT32>(payload->total_length());
    *tail << hdr;
    tail->cont(payload_head.release());
    if (hdr.content_filter_) {
      add_cfentries(&hdr.content_filter_entries_, tail.get());
    }
    return;
  }

  Message_Block_Ptr payload_tail;
  split_payload(*payload, size - hdr_len, payload_head, payload_tail);

  hdr.more_fragments_ = true;
  hdr.message_length_ = static_cast<ACE_UINT32>(payload_head->total_length());

  head.reset(alloc_msgblock(*dup, this_max_serialized_size, true));
  *head << hdr;
  head->cont(payload_head.release());
  if (hdr.content_filter_) {
    add_cfentries(&hdr.content_filter_entries_, head.get());
  }

  hdr.more_fragments_ = false;
  hdr.content_filter_ = false;
  hdr.message_length_ = static_cast<ACE_UINT32>(payload_tail->total_length());

  tail.reset(alloc_msgblock(*dup, this_max_serialized_size, true));
  *tail << hdr;
  tail->cont(payload_tail.release());
}

split_payload()

void OpenDDS::DCPS::DataSampleHeader::split_payload ( const ACE_Message_Block &  orig, size_t  size, Message_Block_Ptr &  head, Message_Block_Ptr &  tail  )

static

Definition at line 356 of file DataSampleHeader.cpp.

References ACE_Message_Block::cont(), ACE_Message_Block::duplicate(), OpenDDS::DCPS::unique_ptr< T, Deleter >::get(), ACE_Message_Block::length(), ACE_Message_Block::rd_ptr(), ACE_Message_Block::release(), OpenDDS::DCPS::unique_ptr< T, Deleter >::reset(), and ACE_Message_Block::wr_ptr().

Referenced by split().

{
  if (!head) {
    head.reset(orig.duplicate());
  }

  ACE_Message_Block* frag = head.get();
  size_t frag_remain = size;
  for (; frag_remain > frag->length(); frag = frag->cont()) {
    frag_remain -= frag->length();
  }

  if (frag_remain == frag->length()) { // split at ACE_Message_Block boundary
    tail.reset(frag->cont());
  } else {
    tail.reset(frag->duplicate());
    frag->wr_ptr(frag->wr_ptr() - frag->length() + frag_remain);
    ACE_Message_Block::release(frag->cont());
    tail->rd_ptr(frag_remain);
  }
  frag->cont(0);
}

test_flag()

ACE_INLINE bool OpenDDS::DCPS::DataSampleHeader::test_flag ( DataSampleHeaderFlag  flag, const ACE_Message_Block *  buffer  )

static

Definition at line 149 of file DataSampleHeader.inl.

References ACE_ERROR_RETURN, ACE_INLINE, ACE_TEXT(), ACE_Message_Block::base(), ACE_Message_Block::end(), FLAGS_OFFSET, LM_ERROR, and mask_flag().

Referenced by add_cfentries(), OpenDDS::DCPS::SingleSendBuffer::insert(), OpenDDS::DCPS::DataDurabilityCache::insert(), OpenDDS::DCPS::WriteDataContainer::remove_excess_durable(), and OpenDDS::DCPS::DataLinkSet::send().

{
  char* base = buffer->base();

  // verify sufficient length exists:
  if (static_cast<size_t>(buffer->end() - base) < FLAGS_OFFSET + 1) {
    ACE_ERROR_RETURN((LM_ERROR,
                      ACE_TEXT("(%P|%t) ERROR: DataSampleHeader::set_flag: ")
                      ACE_TEXT("ACE_Message_Block too short (missing flags octet).\n")), false);
  }

  MaybeGuard g(const_cast<ACE_Message_Block*>(buffer)->locking_strategy());
  return base[FLAGS_OFFSET] & mask_flag(flag);
}

valid_data()

ACE_INLINE bool OpenDDS::DCPS::DataSampleHeader::valid_data

(

)

const

Returns true if the sample has a complete serialized payload.

Definition at line 167 of file DataSampleHeader.inl.

References message_id_, and OpenDDS::DCPS::SAMPLE_DATA.

Referenced by OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::dds_demarshal(), OpenDDS::DCPS::DataWriterImpl::filter_out(), and OpenDDS::DCPS::ReceivedDataElement::ReceivedDataElement().

{
  return message_id_ == SAMPLE_DATA;
}

Member Data Documentation

byte_order_

bool OpenDDS::DCPS::DataSampleHeader::byte_order_

0 - Message encoded using big-endian byte order. (see ace/CDR_Base.h) 1 - Message encoded using little-endian byte order.

Definition at line 94 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::DataLink::create_control(), OpenDDS::DCPS::DataWriterImpl::create_control_message(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), OpenDDS::DCPS::RecorderImpl::data_received(), OpenDDS::DCPS::DataReaderImpl::data_received(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::dds_demarshal(), OpenDDS::DCPS::RtpsUdpReceiveStrategy::decode_payload(), OpenDDS::DCPS::RecorderImpl::get_dynamic_data(), init(), OpenDDS::DCPS::RtpsSampleHeader::into_received_data_sample(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::lookup_instance(), OpenDDS::DCPS::operator<<(), OpenDDS::DCPS::RtpsSampleHeader::populate_data_control_submessages(), OpenDDS::DCPS::RtpsSampleHeader::populate_data_sample_submessages(), OpenDDS::DCPS::RtpsUdpReceiveStrategy::reassemble_i(), OpenDDS::DCPS::TcpDataLink::request_ack_received(), OpenDDS::DCPS::ShmemDataLink::send_association_msg(), OpenDDS::DCPS::TcpDataLink::send_association_msg(), OpenDDS::RTPS::Sedp::Writer::set_header_fields(), OpenDDS::DCPS::to_string(), and OpenDDS::DCPS::ReplayerImpl::write().

cdr_encapsulation_

bool OpenDDS::DCPS::DataSampleHeader::cdr_encapsulation_

The data payload uses CDR encapsulation and alignment rules, as defined by the RTPS specification formal/2010-11-01.

Definition at line 129 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::ReplayerImpl::create_sample_data_message(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), OpenDDS::DCPS::RecorderImpl::data_received(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::dds_demarshal(), init(), OpenDDS::DCPS::RtpsSampleHeader::into_received_data_sample(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::lookup_instance(), OpenDDS::DCPS::operator<<(), and OpenDDS::DCPS::to_string().

coherent_change_

bool OpenDDS::DCPS::DataSampleHeader::coherent_change_

The flag indicates the sample belongs to a coherent change set (i.e. PRESENTATION coherent_access == true).

Definition at line 98 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::DataReaderImpl::accept_sample_processing(), OpenDDS::DCPS::DataWriterImpl::create_control_message(), OpenDDS::DCPS::ReplayerImpl::create_sample_data_message(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), init(), OpenDDS::DCPS::operator<<(), OpenDDS::DCPS::to_string(), and OpenDDS::DCPS::DataReaderImpl::writer_activity().

content_filter_

bool OpenDDS::DCPS::DataSampleHeader::content_filter_

The publishing side has applied content filtering, and the optional content_filter_entries_ field is present in the marshaled header.

Definition at line 112 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::ReplayerImpl::create_sample_data_message(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), OpenDDS::DCPS::DataLink::data_received_i(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::dds_demarshal(), init(), join(), OpenDDS::DCPS::operator<<(), and OpenDDS::DCPS::to_string().

content_filter_entries_

GUIDSeq OpenDDS::DCPS::DataSampleHeader::content_filter_entries_

Optional field present if the content_filter_ flag bit is set. Indicates which readers should not receive the data.

Definition at line 185 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::DataLink::data_received_i(), init(), join(), OpenDDS::DCPS::operator<<(), and OpenDDS::DCPS::to_string().

group_coherent_

bool OpenDDS::DCPS::DataSampleHeader::group_coherent_

Definition at line 108 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::DataReaderImpl::accept_sample_processing(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), init(), OpenDDS::DCPS::operator<<(), and OpenDDS::DCPS::to_string().

historic_sample_

bool OpenDDS::DCPS::DataSampleHeader::historic_sample_

This flag indicates a sample has been resent from a non-VOLATILE DataWriter.

Definition at line 102 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::DataReaderImpl::check_historic(), OpenDDS::DCPS::RtpsUdpDataLink::RtpsWriter::customize_queue_element_helper(), OpenDDS::DCPS::DataReaderImpl::deliver_historic(), OpenDDS::DCPS::DataReaderImpl::filter_sample(), init(), OpenDDS::DCPS::operator<<(), OpenDDS::DCPS::RtpsSampleHeader::process_iqos(), OpenDDS::RTPS::Sedp::Writer::set_header_fields(), and OpenDDS::DCPS::to_string().

key_fields_only_

bool OpenDDS::DCPS::DataSampleHeader::key_fields_only_

Only the key fields of the data sample are present in the payload.

Definition at line 132 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::DataWriterImpl::create_control_message(), OpenDDS::DCPS::DataReaderImpl::data_received(), OpenDDS::RTPS::Sedp::Reader::data_received(), OpenDDS::RTPS::Sedp::LivelinessReader::data_received_i(), OpenDDS::RTPS::decode_parameter_list(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::dispose_unregister(), init(), OpenDDS::DCPS::RtpsSampleHeader::into_received_data_sample(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::lookup_instance(), OpenDDS::DCPS::operator<<(), OpenDDS::DCPS::RtpsUdpReceiveStrategy::reassemble_i(), and OpenDDS::DCPS::to_string().

lifespan_duration_

bool OpenDDS::DCPS::DataSampleHeader::lifespan_duration_

This flag indicates the sample header contains non-default LIFESPAN duration fields.

Definition at line 106 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::ReplayerImpl::create_sample_data_message(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), OpenDDS::DCPS::DataReaderImpl::filter_sample(), init(), OpenDDS::DCPS::operator<<(), and OpenDDS::DCPS::to_string().

lifespan_duration_nanosec_

ACE_UINT32 OpenDDS::DCPS::DataSampleHeader::lifespan_duration_nanosec_

Definition at line 172 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::ReplayerImpl::create_sample_data_message(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), OpenDDS::DCPS::DataReaderImpl::filter_sample(), init(), OpenDDS::DCPS::operator<<(), and OpenDDS::DCPS::to_string().

lifespan_duration_sec_

ACE_INT32 OpenDDS::DCPS::DataSampleHeader::lifespan_duration_sec_

The LIFESPAN duration field is generated from the DataWriter or supplied by the application at the time of the write. This field is used to determine if a given sample is considered 'stale' and should be discarded by associated DataReader. These fields are optional and are controlled by the lifespan_duration_ flag.

Definition at line 171 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::ReplayerImpl::create_sample_data_message(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), OpenDDS::DCPS::DataReaderImpl::filter_sample(), init(), OpenDDS::DCPS::operator<<(), and OpenDDS::DCPS::to_string().

message_id_

char OpenDDS::DCPS::DataSampleHeader::message_id_

The enum MessageId.

Definition at line 87 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::MulticastDataLink::check_header(), OpenDDS::DCPS::DataLink::create_control(), OpenDDS::DCPS::DataWriterImpl::create_control_message(), OpenDDS::DCPS::ReplayerImpl::create_sample_data_message(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), OpenDDS::DCPS::RtpsUdpDataLink::RtpsWriter::customize_queue_element_helper(), OpenDDS::DCPS::RtpsUdpDataLink::customize_queue_element_non_reliable_i(), OpenDDS::DCPS::WriteDataContainer::data_delivered(), OpenDDS::DCPS::WriteDataContainer::data_dropped(), OpenDDS::DCPS::RecorderImpl::data_received(), OpenDDS::DCPS::DataReaderImpl::data_received(), OpenDDS::RTPS::Sedp::Reader::data_received(), OpenDDS::RTPS::Sedp::DiscoveryReader::data_received_i(), OpenDDS::RTPS::Sedp::LivelinessReader::data_received_i(), OpenDDS::RTPS::Sedp::SecurityReader::data_received_i(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::dds_demarshal(), OpenDDS::DCPS::ShmemReceiveStrategy::deliver_sample(), OpenDDS::DCPS::UdpReceiveStrategy::deliver_sample(), OpenDDS::DCPS::TcpReceiveStrategy::deliver_sample(), OpenDDS::DCPS::RtpsUdpReceiveStrategy::deliver_sample_i(), init(), OpenDDS::DCPS::RtpsSampleHeader::into_received_data_sample(), OpenDDS::DCPS::UdpDataLink::open(), OpenDDS::DCPS::operator<<(), OpenDDS::DCPS::RtpsSampleHeader::populate_data_control_submessages(), OpenDDS::DCPS::RtpsSampleHeader::populate_data_sample_submessages(), OpenDDS::DCPS::RtpsSampleHeader::process_iqos(), OpenDDS::DCPS::WriteDataContainer::release_buffer(), OpenDDS::DCPS::TcpDataLink::request_ack_received(), OpenDDS::DCPS::MulticastDataLink::sample_received(), OpenDDS::DCPS::ShmemDataLink::send_association_msg(), OpenDDS::DCPS::TcpDataLink::send_association_msg(), OpenDDS::DCPS::TcpDataLink::send_graceful_disconnect_message(), OpenDDS::DCPS::TransportClient::send_i(), OpenDDS::RTPS::Sedp::Writer::set_header_fields(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::set_instance_state_i(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::store_instance_data(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::store_instance_data_check(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::store_synthetic_data(), OpenDDS::DCPS::to_string(), valid_data(), and OpenDDS::DCPS::DataReaderImpl::writer_activity().

message_length_

ACE_UINT32 OpenDDS::DCPS::DataSampleHeader::message_length_

The size of the data sample (without header). After this header is demarshaled, the transport expects to see this many bytes in the stream before the start of the next header (or end of the Transport PDU).

Definition at line 144 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::DataLink::create_control(), OpenDDS::DCPS::DataWriterImpl::create_control_message(), OpenDDS::DCPS::ReplayerImpl::create_sample_data_message(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), OpenDDS::DCPS::DataReaderImpl::data_received(), OpenDDS::DCPS::RtpsUdpDataLink::RtpsWriter::end_historic_samples_i(), init(), OpenDDS::DCPS::RtpsSampleHeader::into_received_data_sample(), join(), OpenDDS::DCPS::UdpDataLink::open(), OpenDDS::DCPS::operator<<(), OpenDDS::DCPS::RtpsUdpDataLink::RtpsWriter::request_ack_i(), OpenDDS::DCPS::TcpDataLink::request_ack_received(), OpenDDS::DCPS::ShmemDataLink::request_ack_received(), OpenDDS::DCPS::ShmemDataLink::send_association_msg(), OpenDDS::DCPS::TcpDataLink::send_association_msg(), OpenDDS::DCPS::TcpDataLink::send_graceful_disconnect_message(), OpenDDS::RTPS::Sedp::Writer::set_header_fields(), split(), and OpenDDS::DCPS::to_string().

more_fragments_

bool OpenDDS::DCPS::DataSampleHeader::more_fragments_

The current "Data Sample" needs reassembly before further processing.

Definition at line 120 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::TransportReassembly::data_unavailable(), init(), OpenDDS::DCPS::TransportReassembly::FragInfo::insert(), OpenDDS::DCPS::RtpsSampleHeader::into_received_data_sample(), join(), OpenDDS::DCPS::operator<<(), split(), and OpenDDS::DCPS::to_string().

publication_id_

GUID_t OpenDDS::DCPS::DataSampleHeader::publication_id_

Identify the DataWriter that produced the sample data being sent.

Definition at line 177 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::DataReaderImpl::accept_sample_processing(), OpenDDS::DCPS::TcpDataLink::ack_received(), OpenDDS::DCPS::DataReaderImpl::check_historic(), OpenDDS::DCPS::DataWriterImpl::create_control_message(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), OpenDDS::DCPS::RecorderImpl::data_received(), OpenDDS::DCPS::DataReaderImpl::data_received(), OpenDDS::RTPS::Sedp::Reader::data_received(), OpenDDS::DCPS::DataLink::data_received_i(), OpenDDS::RTPS::Sedp::DiscoveryReader::data_received_i(), OpenDDS::RTPS::Sedp::TypeLookupRequestReader::data_received_i(), OpenDDS::RTPS::Sedp::TypeLookupReplyReader::data_received_i(), OpenDDS::DCPS::RtpsUdpReceiveStrategy::decode_payload(), OpenDDS::DCPS::RtpsUdpReceiveStrategy::deliver_sample_i(), OpenDDS::DCPS::RtpsUdpReceiveStrategy::MessageReceiver::fill_header(), OpenDDS::DCPS::RtpsUdpDataLink::filterBestEffortReaders(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::finish_store_instance_data(), init(), OpenDDS::DCPS::RtpsSampleHeader::into_received_data_sample(), OpenDDS::DCPS::operator<<(), OpenDDS::DCPS::RtpsSampleHeader::populate_data_control_submessages(), OpenDDS::RTPS::Sedp::TypeLookupReplyReader::process_get_dependencies_reply(), OpenDDS::DCPS::DataReaderImpl::process_latency(), OpenDDS::RTPS::Sedp::TypeLookupReplyReader::process_type_lookup_reply(), OpenDDS::DCPS::ReliableSession::ready_to_deliver(), OpenDDS::DCPS::TransportReassembly::reassemble_i(), OpenDDS::DCPS::RtpsUdpReceiveStrategy::reassemble_i(), OpenDDS::DCPS::TcpDataLink::request_ack_received(), OpenDDS::DCPS::ShmemDataLink::request_ack_received(), OpenDDS::DCPS::ShmemDataLink::send_association_msg(), OpenDDS::DCPS::TcpDataLink::send_association_msg(), OpenDDS::DCPS::DataLink::send_control(), OpenDDS::RTPS::Sedp::Writer::set_header_fields(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::set_instance_state_i(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::store_instance_data(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::store_instance_data_check(), OpenDDS::DCPS::to_string(), OpenDDS::DCPS::ReplayerImpl::write(), and OpenDDS::DCPS::DataReaderImpl::writer_activity().

publisher_id_

GUID_t OpenDDS::DCPS::DataSampleHeader::publisher_id_

Id representing the coherent group. Optional field that's only present if the flag for group_coherent_ is set.

Definition at line 181 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::DataReaderImpl::accept_sample_processing(), OpenDDS::DCPS::DataWriterImpl::create_control_message(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), init(), OpenDDS::DCPS::operator<<(), OpenDDS::DCPS::TcpDataLink::request_ack_received(), OpenDDS::DCPS::ShmemDataLink::send_association_msg(), OpenDDS::DCPS::TcpDataLink::send_association_msg(), and OpenDDS::DCPS::to_string().

reserved_1

bool OpenDDS::DCPS::DataSampleHeader::reserved_1

Definition at line 134 of file DataSampleHeader.h.

reserved_2

bool OpenDDS::DCPS::DataSampleHeader::reserved_2

Definition at line 135 of file DataSampleHeader.h.

reserved_3

bool OpenDDS::DCPS::DataSampleHeader::reserved_3

Definition at line 136 of file DataSampleHeader.h.

reserved_4

bool OpenDDS::DCPS::DataSampleHeader::reserved_4

Definition at line 137 of file DataSampleHeader.h.

reserved_5

bool OpenDDS::DCPS::DataSampleHeader::reserved_5

Definition at line 138 of file DataSampleHeader.h.

reserved_6

bool OpenDDS::DCPS::DataSampleHeader::reserved_6

Definition at line 139 of file DataSampleHeader.h.

sequence_

SequenceNumber OpenDDS::DCPS::DataSampleHeader::sequence_

The sequence number is obtained from the Publisher associated with the DataWriter based on the PRESENTATION requirement for the sequence value (access_scope == GROUP).

Definition at line 149 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::TcpDataLink::ack_received(), OpenDDS::DCPS::DataReaderImpl::check_historic(), OpenDDS::DCPS::DataWriterImpl::create_control_message(), OpenDDS::DCPS::ReplayerImpl::create_sample_data_message(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), OpenDDS::DCPS::WriteDataContainer::data_delivered(), OpenDDS::DCPS::DataReaderImpl::data_received(), OpenDDS::DCPS::TransportReassembly::data_unavailable(), OpenDDS::DCPS::RtpsUdpReceiveStrategy::deliver_sample_i(), OpenDDS::DCPS::RtpsUdpDataLink::filterBestEffortReaders(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::finish_store_instance_data(), init(), OpenDDS::DCPS::TransportReassembly::FragInfo::insert(), OpenDDS::DCPS::RtpsSampleHeader::into_received_data_sample(), join(), OpenDDS::DCPS::operator<<(), OpenDDS::DCPS::RtpsSampleHeader::populate_data_control_submessages(), OpenDDS::DCPS::RtpsSampleHeader::populate_data_sample_submessages(), OpenDDS::DCPS::ReliableSession::ready_to_deliver(), OpenDDS::DCPS::TransportReassembly::reassemble_i(), OpenDDS::DCPS::WriteDataContainer::reenqueue_all(), OpenDDS::DCPS::RtpsUdpDataLink::RtpsWriter::remove_sample(), OpenDDS::DCPS::TcpDataLink::request_ack_received(), OpenDDS::DCPS::ShmemDataLink::request_ack_received(), OpenDDS::DCPS::ShmemDataLink::send_association_msg(), OpenDDS::DCPS::TcpDataLink::send_association_msg(), OpenDDS::DCPS::TransportSendElement::sequence(), OpenDDS::DCPS::TransportSendControlElement::sequence(), OpenDDS::RTPS::Sedp::Writer::set_header_fields(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::store_synthetic_data(), OpenDDS::DCPS::to_string(), OpenDDS::DCPS::DataWriterImpl::write(), and OpenDDS::DCPS::DataReaderImpl::writer_activity().

sequence_repair_

bool OpenDDS::DCPS::DataSampleHeader::sequence_repair_

Due to content filtering, a gap in the sequence numbers may be an expected condition. If this bit is set, assume prior sequence numbers were filtered-out and are not missing.

Definition at line 117 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::DataWriterImpl::create_control_message(), OpenDDS::DCPS::ReplayerImpl::create_sample_data_message(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), init(), OpenDDS::DCPS::operator<<(), and OpenDDS::DCPS::to_string().

serialized_size_

size_t OpenDDS::DCPS::DataSampleHeader::serialized_size_

private

Keep track of the amount of data read from a buffer.

Definition at line 269 of file DataSampleHeader.h.

Referenced by get_serialized_size(), and init().

source_timestamp_nanosec_

ACE_UINT32 OpenDDS::DCPS::DataSampleHeader::source_timestamp_nanosec_

Definition at line 161 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::DataWriterImpl::create_control_message(), OpenDDS::DCPS::ReplayerImpl::create_sample_data_message(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), OpenDDS::DCPS::RecorderImpl::data_received(), OpenDDS::DCPS::DataReaderImpl::data_received(), OpenDDS::DCPS::RtpsUdpReceiveStrategy::MessageReceiver::fill_header(), OpenDDS::DCPS::DataReaderImpl::filter_sample(), init(), OpenDDS::DCPS::operator<<(), OpenDDS::DCPS::RtpsSampleHeader::payload_byte_order(), OpenDDS::DCPS::DataReaderImpl::process_latency(), OpenDDS::DCPS::ReceivedDataElement::ReceivedDataElement(), OpenDDS::DCPS::resend_data_expired(), OpenDDS::DCPS::DataDurabilityCache::sample_data_type::sample_data_type(), OpenDDS::RTPS::Sedp::Writer::set_header_fields(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::set_instance_state_i(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::store_synthetic_data(), and OpenDDS::DCPS::to_string().

source_timestamp_sec_

ACE_INT32 OpenDDS::DCPS::DataSampleHeader::source_timestamp_sec_

The SOURCE_TIMESTAMP field is generated from the DataWriter or supplied by the application at the time of the write. This value is derived from the local hosts system clock, which is assumed to be synchronized with the clocks on other hosts within the domain. This field is required for DESTINATION_ORDER and LIFESPAN policy behaviors of subscriptions. It is also required to be present for all data in the SampleInfo structure supplied along with each data sample.

Definition at line 160 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::DataWriterImpl::create_control_message(), OpenDDS::DCPS::ReplayerImpl::create_sample_data_message(), OpenDDS::DCPS::DataWriterImpl::create_sample_data_message(), OpenDDS::DCPS::RecorderImpl::data_received(), OpenDDS::DCPS::DataReaderImpl::data_received(), OpenDDS::DCPS::RtpsUdpReceiveStrategy::MessageReceiver::fill_header(), OpenDDS::DCPS::DataReaderImpl::filter_sample(), init(), OpenDDS::DCPS::operator<<(), OpenDDS::DCPS::RtpsSampleHeader::payload_byte_order(), OpenDDS::DCPS::DataReaderImpl::process_latency(), OpenDDS::DCPS::ReceivedDataElement::ReceivedDataElement(), OpenDDS::DCPS::resend_data_expired(), OpenDDS::DCPS::DataDurabilityCache::sample_data_type::sample_data_type(), OpenDDS::RTPS::Sedp::Writer::set_header_fields(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::set_instance_state_i(), OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::store_synthetic_data(), and OpenDDS::DCPS::to_string().

submessage_id_

char OpenDDS::DCPS::DataSampleHeader::submessage_id_

Implementation-specific sub-message Ids.

Definition at line 90 of file DataSampleHeader.h.

Referenced by OpenDDS::DCPS::DataLink::create_control(), init(), OpenDDS::DCPS::operator<<(), OpenDDS::DCPS::MulticastDataLink::sample_received(), and OpenDDS::DCPS::to_string().

---

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

• DataSampleHeader.h
• DataSampleHeader.cpp
• DataSampleHeader.inl