Skip to content

Commit

Permalink
Add missing documentation of netmask filter and max_msg_size_no_frag …
Browse files Browse the repository at this point in the history
…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 5b807c7)

# Conflicts:
#	code/CodeTester.cpp
  • Loading branch information
elianalf authored and mergify[bot] committed May 29, 2024
1 parent 40248e8 commit fc0e35e
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 0 deletions.
3 changes: 3 additions & 0 deletions code/CodeTester.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,12 @@

using namespace eprosima::fastrtps;
using namespace ::rtps;
<<<<<<< HEAD
using namespace ::security;
using namespace ::types;
using SharedMemTransportDescriptor = eprosima::fastdds::rtps::SharedMemTransportDescriptor;
=======
>>>>>>> 5b807c7 (Add missing documentation of netmask filter and max_msg_size_no_frag in TransportConfigQos (#788))

class HelloWorld
{
Expand Down
4 changes: 4 additions & 0 deletions code/DDSCodeTester.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -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;
//!--
}

Expand Down
1 change: 1 addition & 0 deletions code/XMLTester.xml
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,7 @@
<transport_id>my_transport</transport_id>
</userTransports>
<useBuiltinTransports>false</useBuiltinTransports>
<netmask_filter>ON</netmask_filter>
</rtps>
</participant>
<!--><-->
Expand Down
2 changes: 2 additions & 0 deletions docs/03-exports/aliases-api.include
Original file line number Diff line number Diff line change
Expand Up @@ -589,6 +589,8 @@
.. |TransportConfigQos::send_socket_buffer_size-api| replace:: :cpp:member:`send_socket_buffer_size<eprosima::fastdds::dds::TransportConfigQos::send_socket_buffer_size>`
.. |TransportConfigQos::listen_socket_buffer_size-api| replace:: :cpp:member:`listen_socket_buffer_size<eprosima::fastdds::dds::TransportConfigQos::listen_socket_buffer_size>`
.. |TransportConfigQos::builtin_transports_reception_threads-api| replace:: :cpp:func:`builtin_transports_reception_threads()<eprosima::fastdds::dds::TransportConfigQos::builtin_transports_reception_threads>`
.. |TransportConfigQos::max_msg_size_no_frag-api| replace:: :cpp:member:`max_msg_size_no_frag<eprosima::fastdds::dds::TransportConfigQos::max_msg_size_no_frag>`
.. |TransportConfigQos::netmask_filter-api| replace:: :cpp:member:`netmask_filter<eprosima::fastdds::dds::TransportConfigQos::netmask_filter>`

.. |TransportDescriptorInterface-api| replace:: :cpp:struct:`TransportDescriptorInterface<eprosima::fastdds::rtps::TransportDescriptorInterface>`
.. |TransportDescriptorInterface::maxMessageSize-api| replace:: :cpp:member:`maxMessageSize<eprosima::fastdds::rtps::TransportDescriptorInterface::maxMessageSize>`
Expand Down
11 changes: 11 additions & 0 deletions docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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|:
Expand All @@ -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<netmask_filtering>` configuration.

.. note::
This QoS Policy concerns to |DomainParticipant| entities.
Expand Down

0 comments on commit fc0e35e

Please sign in to comment.