Skip to content

Commit

Permalink
Doc: Improved TCP Layer documentation (#1330)
Browse files Browse the repository at this point in the history
Co-authored-by: Mathieu Rocancourt <[email protected]>
  • Loading branch information
FlorianReimold and MathieuROCANCOURT authored Jan 24, 2024
1 parent a50cbde commit 3dd14af
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion doc/rst/advanced/layers/tcp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@ eCAL TCP Layer

The eCAL TCP Transport Layer has been added with eCAL 5.10.

.. tip::

You can test TCP communication by executing the ``ecal_sample_person_snd_tcp`` samples.
That sample will **always** send data via TCP, regardless of you system configuration.

You can use the eCAL Monitor or the regular ``ecal_sample_person_rec`` sample to receive the data.

Motivation
==========

Expand Down Expand Up @@ -95,4 +102,5 @@ You can activate TCP in the following ways:

Also see the ``person_snd_tcp`` sample:

https://github.com/eclipse-ecal/ecal/tree/master/samples/cpp/person/person_snd_tcp
https://github.com/eclipse-ecal/ecal/tree/master/samples/cpp/pubsub/protobuf/person_snd_tcp

0 comments on commit 3dd14af

Please sign in to comment.