From 35dc6b2c2d21984d1c8392de5ccfb1f011e949e2 Mon Sep 17 00:00:00 2001 From: Fred Hornsey Date: Mon, 17 Jun 2024 10:42:53 -0500 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Justin Wilson --- docs/devguide/internet_enabled_rtps.rst | 2 +- docs/devguide/run_time_configuration.rst | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/devguide/internet_enabled_rtps.rst b/docs/devguide/internet_enabled_rtps.rst index 7bfcbb1b8c3..57076c0fe53 100644 --- a/docs/devguide/internet_enabled_rtps.rst +++ b/docs/devguide/internet_enabled_rtps.rst @@ -283,7 +283,7 @@ The command-line options for the RtpsRelay: .. option:: -AdmissionControlQueueDuration - New client participants in the :option:`admission control queue <-AdmissionControlQueueSize>` that are taking longer than this many seconds to perform discovery are kicked out of the queue. + New client participants in the :option:`admission control queue <-AdmissionControlQueueSize>` that are taking longer than this many seconds to perform discovery are removed from the queue. Default is 0. .. option:: -PublishRelayStatus diff --git a/docs/devguide/run_time_configuration.rst b/docs/devguide/run_time_configuration.rst index 9cd7469aa96..eb400378476 100644 --- a/docs/devguide/run_time_configuration.rst +++ b/docs/devguide/run_time_configuration.rst @@ -1030,7 +1030,7 @@ Configuring for RTPS Discovery This section describes the configuration properties for :ref:`rtps-disc`. -To configure RTPS discovery, it's helpful to understand that it is composed of 2 distinct protocols: +To configure RTPS discovery, it's helpful to understand that it is composed of two distinct protocols: .. _spdp: @@ -1106,22 +1106,22 @@ Those properties, along with options specific to OpenDDS's RTPS discovery implem .. prop:: ResendPeriod= :default: ``30`` - The number of seconds that a process waits between the :ref:`SPDP participants announcements `. + The number of seconds that a process waits between the :ref:`SPDP participant announcements `. .. prop:: MinResendDelay= :default: ``100`` - The minimum time in milliseconds between :ref:`SPDP participants announcements `. + The minimum time in milliseconds between :ref:`SPDP participant announcements `. .. prop:: QuickResendRatio= :default: ``0.1`` - Tuning parameter that configures local :ref:`SPDP participants announcement ` resends as a fraction of the resend period. + Tuning parameter that configures local :ref:`SPDP participant announcement ` resends as a fraction of the resend period. .. prop:: LeaseDuration= :default: ``300`` (5 minutes) - Sent as part of the :ref:`SPDP participants announcement `. + Sent as part of the :ref:`SPDP participant announcement `. It tells the peer participants that if they don't hear from this participant for the specified duration, then this participant can be considered "not alive". .. prop:: LeaseExtension= @@ -1210,7 +1210,7 @@ Those properties, along with options specific to OpenDDS's RTPS discovery implem .. prop:: SedpMulticast= :default: ``1`` - Determines whether Multicast is used for the :ref:`SEDP ` traffic. + Determines whether multicast can be used for :ref:`SEDP ` traffic. When set to ``1``, Multicast is used. When set to ``0``, Unicast is used. @@ -1282,7 +1282,7 @@ Those properties, along with options specific to OpenDDS's RTPS discovery implem .. prop:: SpdpSendAddrs=:[,:]... - A list (comma or whitespace separated) of ``:`` pairs used as destinations for :ref:`SPDP ` content. + A list (comma or whitespace separated) of ``:`` pairs used as destinations for :ref:`SPDP ` messages. This can be a combination of Unicast and Multicast addresses. .. prop:: MaxSpdpSequenceMsgResetChecks= @@ -1509,7 +1509,7 @@ The :ref:`SPDP ` unicast port will be one of the following: - Port from :prop:`SpdpLocalAddress` if set - A system-provided port if :val:`SpdpPortMode=system` -- :prop:`PB` + :prop:`DG` × *domainId* + :prop:`D1` + :prop:`PG` × *participantId* if :val:`SpdpPortMode=probe` is set (default) +- :prop:`PB` + :prop:`DG` × *domainId* + :prop:`D1` + :prop:`PG` × *participantId* if :val:`SpdpPortMode=probe` (default) - *participantId* starts at 0 and if the port can not be opened, then the *participantId* is incremented until a port can be opened. - If no valid UDP port can be opened, then an error will be logged.