From 159cbf7ee176770af6970bc267ad4ce25b299d65 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Thu, 6 Jun 2024 07:48:46 +0200 Subject: [PATCH] Add missing documentation of netmask filter and max_msg_size_no_frag in TransportConfigQos (#788) (#789) * Add missing documentation of netmask filter and max_msg_size_no_frag in TransportConfigQos (#788) * Refs #21106: Add missing missing documentation of netmask filter and max_msg_size_no_frag in TransportConfigQos Signed-off-by: elianalf <62831776+elianalf@users.noreply.github.com> * Refs #21106: Apply suggestions Signed-off-by: elianalf <62831776+elianalf@users.noreply.github.com> * Refs #21106: Add namespace Signed-off-by: elianalf <62831776+elianalf@users.noreply.github.com> --------- Signed-off-by: elianalf <62831776+elianalf@users.noreply.github.com> (cherry picked from commit 5b807c7d5af92869222b6af94320f129ede2b4f4) # Conflicts: # code/CodeTester.cpp * Fix conflicts Signed-off-by: eduponz * Remove log error from test Signed-off-by: eduponz --------- Signed-off-by: eduponz Co-authored-by: elianalf <62831776+elianalf@users.noreply.github.com> Co-authored-by: eduponz --- code/CodeTester.cpp | 1 - code/DDSCodeTester.cpp | 4 ++++ code/XMLTester.xml | 3 ++- docs/03-exports/aliases-api.include | 2 ++ .../dds_layer/core/policy/eprosimaExtensions.rst | 11 +++++++++++ 5 files changed, 19 insertions(+), 2 deletions(-) diff --git a/code/CodeTester.cpp b/code/CodeTester.cpp index 67917655b..c9ccb4b04 100644 --- a/code/CodeTester.cpp +++ b/code/CodeTester.cpp @@ -25,7 +25,6 @@ using namespace eprosima::fastrtps; using namespace ::rtps; -using namespace ::security; using namespace ::types; using SharedMemTransportDescriptor = eprosima::fastdds::rtps::SharedMemTransportDescriptor; diff --git a/code/DDSCodeTester.cpp b/code/DDSCodeTester.cpp index ffe57f831..0eae142eb 100644 --- a/code/DDSCodeTester.cpp +++ b/code/DDSCodeTester.cpp @@ -4223,6 +4223,10 @@ void dds_qos_examples() transport.use_builtin_transports = false; // [OPTIONAL] Set ThreadSettings for the builtin transports reception threads transport.builtin_transports_reception_threads_ = eprosima::fastdds::rtps::ThreadSettings{2, 2, 2, 2}; + // Set max_msg_size_no_frag to a value > 65500 KB + transport.max_msg_size_no_frag = 70000; + // Configure netmask filter + transport.netmask_filter = eprosima::fastdds::rtps::NetmaskFilterKind::ON; //!-- } diff --git a/code/XMLTester.xml b/code/XMLTester.xml index 09f0e91d7..681b44371 100644 --- a/code/XMLTester.xml +++ b/code/XMLTester.xml @@ -245,7 +245,7 @@ CONF-COMMON-RECEPTION-THREADS-SETTINGS<--> - Test + thread_config_transport UDPv4 @@ -281,6 +281,7 @@ my_transport false + ON <--> diff --git a/docs/03-exports/aliases-api.include b/docs/03-exports/aliases-api.include index 6443ae772..80e1052e2 100644 --- a/docs/03-exports/aliases-api.include +++ b/docs/03-exports/aliases-api.include @@ -589,6 +589,8 @@ .. |TransportConfigQos::send_socket_buffer_size-api| replace:: :cpp:member:`send_socket_buffer_size` .. |TransportConfigQos::listen_socket_buffer_size-api| replace:: :cpp:member:`listen_socket_buffer_size` .. |TransportConfigQos::builtin_transports_reception_threads-api| replace:: :cpp:func:`builtin_transports_reception_threads()` +.. |TransportConfigQos::max_msg_size_no_frag-api| replace:: :cpp:member:`max_msg_size_no_frag` +.. |TransportConfigQos::netmask_filter-api| replace:: :cpp:member:`netmask_filter` .. |TransportDescriptorInterface-api| replace:: :cpp:struct:`TransportDescriptorInterface` .. |TransportDescriptorInterface::maxMessageSize-api| replace:: :cpp:member:`maxMessageSize` diff --git a/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst b/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst index 377ec6c59..e25e3b672 100644 --- a/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst +++ b/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst @@ -1005,6 +1005,12 @@ List of QoS Policy data members: * - |TransportConfigQos::builtin_transports_reception_threads-api| - |ThreadSettings| - + * - |TransportConfigQos::max_msg_size_no_frag-api| + - ``uint32_t`` + - 0 + * - |TransportConfigQos::netmask_filter-api| + - ``fastdds::rtps::NetmaskFilterKind`` + - ``AUTO`` * |TransportConfigQos::user_transports-api|: @@ -1020,6 +1026,11 @@ List of QoS Policy data members: be changed using this data member. * |TransportConfigQos::builtin_transports_reception_threads-api|: The |ThreadSettings| for the reception threads of the builtin transports. +* |TransportConfigQos::max_msg_size_no_frag-api|: + Maximum message size used to avoid fragmentation. + Useful when the configured transports allow for big datagrams to be sent (i.e. SHM or TCP). +* |TransportConfigQos::netmask_filter-api|: + :ref:`Network filter` configuration. .. note:: This QoS Policy concerns to |DomainParticipant| entities.