Skip to content

Commit 5b807c7

Browse files
authored
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 <[email protected]> * Refs #21106: Apply suggestions Signed-off-by: elianalf <[email protected]> * Refs #21106: Add namespace Signed-off-by: elianalf <[email protected]> --------- Signed-off-by: elianalf <[email protected]>
1 parent f3615e2 commit 5b807c7

File tree

5 files changed

+18
-1
lines changed

5 files changed

+18
-1
lines changed

code/CodeTester.cpp

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
using namespace eprosima::fastdds::dds;
1717
using namespace eprosima::fastrtps;
1818
using namespace ::rtps;
19-
using namespace ::security;
2019

2120
class HelloWorld
2221
{

code/DDSCodeTester.cpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4359,6 +4359,10 @@ void dds_qos_examples()
43594359
transport.use_builtin_transports = false;
43604360
// [OPTIONAL] Set ThreadSettings for the builtin transports reception threads
43614361
transport.builtin_transports_reception_threads_ = eprosima::fastdds::rtps::ThreadSettings{2, 2, 2, 2};
4362+
// Set max_msg_size_no_frag to a value > 65500 KB
4363+
transport.max_msg_size_no_frag = 70000;
4364+
// Configure netmask filter
4365+
transport.netmask_filter = eprosima::fastdds::rtps::NetmaskFilterKind::ON;
43624366
//!--
43634367
}
43644368

code/XMLTester.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,7 @@
281281
<transport_id>my_transport</transport_id>
282282
</userTransports>
283283
<useBuiltinTransports>false</useBuiltinTransports>
284+
<netmask_filter>ON</netmask_filter>
284285
</rtps>
285286
</participant>
286287
<!--><-->

docs/03-exports/aliases-api.include

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -588,6 +588,8 @@
588588
.. |TransportConfigQos::send_socket_buffer_size-api| replace:: :cpp:member:`send_socket_buffer_size<eprosima::fastdds::dds::TransportConfigQos::send_socket_buffer_size>`
589589
.. |TransportConfigQos::listen_socket_buffer_size-api| replace:: :cpp:member:`listen_socket_buffer_size<eprosima::fastdds::dds::TransportConfigQos::listen_socket_buffer_size>`
590590
.. |TransportConfigQos::builtin_transports_reception_threads-api| replace:: :cpp:func:`builtin_transports_reception_threads()<eprosima::fastdds::dds::TransportConfigQos::builtin_transports_reception_threads>`
591+
.. |TransportConfigQos::max_msg_size_no_frag-api| replace:: :cpp:member:`max_msg_size_no_frag<eprosima::fastdds::dds::TransportConfigQos::max_msg_size_no_frag>`
592+
.. |TransportConfigQos::netmask_filter-api| replace:: :cpp:member:`netmask_filter<eprosima::fastdds::dds::TransportConfigQos::netmask_filter>`
591593

592594
.. |TransportDescriptorInterface-api| replace:: :cpp:struct:`TransportDescriptorInterface<eprosima::fastdds::rtps::TransportDescriptorInterface>`
593595
.. |TransportDescriptorInterface::maxMessageSize-api| replace:: :cpp:member:`maxMessageSize<eprosima::fastdds::rtps::TransportDescriptorInterface::maxMessageSize>`

docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1005,6 +1005,12 @@ List of QoS Policy data members:
10051005
* - |TransportConfigQos::builtin_transports_reception_threads-api|
10061006
- |ThreadSettings|
10071007
-
1008+
* - |TransportConfigQos::max_msg_size_no_frag-api|
1009+
- ``uint32_t``
1010+
- 0
1011+
* - |TransportConfigQos::netmask_filter-api|
1012+
- ``fastdds::rtps::NetmaskFilterKind``
1013+
- ``AUTO``
10081014

10091015

10101016
* |TransportConfigQos::user_transports-api|:
@@ -1020,6 +1026,11 @@ List of QoS Policy data members:
10201026
be changed using this data member.
10211027
* |TransportConfigQos::builtin_transports_reception_threads-api|:
10221028
The |ThreadSettings| for the reception threads of the builtin transports.
1029+
* |TransportConfigQos::max_msg_size_no_frag-api|:
1030+
Maximum message size used to avoid fragmentation.
1031+
Useful when the configured transports allow for big datagrams to be sent (i.e. SHM or TCP).
1032+
* |TransportConfigQos::netmask_filter-api|:
1033+
:ref:`Network filter<netmask_filtering>` configuration.
10231034

10241035
.. note::
10251036
This QoS Policy concerns to |DomainParticipant| entities.

0 commit comments

Comments
 (0)