Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Justin Wilson <[email protected]>
  • Loading branch information
iguessthislldo and jrw972 authored Jun 17, 2024
1 parent d80b91e commit 35dc6b2
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/devguide/internet_enabled_rtps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ The command-line options for the RtpsRelay:

.. option:: -AdmissionControlQueueDuration <seconds>

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 <seconds>
Expand Down
16 changes: 8 additions & 8 deletions docs/devguide/run_time_configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -1106,22 +1106,22 @@ Those properties, along with options specific to OpenDDS's RTPS discovery implem
.. prop:: ResendPeriod=<sec>
:default: ``30``

The number of seconds that a process waits between the :ref:`SPDP participants announcements <spdp>`.
The number of seconds that a process waits between the :ref:`SPDP participant announcements <spdp>`.

.. prop:: MinResendDelay=<msec>
:default: ``100``

The minimum time in milliseconds between :ref:`SPDP participants announcements <spdp>`.
The minimum time in milliseconds between :ref:`SPDP participant announcements <spdp>`.

.. prop:: QuickResendRatio=<frac>
:default: ``0.1``

Tuning parameter that configures local :ref:`SPDP participants announcement <spdp>` resends as a fraction of the resend period.
Tuning parameter that configures local :ref:`SPDP participant announcement <spdp>` resends as a fraction of the resend period.

.. prop:: LeaseDuration=<sec>
:default: ``300`` (5 minutes)

Sent as part of the :ref:`SPDP participants announcement <spdp>`.
Sent as part of the :ref:`SPDP participant announcement <spdp>`.
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=<sec>
Expand Down Expand Up @@ -1210,7 +1210,7 @@ Those properties, along with options specific to OpenDDS's RTPS discovery implem
.. prop:: SedpMulticast=<boolean>
:default: ``1``

Determines whether Multicast is used for the :ref:`SEDP <sedp>` traffic.
Determines whether multicast can be used for :ref:`SEDP <sedp>` traffic.
When set to ``1``, Multicast is used.
When set to ``0``, Unicast is used.

Expand Down Expand Up @@ -1282,7 +1282,7 @@ Those properties, along with options specific to OpenDDS's RTPS discovery implem

.. prop:: SpdpSendAddrs=<host>:<port>[,<host>:<port>]...

A list (comma or whitespace separated) of ``<host>:<port>`` pairs used as destinations for :ref:`SPDP <spdp>` content.
A list (comma or whitespace separated) of ``<host>:<port>`` pairs used as destinations for :ref:`SPDP <spdp>` messages.
This can be a combination of Unicast and Multicast addresses.

.. prop:: MaxSpdpSequenceMsgResetChecks=<n>
Expand Down Expand Up @@ -1509,7 +1509,7 @@ The :ref:`SPDP <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.
Expand Down

0 comments on commit 35dc6b2

Please sign in to comment.