Adapt the TransportReceiveStrategy for RTPS's "transport" (message) Header. More...

#include <RtpsTransportHeader.h>

Collaboration diagram for OpenDDS::DCPS::RtpsTransportHeader:

Public Member Functions
	RtpsTransportHeader ()

	RtpsTransportHeader (ACE_Message_Block &mb)

RtpsTransportHeader &	operator= (ACE_Message_Block &mb)

bool	valid () const

bool	last_fragment ()

void	last_fragment (bool frag)

const SequenceNumber &	sequence ()

void	init (ACE_Message_Block &mb)

void	incomplete (ACE_Message_Block &mb)

Static Public Member Functions
static size_t	get_max_serialized_size ()

Public Attributes
size_t	length_

OpenDDS::RTPS::Header	header_

bool	valid_

Detailed Description

Adapt the TransportReceiveStrategy for RTPS's "transport" (message) Header.

Definition at line 25 of file RtpsTransportHeader.h.

Constructor & Destructor Documentation

◆ RtpsTransportHeader() [1/2]

ACE_INLINE OpenDDS::DCPS::RtpsTransportHeader::RtpsTransportHeader ( )

Definition at line 22 of file RtpsTransportHeader.inl.

References OpenDDS::RTPS::Header::guidPrefix, header_, OpenDDS::RTPS::ProtocolVersion_t::major, OpenDDS::RTPS::ProtocolVersion_t::minor, OpenDDS::RTPS::Header::prefix, OpenDDS::RTPS::VendorId_t::vendorId, OpenDDS::RTPS::Header::vendorId, and OpenDDS::RTPS::Header::version.

   : length_(0)
   , valid_(false)
 {
   for (int i = 0; i < 4; ++i) header_.prefix[i] = 0;
   header_.version.major = 0;
   header_.version.minor = 0;
   header_.vendorId.vendorId[0] = 0;
   header_.vendorId.vendorId[1] = 0;
   for (int i = 0; i < 12; ++i) header_.guidPrefix[i] = 0;
 }

◆ RtpsTransportHeader() [2/2]

ACE_INLINE OpenDDS::DCPS::RtpsTransportHeader::RtpsTransportHeader ( ACE_Message_Block & mb )

explicit

Definition at line 35 of file RtpsTransportHeader.inl.

References ACE_INLINE, and init().

   : length_(0)
   , valid_(false)
 {
   init(mb);
 }

Member Function Documentation

◆ get_max_serialized_size()

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

static

Definition at line 16 of file RtpsTransportHeader.inl.

References ACE_INLINE, and OpenDDS::RTPS::RTPSHDR_SZ.

Referenced by init().

 {
   return RTPS::RTPSHDR_SZ;
 }

◆ incomplete()

ACE_INLINE void OpenDDS::DCPS::RtpsTransportHeader::incomplete ( ACE_Message_Block & mb )

Definition at line 51 of file RtpsTransportHeader.inl.

References ACE_INLINE, ACE_Message_Block::cont(), ACE_Message_Block::length(), ACE_Message_Block::rd_ptr(), and ACE_Message_Block::total_length().

 {
   // If we get a datagram with an incomplete header, we need to skip
   // and consume the received bytes so the transport framework doesn't
   // try to give us these bytes again on the next call to handle_input().
   ACE_Message_Block* cur = &mb;
   for (size_t len = mb.total_length(); cur && len; cur = cur->cont()) {
     len -= cur->length();
     cur->rd_ptr(cur->length());
   }
 }

◆ init()

void OpenDDS::DCPS::RtpsTransportHeader::init ( ACE_Message_Block & mb )

Definition at line 27 of file RtpsTransportHeader.cpp.

References get_max_serialized_size(), header_, OpenDDS::DCPS::Encoding::KIND_XCDR1, length_, OpenDDS::RTPS::ProtocolVersion_t::major, OpenDDS::RTPS::Header::prefix, OpenDDS::RTPS::PROTOCOL_RTPS, OpenDDS::RTPS::PROTOCOLVERSION, valid_, and OpenDDS::RTPS::Header::version.

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

 {
   // Byte order doesn't matter for RTPS::Header, since it's
   // exclusively structs/arrays of octet.
   Serializer ser(&mb, Encoding::KIND_XCDR1);
   valid_ = (ser >> header_);
 
   if (valid_) {
 
     // length_ started as the total number of bytes in the datagram's payload.
     // When we return to the TransportReceiveStrategy it must be the number
     // of bytes remaining after processing this RTPS::Header.
     length_ -= get_max_serialized_size();
 
     // RTPS spec v2.1 section 8.3.6.3
     valid_ = std::equal(header_.prefix, header_.prefix + sizeof(header_.prefix),
                         RTPS::PROTOCOL_RTPS);
     valid_ &= (header_.version.major == OpenDDS::RTPS::PROTOCOLVERSION.major);
   }
 }

◆ last_fragment() [1/2]

ACE_INLINE bool OpenDDS::DCPS::RtpsTransportHeader::last_fragment ( )

Definition at line 70 of file RtpsTransportHeader.inl.

References ACE_INLINE.

Referenced by OpenDDS::DCPS::RtpsUdpReceiveStrategy::handle_input().

 {
   return false;
 }

◆ last_fragment() [2/2]

ACE_INLINE void OpenDDS::DCPS::RtpsTransportHeader::last_fragment ( bool frag )

Definition at line 76 of file RtpsTransportHeader.inl.

References OPENDDS_END_VERSIONED_NAMESPACE_DECL.

77 {

78 }

◆ operator=()

ACE_INLINE RtpsTransportHeader & OpenDDS::DCPS::RtpsTransportHeader::operator= ( ACE_Message_Block & mb )

Definition at line 43 of file RtpsTransportHeader.inl.

References ACE_INLINE, and init().

 {
   // length_ is not updated in a call to operator=()
   init(mb);
   return *this;
 }

◆ sequence()

const SequenceNumber & OpenDDS::DCPS::RtpsTransportHeader::sequence ( )

Definition at line 49 of file RtpsTransportHeader.cpp.

References OPENDDS_END_VERSIONED_NAMESPACE_DECL.

 {
   return dummy;
 }

◆ valid()

ACE_INLINE bool OpenDDS::DCPS::RtpsTransportHeader::valid ( void ) const

Definition at line 64 of file RtpsTransportHeader.inl.

References ACE_INLINE, and valid_.

Referenced by OpenDDS::DCPS::RtpsUdpReceiveStrategy::check_header(), and OpenDDS::DCPS::RtpsUdpReceiveStrategy::handle_input().

 {
   return valid_;
 }

Member Data Documentation

◆ header_

OpenDDS::RTPS::Header OpenDDS::DCPS::RtpsTransportHeader::header_

Definition at line 43 of file RtpsTransportHeader.h.

Referenced by OpenDDS::DCPS::RtpsUdpReceiveStrategy::check_header(), init(), and RtpsTransportHeader().

◆ length_

size_t OpenDDS::DCPS::RtpsTransportHeader::length_

Definition at line 42 of file RtpsTransportHeader.h.

Referenced by OpenDDS::DCPS::RtpsUdpReceiveStrategy::handle_input(), and init().

◆ valid_

bool OpenDDS::DCPS::RtpsTransportHeader::valid_

Definition at line 44 of file RtpsTransportHeader.h.

Referenced by init(), and valid().

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

Public Member Functions

Static Public Member Functions

Public Attributes