Skip to content

Commit a13122a

Browse files
cferreiragonzmergify[bot]
cferreiragonz
authored and
mergify[bot]
committed
Add missing fields to transport descriptor documentation (#1111)
* Refs #23592: Add missing field to transport descriptor Signed-off-by: cferreiragonz <[email protected]> * Refs #23592: Remove unneeded include Signed-off-by: cferreiragonz <[email protected]> --------- Signed-off-by: cferreiragonz <[email protected]> (cherry picked from commit 76a3e66) # Conflicts: # docs/fastdds/xml_configuration/transports.rst
1 parent b55b0ea commit a13122a

File tree

2 files changed

+164
-1
lines changed

2 files changed

+164
-1
lines changed

‎code/XMLTester.xml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4035,6 +4035,26 @@
40354035
<port_queue_capacity>512</port_queue_capacity>
40364036
<healthy_check_timeout_ms>1000</healthy_check_timeout_ms>
40374037
<rtps_dump_file>rtsp_messages.log</rtps_dump_file>
4038+
<default_reception_threads>
4039+
<scheduling_policy>-1</scheduling_policy>
4040+
<priority>0</priority>
4041+
<affinity>0</affinity>
4042+
<stack_size>-1</stack_size>
4043+
</default_reception_threads>
4044+
<reception_threads>
4045+
<reception_thread port="12345">
4046+
<scheduling_policy>-1</scheduling_policy>
4047+
<priority>0</priority>
4048+
<affinity>0</affinity>
4049+
<stack_size>-1</stack_size>
4050+
</reception_thread>
4051+
</reception_threads>
4052+
<dump_thread>
4053+
<scheduling_policy>-1</scheduling_policy>
4054+
<priority>0</priority>
4055+
<affinity>0</affinity>
4056+
<stack_size>-1</stack_size>
4057+
</dump_thread>
40384058
</transport_descriptor>
40394059
</transport_descriptors>
40404060
<!-->

‎docs/fastdds/xml_configuration/transports.rst‎

Lines changed: 144 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ The following table lists all the available XML elements that can be defined wit
2323
element for the configuration of the transport layer.
2424
A more detailed explanation of each of these elements can be found in :ref:`comm-transports-configuration`.
2525

26+
<<<<<<< HEAD
2627
+-------------------------------+----------------------------------------------------+----------------------+----------+
2728
| Name | Description | Values | Default |
2829
+===============================+====================================================+======================+==========+
@@ -137,6 +138,148 @@ A more detailed explanation of each of these elements can be found in :ref:`comm
137138
| | purposes. An empty string indicates no trace |br| | | |
138139
| | will be performed (Optional, **SHM only**). | | |
139140
+-------------------------------+----------------------------------------------------+----------------------+----------+
141+
=======
142+
.. list-table::
143+
:header-rows: 1
144+
:align: left
145+
146+
* - Name
147+
- Description
148+
- Values
149+
- Default
150+
* - ``<transport_id>``
151+
- Unique name to identify each transport descriptor.
152+
- ``string``
153+
-
154+
* - ``<type>``
155+
- Type of the transport descriptor.
156+
- ``UDPv4``, ``UDPv6``, ``TCPv4``, ``TCPv6``, ``SHM``
157+
- ``UDPv4``
158+
* - ``<sendBufferSize>``
159+
- Size in bytes of the send socket buffer. If the value is zero, *Fast DDS* will use the system default socket size.
160+
- ``uint32_t``
161+
- ``0``
162+
* - ``<receiveBufferSize>``
163+
- Size in bytes of the reception socket buffer. If the value is zero, *Fast DDS* will use the system default socket size.
164+
- ``uint32_t``
165+
- ``0``
166+
* - ``<maxMessageSize>``
167+
- The maximum size in bytes of the transport's message buffer.
168+
- ``uint32_t``
169+
- ``65500``
170+
* - ``<maxInitialPeersRange>``
171+
- Number of channels opened with each initial remote peer.
172+
- ``uint32_t``
173+
- ``4``
174+
* - ``<netmask_filter>``
175+
- Transport's :ref:`netmask_filtering` configuration.
176+
- ``string``
177+
- ``AUTO``
178+
* - ``<interfaces>``
179+
- Allows defining an :ref:`ifaces_config`.
180+
- ``string``
181+
-
182+
* - ``<interfaceWhiteList>``
183+
- Allows defining an interfaces |whitelist|.
184+
- ``string``
185+
-
186+
* - ``<TTL>``
187+
- Time To Live (UDP only). See :ref:`transport_udp_udp`.
188+
- ``uint8_t``
189+
- ``1``
190+
* - ``<non_blocking_send>``
191+
- Whether to set the non-blocking send mode on the socket (NOT available for SHM type). See :ref:`transport_udp_transportDescriptor` and :ref:`transport_tcp_transportDescriptor`.
192+
- ``bool``
193+
- ``false``
194+
* - ``<output_port>``
195+
- Port used for output bound. If this field isn't defined, the output port will be random (UDP only).
196+
- ``uint16_t``
197+
- ``0``
198+
* - ``<wan_addr>``
199+
- Public WAN address when using TCPv4 transports. This field is optional if the transport doesn't need to define a WAN address (TCPv4 only).
200+
- ``string``
201+
-
202+
* - ``<keep_alive_frequency_ms>``
203+
- Frequency in milliseconds for sending :ref:`RTCP <rtcpdefinition>` keep-alive requests (TCP only).
204+
- ``uint32_t``
205+
- ``50000``
206+
* - ``<keep_alive_timeout_ms>``
207+
- Time in milliseconds since the last keep-alive request was sent to consider a connection as broken (TCP only).
208+
- ``uint32_t``
209+
- ``10000``
210+
* - ``<max_logical_port>``
211+
- The maximum number of logical ports to try during :ref:`RTCP <rtcpdefinition>` negotiations (TCP only).
212+
- ``uint16_t``
213+
- ``100``
214+
* - ``<logical_port_range>``
215+
- The maximum number of logical ports per request to try during :ref:`RTCP <rtcpdefinition>` negotiations (TCP only).
216+
- ``uint16_t``
217+
- ``20``
218+
* - ``<logical_port_increment>``
219+
- Increment between logical ports to try during :ref:`RTCP <rtcpdefinition>` negotiation (TCP only).
220+
- ``uint16_t``
221+
- ``2``
222+
* - ``<listening_ports>``
223+
- Local port to work as TCP acceptor for input connections. If not set, the transport will work as TCP client only. If set to 0, an available port will be automatically assigned (TCP only).
224+
- ``List<uint16_t>``
225+
-
226+
* - ``<tls>``
227+
- Allows to define TLS related parameters and options (TCP only).
228+
- :ref:`tcp-tls`
229+
-
230+
* - ``<calculate_crc>``
231+
- Calculates the Cyclic Redundancy Code (CRC) for error control (TCP only).
232+
- ``bool``
233+
- ``true``
234+
* - ``<check_crc>``
235+
- Check the CRC for error control (TCP only).
236+
- ``bool``
237+
- ``true``
238+
* - ``<enable_tcp_nodelay>``
239+
- Socket option for disabling the Nagle algorithm (TCP only).
240+
- ``bool``
241+
- ``false``
242+
* - ``<tcp_negotiation_timeout>``
243+
- Time to wait for logical port negotiation (in ms) (TCP only).
244+
- ``uint32_t``
245+
- ``0``
246+
* - ``<keep_alive_thread>``
247+
- Settings for the keep-alive thread.
248+
- |ThreadSettings|
249+
-
250+
* - ``<accept_thread>``
251+
- Settings for the accept thread.
252+
- |ThreadSettings|
253+
-
254+
* - ``<segment_size>``
255+
- Size (in bytes) of the shared-memory segment (Optional, SHM only).
256+
- ``uint32_t``
257+
- ``262144``
258+
* - ``<port_queue_capacity>``
259+
- Capacity (in number of messages) available to every Listener (Optional, SHM only).
260+
- ``uint32_t``
261+
- ``512``
262+
* - ``<healthy_check_timeout_ms>``
263+
- Maximum time-out (in milliseconds) used when checking whether a Listener is alive (Optional, SHM only).
264+
- ``uint32_t``
265+
- ``1000``
266+
* - ``<rtps_dump_file>``
267+
- Complete path (including file) where RTPS messages will be stored for debugging purposes. An empty string indicates no trace will be performed (Optional, SHM only).
268+
- ``string``
269+
- ``Empty``
270+
* - ``<default_reception_threads>``
271+
- Default |ThreadSettings| for the reception threads.
272+
- |ThreadSettings|
273+
-
274+
* - ``<reception_threads>``
275+
- |ThreadSettings| for the reception threads on specific ports.
276+
- ``std::map<uint32_t, ThreadSettings>``
277+
-
278+
* - ``<dump_thread>``
279+
- |ThreadSettings| for the SHM dump thread.
280+
- |ThreadSettings|
281+
-
282+
>>>>>>> 76a3e66 (Add missing fields to transport descriptor documentation (#1111))
140283

141284
The following XML code shows an example of transport protocol configuration using all configurable parameters.
142285
More examples of transports descriptors can be found in the :ref:`comm-transports-configuration` section.
@@ -145,7 +288,7 @@ More examples of transports descriptors can be found in the :ref:`comm-transport
145288
:language: xml
146289
:start-after: <!--XML_PROFILES_TRANSPORT_DESCRIPTORS-->
147290
:end-before: <!--><-->
148-
:lines: 2-4, 6-50, 52-53
291+
:lines: 2-4, 6-70, 72-73
149292

150293
.. _rtcpdefinition:
151294

0 commit comments

Comments
 (0)