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.

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

[20314] Update TCP documentation #654

Merged
merged 5 commits into from
Feb 14, 2024
Merged

[20314] Update TCP documentation #654

merged 5 commits into from
Feb 14, 2024

Conversation

jepemi
Copy link
Contributor

@jepemi jepemi commented Jan 31, 2024

TCP documentation had some confusing examples (even repeated for normal and WAN use).

  • Existing examples have been modified (Tested).
  • Added new WAN examples (Tested)
  • Added clarifications on manually configured unicast locators and initial peers configuration.

There are no related Fast DDS updates.

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
@EduPonz EduPonz added this to the v2.13.2 milestone Feb 6, 2024
@EduPonz EduPonz merged commit 6c2c47a into master Feb 14, 2024
4 checks passed
@EduPonz EduPonz deleted the hotfix/tcp_examples branch February 14, 2024 19:15
@EduPonz
Copy link

EduPonz commented Feb 14, 2024

@Mergifyio backport 2.6.x 2.10.x 2.11.x 2.12.x

Copy link

mergify bot commented Feb 14, 2024

backport 2.6.x 2.10.x 2.11.x 2.12.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Feb 14, 2024
* Refs #20314: Update TCP LAN example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Update TCP WAN example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Update TCP TLS example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Minor fixes

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Extend WAN description, update image and modify examples

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

---------

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
(cherry picked from commit 6c2c47a)

# Conflicts:
#	code/DDSCodeTester.cpp
#	code/XMLTester.xml
#	docs/fastdds/transport/tcp/tcp.rst
mergify bot pushed a commit that referenced this pull request Feb 14, 2024
* Refs #20314: Update TCP LAN example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Update TCP WAN example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Update TCP TLS example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Minor fixes

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Extend WAN description, update image and modify examples

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

---------

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
(cherry picked from commit 6c2c47a)

# Conflicts:
#	code/DDSCodeTester.cpp
#	code/XMLTester.xml
#	docs/fastdds/transport/tcp/tcp.rst
mergify bot pushed a commit that referenced this pull request Feb 14, 2024
* Refs #20314: Update TCP LAN example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Update TCP WAN example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Update TCP TLS example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Minor fixes

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Extend WAN description, update image and modify examples

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

---------

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
(cherry picked from commit 6c2c47a)

# Conflicts:
#	code/XMLTester.xml
#	docs/fastdds/transport/tcp/tcp.rst
mergify bot pushed a commit that referenced this pull request Feb 14, 2024
* Refs #20314: Update TCP LAN example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Update TCP WAN example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Update TCP TLS example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Minor fixes

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Extend WAN description, update image and modify examples

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

---------

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
(cherry picked from commit 6c2c47a)

# Conflicts:
#	code/XMLTester.xml
#	docs/fastdds/transport/tcp/tcp.rst
EduPonz pushed a commit that referenced this pull request Feb 15, 2024
* Update TCP documentation (#654)

* Refs #20314: Update TCP LAN example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Update TCP WAN example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Update TCP TLS example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Minor fixes

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Extend WAN description, update image and modify examples

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

---------

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
(cherry picked from commit 6c2c47a)

# Conflicts:
#	code/XMLTester.xml
#	docs/fastdds/transport/tcp/tcp.rst

* Refs #20314: Resolve conflicts

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

---------

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
Co-authored-by: Jesús Pérez <78275223+jepemi@users.noreply.github.com>
Co-authored-by: Jesus Perez <jesusperez@eprosima.com>
MiguelCompany pushed a commit that referenced this pull request Feb 29, 2024
* Update TCP documentation (#654)

* Refs #20314: Update TCP LAN example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Update TCP WAN example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Update TCP TLS example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Minor fixes

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Extend WAN description, update image and modify examples

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

---------

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
(cherry picked from commit 6c2c47a)

# Conflicts:
#	code/DDSCodeTester.cpp
#	code/XMLTester.xml
#	docs/fastdds/transport/tcp/tcp.rst

* Refs #20314: Resolve conflicts

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Fix xml tester

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

---------

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
Co-authored-by: Jesús Pérez <78275223+jepemi@users.noreply.github.com>
Co-authored-by: Jesus Perez <jesusperez@eprosima.com>
elianalf pushed a commit that referenced this pull request Mar 14, 2024
* Update TCP documentation (#654)

* Refs #20314: Update TCP LAN example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Update TCP WAN example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Update TCP TLS example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Minor fixes

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Extend WAN description, update image and modify examples

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

---------

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
(cherry picked from commit 6c2c47a)

# Conflicts:
#	code/XMLTester.xml
#	docs/fastdds/transport/tcp/tcp.rst

* Refs #20314: Resolve conflicts

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

---------

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
Co-authored-by: Jesús Pérez <78275223+jepemi@users.noreply.github.com>
Co-authored-by: Jesus Perez <jesusperez@eprosima.com>
Mario-DL pushed a commit that referenced this pull request Apr 16, 2024
* Update TCP documentation (#654)

* Refs #20314: Update TCP LAN example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Update TCP WAN example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Update TCP TLS example

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Minor fixes

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Extend WAN description, update image and modify examples

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

---------

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
(cherry picked from commit 6c2c47a)

# Conflicts:
#	code/DDSCodeTester.cpp
#	code/XMLTester.xml
#	docs/fastdds/transport/tcp/tcp.rst

* Refs #20314: Resolve conflicts

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

* Refs #20314: Fix xml tester

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>

---------

Signed-off-by: Jesus Perez <jesusperez@eprosima.com>
Co-authored-by: Jesús Pérez <78275223+jepemi@users.noreply.github.com>
Co-authored-by: Jesus Perez <jesusperez@eprosima.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants