OpenDDS::DCPS::EncapsulationHeader Class Reference

#include <Serializer.h>

Public Types
enum	Kind {   KIND_CDR_BE = 0x0000, KIND_CDR_LE = 0x0001, KIND_PL_CDR_BE = 0x0002, KIND_PL_CDR_LE = 0x0003,   KIND_CDR2_BE = 0x0006, KIND_CDR2_LE = 0x0007, KIND_D_CDR2_BE = 0x0008, KIND_D_CDR2_LE = 0x0009,   KIND_PL_CDR2_BE = 0x000a, KIND_PL_CDR2_LE = 0x000b, KIND_XML = 0x0004, KIND_INVALID = 0xFFFF }

Public Member Functions
	EncapsulationHeader (Kind k=KIND_CDR_BE, ACE_CDR::UShort options=0)
	EncapsulationHeader (const Encoding &enc, Extensibility ext, ACE_CDR::UShort options=0)
Kind	kind () const
void	kind (Kind value)
ACE_UINT16	options () const
void	options (ACE_UINT16 value)
bool	is_good () const
bool	from_encoding (const Encoding &encoding, Extensibility extensibility)
bool	to_encoding (Encoding &encoding, Extensibility expected_extensibility)
bool	to_any_encoding (Encoding &encoding)
String	to_string () const

Static Public Member Functions
static bool	set_encapsulation_options (Message_Block_Ptr &mb)

Static Public Attributes
static const size_t	serialized_size = 4
static const size_t	padding_marker_byte_index = 3
static const size_t	padding_marker_alignment = 4

Private Member Functions
bool	to_encoding_i (Encoding &encoding, Extensibility *expected_extensibility_ptr)

Private Attributes
Kind	kind_
	The first two bytes as a big endian integer. More...
ACE_CDR::UShort	options_
	The last two bytes as a big endian integer. More...

Detailed Description

Represents the RTPS encapsulation header for serialized data.

This consists of 4 bytes that appear in front of the data. The first two bytes represents the kind of the encoding the data uses and the last two bytes (known as "options") are traditionally reserved.

See XTypes 1.3 7.6.3.1.2

Definition at line 230 of file Serializer.h.

Member Enumeration Documentation

Kind

enum OpenDDS::DCPS::EncapsulationHeader::Kind

The known possible values of the first 2 bytes represented as big endian integers.

Enumerator
KIND_CDR_BE
KIND_CDR_LE
KIND_PL_CDR_BE
KIND_PL_CDR_LE
KIND_CDR2_BE
KIND_CDR2_LE
KIND_D_CDR2_BE
KIND_D_CDR2_LE
KIND_PL_CDR2_BE
KIND_PL_CDR2_LE
KIND_XML
KIND_INVALID

Definition at line 236 of file Serializer.h.

            {
    KIND_CDR_BE = 0x0000,
    KIND_CDR_LE = 0x0001,
    KIND_PL_CDR_BE = 0x0002,
    KIND_PL_CDR_LE = 0x0003,
    KIND_CDR2_BE = 0x0006,
    KIND_CDR2_LE = 0x0007,
    KIND_D_CDR2_BE = 0x0008,
    KIND_D_CDR2_LE = 0x0009,
    KIND_PL_CDR2_BE = 0x000a,
    KIND_PL_CDR2_LE = 0x000b,
    KIND_XML = 0x0004,
    KIND_INVALID = 0xFFFF
  };

Constructor & Destructor Documentation

EncapsulationHeader() [1/2]

OpenDDS::DCPS::EncapsulationHeader::EncapsulationHeader	(	Kind	k = KIND_CDR_BE,
		ACE_CDR::UShort	options = 0
	)

Definition at line 98 of file Serializer.cpp.

  : kind_(kind)
  , options_(options)
{
}

EncapsulationHeader() [2/2]

OpenDDS::DCPS::EncapsulationHeader::EncapsulationHeader	(	const Encoding &	enc,
		Extensibility	ext,
		ACE_CDR::UShort	options = 0
	)

Success can be verified using is_good()

Definition at line 104 of file Serializer.cpp.

References from_encoding(), kind_, and KIND_INVALID.

  : kind_(KIND_INVALID)
  , options_(options)
{
  if (!from_encoding(enc, ext)) {
    kind_ = KIND_INVALID;
  }
}

Member Function Documentation

from_encoding()

bool OpenDDS::DCPS::EncapsulationHeader::from_encoding	(	const Encoding &	encoding,
		Extensibility	extensibility
	)

Translate from an encoding, returns false if it failed.

Definition at line 113 of file Serializer.cpp.

