OpenDDS::DCPS::RtpsTransportHeader Struct Reference

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

#include <RtpsTransportHeader.h>

Collaboration diagram for OpenDDS::DCPS::RtpsTransportHeader:

[legend]

List of all members.

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	max_marshaled_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

ACE_INLINE OpenDDS::DCPS::RtpsTransportHeader::RtpsTransportHeader

(

)

Definition at line 22 of file RtpsTransportHeader.inl.

References OpenDDS::RTPS::Header::guidPrefix, header_, OpenDDS::RTPS::Header::prefix, 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;
}

ACE_INLINE OpenDDS::DCPS::RtpsTransportHeader::RtpsTransportHeader

(

ACE_Message_Block &

mb

)

[explicit]

Definition at line 35 of file RtpsTransportHeader.inl.

References init().

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

Here is the call graph for this function:

---

Member Function Documentation

ACE_INLINE void OpenDDS::DCPS::RtpsTransportHeader::incomplete

(

ACE_Message_Block &

mb

)

Definition at line 51 of file RtpsTransportHeader.inl.

References ACE_Message_Block::cont(), len, 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());
  }
}

Here is the call graph for this function:

void OpenDDS::DCPS::RtpsTransportHeader::init

(

ACE_Message_Block &

mb

)

Definition at line 29 of file RtpsTransportHeader.cpp.

References OpenDDS::DCPS::Serializer::ALIGN_CDR, header_, length_, max_marshaled_size(), OpenDDS::RTPS::Header::prefix, 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, false, Serializer::ALIGN_CDR);
  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_ -= max_marshaled_size();

    // RTPS spec v2.1 section 8.3.6.3
    valid_ = std::equal(header_.prefix, header_.prefix + sizeof(header_.prefix),
                        PROTOCOL_RTPS);
    valid_ &= (header_.version.major == OpenDDS::RTPS::PROTOCOLVERSION.major);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

ACE_INLINE void OpenDDS::DCPS::RtpsTransportHeader::last_fragment

(

bool

frag

)

Definition at line 76 of file RtpsTransportHeader.inl.

{
}

ACE_INLINE bool OpenDDS::DCPS::RtpsTransportHeader::last_fragment

(

)

Definition at line 70 of file RtpsTransportHeader.inl.

{
  return false;
}

ACE_INLINE size_t OpenDDS::DCPS::RtpsTransportHeader::max_marshaled_size

(

)

[static]

Definition at line 16 of file RtpsTransportHeader.inl.

References OpenDDS::RTPS::RTPSHDR_SZ.

Referenced by init().

{
  return RTPS::RTPSHDR_SZ;
}

Here is the caller graph for this function:

ACE_INLINE RtpsTransportHeader & OpenDDS::DCPS::RtpsTransportHeader::operator=

(

ACE_Message_Block &

mb

)

Definition at line 43 of file RtpsTransportHeader.inl.

References init().

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

Here is the call graph for this function:

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

(

)

Definition at line 51 of file RtpsTransportHeader.cpp.

{
  return dummy;
}

ACE_INLINE bool OpenDDS::DCPS::RtpsTransportHeader::valid

(

void

)

const

Definition at line 64 of file RtpsTransportHeader.inl.

References valid_.

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

{
  return valid_;
}

Here is the caller graph for this function:

---

Member Data Documentation

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

size_t OpenDDS::DCPS::RtpsTransportHeader::length_

Definition at line 42 of file RtpsTransportHeader.h.

Referenced by init().

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:

• RtpsTransportHeader.h
• RtpsTransportHeader.cpp
• RtpsTransportHeader.inl