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

DDS refactor #21

Merged
merged 5 commits into from
Aug 5, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/01-figures/LAN_settings_options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/01-figures/tcp_client.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/01-figures/tcp_lan_server.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/01-figures/tcp_wan_server.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 6 additions & 3 deletions docs/examples/tcp_LAN_WAN_transport.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ TCP over LAN can be tested in a scenario where several machines share the same L
nevertheless, UDP performs better and is the advisable choice in practical situations.
For this configuration example, one of the machines set up eProsima Shapes Demo as a server and all the others as
clients.
Assume that the server LAN IP address is ``192.168.2.49``, then
Assume that the server LAN IP address is ``192.168.1.75``, then
JLBuenoLopez marked this conversation as resolved.
Show resolved Hide resolved
all clients instances of eProsima Shapes Demo deployed on other machines must specify this IP Server address.
In this case, the 5100 port is selected as TCP port, but any other available TCP port is valid.

Expand Down Expand Up @@ -66,7 +66,10 @@ The following image shows server and client settings:
* On the server side, the *WAN IP* field contains the server's router IP address, i.e. i.e. the Router S IP address
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* On the server side, the *WAN IP* field contains the server's router IP address, i.e. i.e. the Router S IP address
* On the server side, the *WAN IP* field contains the server's router IP address, i.e. the Router S IP address

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

(``192.168.1.75``) since Router S NAT settings relay inbound traffic to server's TCP port towards Server computer.

.. figure:: /01-figures/WAN_settings_options.png
:alt: WAN settings options
.. figure:: /01-figures/tcp_wan_server.png
:alt: WAN Server settings options
:align: center

.. figure:: /01-figures/tcp_client.png
:alt: WAN Client settings options
:align: center
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest changing the order this figures are shown. In the text first the client side is described and then the server side, but the images follow the opposite order.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

8 changes: 7 additions & 1 deletion docs/first_steps/first_steps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ The eProsima Shapes Demo application allows the user to define additional option
To see the Options window, please go to *Options->Preferences* in the main bar.
The following image shows the Options Menu.

.. image:: /01-figures/options.png
.. image:: /01-figures/LAN_settings_options.png
:scale: 75 %
:alt: Options Window
:align: center
Expand Down Expand Up @@ -160,6 +160,12 @@ The user can customize several aspects of Shapes Demo operation:

+ Push the *Start* button in order to resume Shapes Demo operation.

- **Shared Memory Transport:** Fast DDS transport using Shared Memory Segment for Participants running in the same
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure why but when generating the documentation locally, this option is shown in a blue box. Can you check in your side if it is something happening only on my side?

host.

- **Intraprocess:** Allow Intraprocess delivery when two Participants run in the same process.

- **Data SHaring:** Allow Data Sharing delivery when two Participants run in the same process.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Data SHaring:** Allow Data Sharing delivery when two Participants run in the same process.
- **Data Sharing:** Allow Data Sharing delivery when two Participants run in the same process.

I suggest adding a link to the Fast DDS documentation in all these new options so the user can have easy access to a more in-depth explanation of the option.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


- **Domain ID:** The user can select different Domain IDs.
Shapes Demo instances using different Domain IDs will not communicate.
Expand Down