References ACE_ERROR, OpenDDS::DCPS::APPENDABLE, OpenDDS::DCPS::ENDIAN_BIG, OpenDDS::DCPS::Encoding::endianness(), OpenDDS::DCPS::LogLevel::Error, OpenDDS::DCPS::FINAL, OpenDDS::DCPS::Encoding::kind(), kind_, KIND_CDR2_BE, KIND_CDR2_LE, KIND_CDR_BE, KIND_CDR_LE, KIND_D_CDR2_BE, KIND_D_CDR2_LE, KIND_PL_CDR2_BE, KIND_PL_CDR2_LE, KIND_PL_CDR_BE, KIND_PL_CDR_LE, OpenDDS::DCPS::Encoding::kind_to_string(), OpenDDS::DCPS::Encoding::KIND_XCDR1, OpenDDS::DCPS::Encoding::KIND_XCDR2, LM_ERROR, OpenDDS::DCPS::log_level, and OpenDDS::DCPS::MUTABLE.

Referenced by EncapsulationHeader(), and OpenDDS::DCPS::DataWriterImpl::serialize_sample().

{
  const bool big = encoding.endianness() == ENDIAN_BIG;
  switch (encoding.kind()) {
  case Encoding::KIND_XCDR1:
    switch (extensibility) {
    case FINAL:
    case APPENDABLE:
      kind_ = big ? KIND_CDR_BE : KIND_CDR_LE;
      break;
    case MUTABLE:
      kind_ = big ? KIND_PL_CDR_BE : KIND_PL_CDR_LE;
      break;
    }
    break;
  case Encoding::KIND_XCDR2:
    switch (extensibility) {
    case FINAL:
      kind_ = big ? KIND_CDR2_BE : KIND_CDR2_LE;
      break;
    case APPENDABLE:
      kind_ = big ? KIND_D_CDR2_BE : KIND_D_CDR2_LE;
      break;
    case MUTABLE:
      kind_ = big ? KIND_PL_CDR2_BE : KIND_PL_CDR2_LE;
      break;
    }
    break;
  default:
    if (log_level >= LogLevel::Error) {
      ACE_ERROR((LM_ERROR, "(%P|%t) ERROR: EncapsulationHeader::from_encoding: "
        "Got Encoding With Unsupported Kind: %C\n",
        Encoding::kind_to_string(encoding.kind()).c_str()));
    }
    return false;
  }
  return true;
}

is_good()

ACE_INLINE bool OpenDDS::DCPS::EncapsulationHeader::is_good

(

)

const

post-initialization test for a successful call to from_encoding during construction of this encapsulation header.

Definition at line 173 of file Serializer.inl.

References ACE_INLINE, and OpenDDS::DCPS::Encoding::kind_.

Referenced by OpenDDS::DCPS::operator<<().

{
  return kind_ != KIND_INVALID;
}

kind() [1/2]

ACE_INLINE EncapsulationHeader::Kind OpenDDS::DCPS::EncapsulationHeader::kind

(

void

)

const

Definition at line 161 of file Serializer.inl.

References ACE_INLINE, and OpenDDS::DCPS::Encoding::kind_.

Referenced by OpenDDS::DCPS::operator<<(), and OpenDDS::DCPS::operator>>().

{
  return kind_;
}

kind() [2/2]

ACE_INLINE void OpenDDS::DCPS::EncapsulationHeader::kind

(

Kind

value

)

Definition at line 167 of file Serializer.inl.

References ACE_INLINE, OpenDDS::DCPS::Encoding::kind_, and value.

{
  kind_ = value;
}

options() [1/2]

ACE_INLINE ACE_UINT16 OpenDDS::DCPS::EncapsulationHeader::options

(

void

)

const

Definition at line 179 of file Serializer.inl.

References ACE_INLINE.

Referenced by OpenDDS::DCPS::operator<<(), and OpenDDS::DCPS::operator>>().

{
  return options_;
}

options() [2/2]

ACE_INLINE void OpenDDS::DCPS::EncapsulationHeader::options

(

ACE_UINT16

value

)

Definition at line 185 of file Serializer.inl.

References ACE_INLINE, and value.

{
  options_ = value;
}

set_encapsulation_options()

bool OpenDDS::DCPS::EncapsulationHeader::set_encapsulation_options ( Message_Block_Ptr &  mb )

static

Definition at line 251 of file Serializer.cpp.

References ACE_ERROR, OpenDDS::DCPS::LogLevel::Error, ACE_Message_Block::length(), LM_ERROR, OpenDDS::DCPS::log_level, padding_marker_alignment, padding_marker_byte_index, and ACE_Message_Block::rd_ptr().

Referenced by OpenDDS::DCPS::DataWriterImpl::serialize_sample().

