Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[21106] Add missing documentation of netmask filter and max_msg_size_no_frag in TransportConfigQos #788

Merged
merged 3 commits into from
May 29, 2024
Merged

[21106] Add missing documentation of netmask filter and max_msg_size_no_frag in TransportConfigQos #788

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7c04632
Refs #21106: Add missing missing documentation of netmask filter and …
elianalf May 28, 2024
73f90eb
Refs #21106: Apply suggestions
elianalf May 28, 2024
e6bbc0b
Refs #21106: Add namespace
elianalf May 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion code/CodeTester.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
using namespace eprosima::fastdds::dds;
using namespace eprosima::fastrtps;
using namespace ::rtps;
using namespace ::security;

class HelloWorld
{
Expand Down
4 changes: 4 additions & 0 deletions code/DDSCodeTester.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4359,6 +4359,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 = NetmaskFilterKind::ON;
MiguelCompany marked this conversation as resolved.
Show resolved Hide resolved
//!--
}

Expand Down
1 change: 1 addition & 0 deletions code/XMLTester.xml
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,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
View file
Open in desktop
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``
MiguelCompany marked this conversation as resolved.
Show resolved Hide resolved


* |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