C++ API

rmw_dds_common: ROS 2 C++ utilities for DDS-based RMWs

rmw_dds_common is a collection of C++ APIs to support DDS based, C++ RMW implementations.

Quality Declaration

This package claims to be in the Quality Level 1 category, see the Quality Declaration for more details.

API

This package contains:

• Generic graph cache

• Common discovery messages

• Data types and utilities

See feature list for further reference.

Page Hierarchy

• • QUALITY_DECLARATION
  • rmw_dds_common Features

Class Hierarchy

• • Namespace rmw_dds_common
    • Struct Compare_rmw_gid_t
    • Struct Context
    • Struct EntityInfo
    • Struct ParticipantInfo
    • Class GraphCache

File Hierarchy

• • Directory docs
    • File FEATURES.md
  • Directory include
    • Directory rmw_dds_common
      • File context.hpp
      • File gid_utils.hpp
      • File graph_cache.hpp
      • File qos.hpp
      • File security.hpp
      • File time_utils.hpp
      • File visibility_control.h
  • File QUALITY_DECLARATION.md
  • File README.md

Full C++ API

Namespaces

• Namespace rmw_dds_common

Classes and Structs

• Struct Compare_rmw_gid_t

• Struct Context

• Struct EntityInfo

• Struct ParticipantInfo

• Class GraphCache

Functions

• Function rmw_dds_common::clamp_rmw_time_to_dds_time

• Function rmw_dds_common::convert_gid_to_msg

• Function rmw_dds_common::convert_msg_to_gid

• Function rmw_dds_common::encode_type_hash_for_user_data_qos

• Function rmw_dds_common::get_security_files(const std::string&, const std::string&, std::unordered_map<std::string, std::string>&)

• Function rmw_dds_common::get_security_files(bool, const std::string&, const std::string&, std::unordered_map<std::string, std::string>&)

• Function rmw_dds_common::operator<<(std::ostream&, const rmw_gid_t&)

• Function rmw_dds_common::operator<<(std::ostream&, const GraphCache&)

• Function rmw_dds_common::operator==

• Function rmw_dds_common::parse_type_hash_from_user_data

• Function rmw_dds_common::qos_profile_check_compatible

• Function rmw_dds_common::qos_profile_get_best_available_for_publisher

• Function rmw_dds_common::qos_profile_get_best_available_for_subscription

• Function rmw_dds_common::qos_profile_get_best_available_for_topic_publisher

• Function rmw_dds_common::qos_profile_get_best_available_for_topic_subscription

• Function rmw_dds_common::qos_profile_update_best_available_for_services

Defines

• Define RMW_DDS_COMMON_EXPORT

• Define RMW_DDS_COMMON_IMPORT

• Define RMW_DDS_COMMON_LOCAL

• Define RMW_DDS_COMMON_PUBLIC

• Define RMW_DDS_COMMON_PUBLIC_TYPE

Typedefs

• Typedef rmw_dds_common::GetEndpointInfoByTopicFunction

Directories

• Directory docs

• Directory include

• Directory rmw_dds_common

Files

• File context.hpp

• File FEATURES.md

• File gid_utils.hpp

• File graph_cache.hpp

• File qos.hpp

• File QUALITY_DECLARATION.md

• File README.md

• File security.hpp

• File time_utils.hpp

• File visibility_control.h

Pages

• QUALITY_DECLARATION

• rmw_dds_common Features