{
  if (mb->length() < padding_marker_byte_index + 1) {
    if (log_level >= LogLevel::Error) {
      ACE_ERROR((LM_ERROR, "(%P|%t) ERROR: EncapsulationHeader::set_encapsulation_options: "
        "Insufficient buffer size %B\n", mb->length()));
    }
    return false;
  }

  mb->rd_ptr()[padding_marker_byte_index] |= ((padding_marker_alignment - mb->length() % padding_marker_alignment) & 0x03);
  return true;
}

to_any_encoding()

bool OpenDDS::DCPS::EncapsulationHeader::to_any_encoding

(

Encoding &

encoding

)

Like to_encoding, but without an expected extensibility.

Definition at line 159 of file Serializer.cpp.

References to_encoding_i().

{
  return to_encoding_i(encoding, 0);
}

to_encoding()

bool OpenDDS::DCPS::EncapsulationHeader::to_encoding	(	Encoding &	encoding,
		Extensibility	expected_extensibility
	)

Translate to an encoding, returns false if it failed.

Definition at line 153 of file Serializer.cpp.

References to_encoding_i().

Referenced by OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::dds_demarshal(), OpenDDS::RTPS::Spdp::SpdpTransport::handle_input(), OpenDDS::DCPS::FilterEvaluator::SerializedForEval::lookup(), and OpenDDS::DCPS::DataReaderImpl_T< DynamicSample >::lookup_instance().

{
  return to_encoding_i(encoding, &expected_extensibility);
}

to_encoding_i()

bool OpenDDS::DCPS::EncapsulationHeader::to_encoding_i ( Encoding &  encoding, Extensibility *  expected_extensibility_ptr  )

private

Definition at line 164 of file Serializer.cpp.

References ACE_ERROR, OpenDDS::DCPS::APPENDABLE, OpenDDS::DCPS::ENDIAN_BIG, OpenDDS::DCPS::ENDIAN_LITTLE, OpenDDS::DCPS::Encoding::endianness(), OpenDDS::DCPS::LogLevel::Error, OpenDDS::DCPS::ext_to_string(), OpenDDS::DCPS::FINAL, OpenDDS::DCPS::Encoding::kind(), kind_, KIND_CDR2_BE, KIND_CDR2_LE, KIND_CDR_BE, KIND_CDR_LE, KIND_D_CDR2_BE, KIND_D_CDR2_LE, KIND_PL_CDR2_BE, KIND_PL_CDR2_LE, KIND_PL_CDR_BE, KIND_PL_CDR_LE, OpenDDS::DCPS::Encoding::KIND_XCDR1, OpenDDS::DCPS::Encoding::KIND_XCDR2, LM_ERROR, OpenDDS::DCPS::log_level, OpenDDS::DCPS::MUTABLE, and to_string().

Referenced by to_any_encoding(), and to_encoding().

{
  Extensibility expected_extensibility = expected_extensibility_ptr ?
    *expected_extensibility_ptr : FINAL; // Placeholder, doesn't matter
  bool wrong_extensibility = true;
  switch (kind_) {
  case KIND_CDR_BE:
    encoding.kind(Encoding::KIND_XCDR1);
    encoding.endianness(ENDIAN_BIG);
    wrong_extensibility = expected_extensibility == MUTABLE;
    break;

  case KIND_CDR_LE:
    encoding.kind(Encoding::KIND_XCDR1);
    encoding.endianness(ENDIAN_LITTLE);
    wrong_extensibility = expected_extensibility == MUTABLE;
    break;

  case KIND_PL_CDR_BE:
    encoding.kind(Encoding::KIND_XCDR1);
    encoding.endianness(ENDIAN_BIG);
    wrong_extensibility = expected_extensibility != MUTABLE;
    break;

  case KIND_PL_CDR_LE:
    encoding.kind(Encoding::KIND_XCDR1);
    encoding.endianness(ENDIAN_LITTLE);
    wrong_extensibility = expected_extensibility != MUTABLE;
    break;

  case KIND_CDR2_BE:
    encoding.kind(Encoding::KIND_XCDR2);
    encoding.endianness(ENDIAN_BIG);
    wrong_extensibility = expected_extensibility != FINAL;
    break;

  case KIND_CDR2_LE:
    encoding.kind(Encoding::KIND_XCDR2);
    encoding.endianness(ENDIAN_LITTLE);
    wrong_extensibility = expected_extensibility != FINAL;
    break;

  case KIND_D_CDR2_BE:
    encoding.kind(Encoding::KIND_XCDR2);
    encoding.endianness(ENDIAN_BIG);
    wrong_extensibility = expected_extensibility != APPENDABLE;
    break;

  case KIND_D_CDR2_LE:
    encoding.kind(Encoding::KIND_XCDR2);
    encoding.endianness(ENDIAN_LITTLE);
    wrong_extensibility = expected_extensibility != APPENDABLE;
    break;

  case KIND_PL_CDR2_BE:
    encoding.kind(Encoding::KIND_XCDR2);
    encoding.endianness(ENDIAN_BIG);
    wrong_extensibility = expected_extensibility != MUTABLE;
    break;

  case KIND_PL_CDR2_LE:
    encoding.kind(Encoding::KIND_XCDR2);
    encoding.endianness(ENDIAN_LITTLE);
    wrong_extensibility = expected_extensibility != MUTABLE;
    break;

  default:
    if (log_level >= LogLevel::Error) {
      ACE_ERROR((LM_ERROR, "(%P|%t) ERROR: EncapsulationHeader::to_encoding: "
        "Unsupported Encoding: %C\n", to_string().c_str()));
    }
    return false;
  }

  if (expected_extensibility_ptr && wrong_extensibility) {
    if (log_level >= LogLevel::Error) {
      ACE_ERROR((LM_ERROR, "(%P|%t) ERROR: EncapsulationHeader::to_encoding: "
        "expected %C extensibility, but got %C\n",
        ext_to_string(*expected_extensibility_ptr), to_string().c_str()));
    }
    return false;
  }

  return true;
}

