OpenDDS::DCPS::DataSampleHeader Struct Reference

#include <DataSampleHeader.h>

Collaboration diagram for OpenDDS::DCPS::DataSampleHeader:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 DataSampleHeader ()
 Default constructor.
 DataSampleHeader (ACE_Message_Block *buffer)
 Construct with values extracted from a buffer.
 DataSampleHeader (ACE_Message_Block &buffer)
DataSampleHeaderoperator= (ACE_Message_Block *buffer)
 Assignment from an ACE_Message_Block.
DataSampleHeaderoperator= (ACE_Message_Block &buffer)
size_t marshaled_size ()
 Amount of data read when initializing from a buffer.
size_t max_marshaled_size ()
 Similar to IDL compiler generated methods.

Public Attributes

char message_id_
 The enum MessageId.
bool last_sample_: 1
bool byte_order_: 1
bool reserved_1: 1
 reservered bits
bool reserved_2: 1
bool reserved_3: 1
bool reserved_4: 1
bool reserved_5: 1
bool reserved_6: 1
ACE_UINT32 message_length_
ACE_INT16 sequence_
ACE_INT32 source_timestamp_sec_
ACE_UINT32 source_timestamp_nanosec_
ACE_UINT16 coherency_group_
PublicationId publication_id_

Private Member Functions

void init (ACE_Message_Block *buffer)
 Implement load from buffer.

Private Attributes

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

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.


Constructor & Destructor Documentation

ACE_INLINE OpenDDS::DCPS::DataSampleHeader::DataSampleHeader (  ) 

Default constructor.

-*- C++ -*-

Id
DataSampleHeader.inl 1435 2008-10-06 22:42:53Z martinezm

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

Construct with values extracted from a buffer.

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


Member Function Documentation

void OpenDDS::DCPS::DataSampleHeader::init ( ACE_Message_Block *  buffer  )  [private]

Implement load from buffer.

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

Amount of data read when initializing from a buffer.

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

Similar to IDL compiler generated methods.

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

ACE_INLINE OpenDDS::DCPS::DataSampleHeader & OpenDDS::DCPS::DataSampleHeader::operator= ( ACE_Message_Block *  buffer  ) 

Assignment from an ACE_Message_Block.


Member Data Documentation

bool OpenDDS::DCPS::DataSampleHeader::byte_order_

0 - Message encoded using little-endian byte order. 1 - Message encoded using network byte order.

ACE_UINT16 OpenDDS::DCPS::DataSampleHeader::coherency_group_

The COHERENCY_GROUP field is obtained from the Publisher as well, in order to support the same scope as the SEQUENCE field. The special value of 0 indicates that the sample is not participating in a coherency group.

bool OpenDDS::DCPS::DataSampleHeader::last_sample_

The flag indicates the last sample of a group of coherent changes.

size_t OpenDDS::DCPS::DataSampleHeader::marshaled_size_ [private]

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

char OpenDDS::DCPS::DataSampleHeader::message_id_

The enum MessageId.

ACE_UINT32 OpenDDS::DCPS::DataSampleHeader::message_length_

PublicationId OpenDDS::DCPS::DataSampleHeader::publication_id_

Identify the DataWriter that produced the sample data being sent.

bool OpenDDS::DCPS::DataSampleHeader::reserved_1

reservered bits

bool OpenDDS::DCPS::DataSampleHeader::reserved_2

bool OpenDDS::DCPS::DataSampleHeader::reserved_3

bool OpenDDS::DCPS::DataSampleHeader::reserved_4

bool OpenDDS::DCPS::DataSampleHeader::reserved_5

bool OpenDDS::DCPS::DataSampleHeader::reserved_6

ACE_INT16 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).

ACE_UINT32 OpenDDS::DCPS::DataSampleHeader::source_timestamp_nanosec_

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.


The documentation for this struct was generated from the following files:
Generated on Fri Nov 7 09:37:33 2008 for OpenDDS by  doxygen 1.4.7