Skip to content

Commit 6bccc65

Browse files
authored
Add tcp documentation clarifications (#435)
Signed-off-by: Jesus Perez <[email protected]>
1 parent c9934c2 commit 6bccc65

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

docs/rst/user_manual/configuration.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -707,7 +707,7 @@ An Address is defined by:
707707

708708
* *IP*: IP of the host (public IP in case of WAN communication).
709709
* *Port*: Port where the Participant is listening.
710-
* *External Port*: Public port accessible for external entities (only for TCP).
710+
* *External Port*: Public port accessible for external entities (only for TCP listening-addresses).
711711
* *Transport Protocol*: ``UDP`` or ``TCP``.
712712
If it is not set, it would be chosen by default depending on the Participant Kind.
713713
* *IP version*: ``v4`` or ``v6``.
@@ -739,10 +739,12 @@ External Port
739739
-------------
740740

741741
External port is used to configure a Server (Discovery Server or Initial Peers) that runs under a NAT and uses
742-
TCP transport.
742+
TCP transport. It is not needed for LAN cases.
743743
This value could be set in a TCP listening address to differentiate the public and the internal port.
744744
**In case this value is not set, the external port is considered to be the same as the internal one.**
745745
If both ports coincide, external and internal port in the network router port forwarding rules must coincide.
746+
Client's port must match the server's external port unless server's external port is not set, in which case it
747+
should match the server's port.
746748
For more information, check section :ref:`user_manual_wan_configuration_nat_traversal_port_forwarding_external_port`.
747749

748750

docs/rst/user_manual/wan_configuration.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,19 @@ Most network routers support a graphical interface where port forwarding could b
4040
External port
4141
^^^^^^^^^^^^^
4242

43-
In order to configure the |ddsrouter| to connect under a NAT, two ports must be taken into account.
44-
The internal port (a.k.a. ``port``) is the one that the host of the |ddsrouter| will use to open a socket and
45-
to receive information.
43+
In order to configure a |ddsrouter| Server that runs under a NAT and uses TCP transport, two ports must be
44+
taken into account. The internal port (a.k.a. ``port``) is the one that the host of the |ddsrouter| will use
45+
to open a socket and to receive information.
4646
The external port (:code:`external-port`) references the public port meant for other entities to be able
4747
to locate this |ddsrouter|.
4848
Setting the external port is useful so the network router port forwarding could redirect from a public port
4949
to a different value of internal host port.
50+
Client's port must match the server's external port unless server's external port is not set, in which case it
51+
should match the server's port.
5052

5153
.. note::
5254

53-
External port configuration is not mandatory. If not set the internal and the external port must coincide
55+
External port configuration is not mandatory. If not set, the internal and the external port must coincide
5456
in the network router port forwarding rules.
5557

5658
.. warning::

0 commit comments

Comments
 (0)