to_string()

String OpenDDS::DCPS::EncapsulationHeader::to_string

(

void

)

const

Definition at line 265 of file Serializer.cpp.

References kind_, KIND_CDR2_BE, KIND_CDR2_LE, KIND_CDR_BE, KIND_CDR_LE, KIND_D_CDR2_BE, KIND_D_CDR2_LE, KIND_INVALID, KIND_PL_CDR2_BE, KIND_PL_CDR2_LE, KIND_PL_CDR_BE, KIND_PL_CDR_LE, KIND_XML, and OpenDDS::DCPS::to_dds_string().

Referenced by to_encoding_i().

{
  switch (kind_) {
  case KIND_CDR_BE:
    return "CDR/XCDR1 Big Endian Plain";
  case KIND_CDR_LE:
    return "CDR/XCDR1 Little Endian Plain";
  case KIND_PL_CDR_BE:
    return "CDR/XCDR1 Big Endian Parameter List";
  case KIND_PL_CDR_LE:
    return "CDR/XCDR1 Little Endian Parameter List";
  case KIND_CDR2_BE:
    return "XCDR2 Big Endian Plain";
  case KIND_CDR2_LE:
    return "XCDR2 Little Endian Plain";
  case KIND_D_CDR2_BE:
    return "XCDR2 Big Endian Delimited";
  case KIND_D_CDR2_LE:
    return "XCDR2 Little Endian Delimited";
  case KIND_PL_CDR2_BE:
    return "XCDR2 Big Endian Parameter List";
  case KIND_PL_CDR2_LE:
    return "XCDR2 Little Endian Parameter List";
  case KIND_XML:
    return "XML";
  case KIND_INVALID:
    return "Invalid";
  default:
    return "Unknown: " + to_dds_string(static_cast<unsigned>(kind_), true);
  }
}

Member Data Documentation

kind_

Kind OpenDDS::DCPS::EncapsulationHeader::kind_

private

The first two bytes as a big endian integer.

Definition at line 295 of file Serializer.h.

Referenced by EncapsulationHeader(), from_encoding(), to_encoding_i(), OpenDDS::DCPS::Encoding::to_string(), and to_string().

options_

ACE_CDR::UShort OpenDDS::DCPS::EncapsulationHeader::options_

private

The last two bytes as a big endian integer.

Definition at line 297 of file Serializer.h.

padding_marker_alignment

const size_t OpenDDS::DCPS::EncapsulationHeader::padding_marker_alignment = 4

static

Definition at line 253 of file Serializer.h.

Referenced by set_encapsulation_options().

padding_marker_byte_index

const size_t OpenDDS::DCPS::EncapsulationHeader::padding_marker_byte_index = 3

static

Definition at line 252 of file Serializer.h.

Referenced by set_encapsulation_options().

serialized_size

const size_t OpenDDS::DCPS::EncapsulationHeader::serialized_size = 4

static

Definition at line 251 of file Serializer.h.

Referenced by OpenDDS::DCPS::operator<<(), OpenDDS::DCPS::operator>>(), OpenDDS::RTPS::Sedp::TypeLookupReplyWriter::send_type_lookup_reply(), OpenDDS::RTPS::Sedp::TypeLookupRequestWriter::send_type_lookup_request(), and OpenDDS::DCPS::serialized_size().

---

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

• Serializer.h
• Serializer.cpp
• Serializer.inl