.. _program_listing_file__tmp_ws_src_fastrtps_include_fastdds_rtps_messages_CDRMessage.h:

Program Listing for File CDRMessage.h
=====================================

|exhale_lsh| :ref:`Return to documentation for file <file__tmp_ws_src_fastrtps_include_fastdds_rtps_messages_CDRMessage.h>` (``/tmp/ws/src/fastrtps/include/fastdds/rtps/messages/CDRMessage.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   // Copyright 2016 Proyectos y Sistemas de Mantenimiento SL (eProsima).
   //
   // Licensed under the Apache License, Version 2.0 (the "License");
   // you may not use this file except in compliance with the License.
   // You may obtain a copy of the License at
   //
   //     http://www.apache.org/licenses/LICENSE-2.0
   //
   // Unless required by applicable law or agreed to in writing, software
   // distributed under the License is distributed on an "AS IS" BASIS,
   // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   // See the License for the specific language governing permissions and
   // limitations under the License.
   
   #ifndef _FASTDDS_RTPS_CDRMESSAGE_H_
   #define _FASTDDS_RTPS_CDRMESSAGE_H_
   #ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC
   
   #include <fastdds/rtps/common/CDRMessage_t.h>
   #include <fastdds/rtps/common/Property.h>
   #include <fastdds/rtps/common/BinaryProperty.h>
   #include <fastdds/rtps/common/SequenceNumber.h>
   #include <fastdds/rtps/common/FragmentNumber.h>
   #include <fastdds/rtps/common/SampleIdentity.h>
   #include <fastdds/rtps/common/Time_t.h>
   #include <fastdds/rtps/common/Locator.h>
   #include <fastrtps/utils/fixed_size_string.hpp>
   
   #include <fastdds/rtps/security/common/ParticipantGenericMessage.h>
   
   namespace eprosima {
   namespace fastrtps {
   namespace rtps {
   
   namespace CDRMessage {
   
   inline bool readEntityId(
           CDRMessage_t* msg,
           EntityId_t* id);
   
   inline bool readData(
           CDRMessage_t* msg,
           octet* o,
           uint32_t length);
   
   inline bool read_array_with_max_size(
           CDRMessage_t* msg,
           octet* arr,
           size_t max_size);
   
   inline bool readDataReversed(
           CDRMessage_t* msg,
           octet* o,
           uint32_t length);
   
   inline bool readInt32(
           CDRMessage_t* msg,
           int32_t* lo);
   
   inline bool readUInt32(
           CDRMessage_t* msg,
           uint32_t* ulo);
   
   inline bool readInt64(
           CDRMessage_t* msg,
           int64_t* lolo);
   
   inline bool readUInt64(
           CDRMessage_t* msg,
           uint64_t* lolo);
   
   inline bool readSequenceNumber(
           CDRMessage_t* msg,
           SequenceNumber_t* sn);
   
   inline bool readInt16(
           CDRMessage_t* msg,
           int16_t* i16);
   
   inline bool readUInt16(
           CDRMessage_t* msg,
           uint16_t* i16);
   
   inline bool readLocator(
           CDRMessage_t* msg,
           Locator_t* loc);
   
   inline bool readOctet(
           CDRMessage_t* msg,
           octet* o);
   
   inline SequenceNumberSet_t readSequenceNumberSet(
           CDRMessage_t* msg);
   
   inline bool readFragmentNumberSet(
           CDRMessage_t* msg,
           FragmentNumberSet_t* snset);
   
   inline bool readTimestamp(
           CDRMessage_t* msg,
           Time_t* ts);
   
   inline bool readString(
           CDRMessage_t* msg,
           std::string* p_str);
   
   inline bool readString(
           CDRMessage_t* msg,
           string_255* stri);
   
   inline bool readOctetVector(
           CDRMessage_t* msg,
           std::vector<octet>* ocvec);
   
   inline bool readProperty(
           CDRMessage_t* msg,
           Property& property);
   
   inline bool readBinaryProperty(
           CDRMessage_t* msg,
           BinaryProperty& binary_property);
   
   inline bool readPropertySeq(
           CDRMessage_t* msg,
           PropertySeq& properties);
   
   inline bool readBinaryPropertySeq(
           CDRMessage_t* msg,
           BinaryPropertySeq& binary_properties);
   
   inline bool readDataHolder(
           CDRMessage_t* msg,
           DataHolder& data_holder);
   
   inline bool readDataHolderSeq(
           CDRMessage_t* msg,
           DataHolderSeq& data_holders);
   
   inline bool readMessageIdentity(
           CDRMessage_t* msg,
           security::MessageIdentity& message_identity);
   
   inline bool readParticipantGenericMessage(
           CDRMessage_t* msg,
           security::ParticipantGenericMessage& message);
   
   
   inline bool initCDRMsg(
           CDRMessage_t* msg,
           uint32_t data_size = RTPSMESSAGE_COMMON_DATA_PAYLOAD_SIZE);
   
   inline bool wrapVector(
           CDRMessage_t* msg,
           std::vector<octet>& vectorToWrap);
   
   inline bool appendMsg(
           CDRMessage_t* first,
           CDRMessage_t* second);
   
   
   
   inline bool addData(
           CDRMessage_t*,
           const octet*,
           const uint32_t number_bytes);
   inline bool addDataReversed(
           CDRMessage_t*,
           const octet*,
           const uint32_t byte_number);
   
   inline bool addOctet(
           CDRMessage_t* msg,
           octet o);
   
   inline bool addUInt16(
           CDRMessage_t* msg,
           uint16_t us);
   
   inline bool addInt32(
           CDRMessage_t* msg,
           int32_t lo);
   
   inline bool addUInt32(
           CDRMessage_t* msg,
           uint32_t lo);
   
   inline bool addInt64(
           CDRMessage_t* msg,
           int64_t lo);
   
   inline bool addUInt64(
           CDRMessage_t* msg,
           uint64_t lo);
   
   inline bool addEntityId(
           CDRMessage_t* msg,
           const EntityId_t* id);
   
   inline bool addSequenceNumber(
           CDRMessage_t* msg,
           const SequenceNumber_t* sn);
   
   inline bool addSequenceNumberSet(
           CDRMessage_t* msg,
           const SequenceNumberSet_t* sns);
   
   inline bool addFragmentNumberSet(
           CDRMessage_t* msg,
           FragmentNumberSet_t* fns);
   
   inline bool addLocator(
           CDRMessage_t* msg,
           const Locator_t& loc);
   
   inline bool add_string(
           CDRMessage_t* msg,
           const char* in_str);
   
   inline bool add_string(
           CDRMessage_t* msg,
           const std::string& in_str);
   
   inline bool add_string(
           CDRMessage_t* msg,
           const string_255& in_str);
   
   inline bool addOctetVector(
           CDRMessage_t* msg,
           const std::vector<octet>* ocvec,
           bool add_final_padding = true);
   
   inline bool addProperty(
           CDRMessage_t* msg,
           const Property& property);
   
   inline bool addBinaryProperty(
           CDRMessage_t* msg,
           const BinaryProperty& binary_property,
           bool add_final_padding = true);
   
   inline bool addPropertySeq(
           CDRMessage_t* msg,
           const PropertySeq& properties);
   
   inline bool addBinaryPropertySeq(
           CDRMessage_t* msg,
           const BinaryPropertySeq& binary_properties,
           bool add_final_padding);
   
   inline bool addBinaryPropertySeq(
           CDRMessage_t* msg,
           const BinaryPropertySeq& binary_properties,
           const std::string& name_start,
           bool add_final_padding);
   
   inline bool addDataHolder(
           CDRMessage_t* msg,
           const DataHolder& data_holder);
   
   inline bool addDataHolderSeq(
           CDRMessage_t* msg,
           const DataHolderSeq& data_holders);
   
   inline bool addMessageIdentity(
           CDRMessage_t* msg,
           const security::MessageIdentity& message_identity);
   
   inline bool addParticipantGenericMessage(
           CDRMessage_t* msg,
           const security::ParticipantGenericMessage& message);
   
   
   } /* namespace CDRMessage */
   
   } /* namespace rtps */
   } /* namespace fastrtps */
   } /* namespace eprosima */
   
   #ifndef DOXYGEN_SHOULD_SKIP_THIS
   
   #include <fastdds/rtps/messages/CDRMessage.hpp>
   
   #endif /* DOXYGEN_SHOULD_SKIP_THIS */
   #endif // ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC
   #endif /* _FASTDDS_RTPS_CDRMESSAGE_H_ */