Skip to content

Commit

Permalink
Use cfg Domain in Transport and Remaining Sections
Browse files Browse the repository at this point in the history
  • Loading branch information
iguessthislldo committed Apr 15, 2024
1 parent f3fa995 commit e8ee1db
Show file tree
Hide file tree
Showing 9 changed files with 640 additions and 742 deletions.
15 changes: 13 additions & 2 deletions docs/devguide/building/cmake.rst
Original file line number Diff line number Diff line change
Expand Up @@ -345,22 +345,32 @@ The CMake package can provide executable targets that can be called manually fro

.. cmake:tgt:: TAO::tao_idl
Required
Required, :term:`tao_idl`

.. cmake:tgt:: OpenDDS::opendds_idl
Required
Required, :ref:`opendds_idl`

.. cmake:tgt:: OpenDDS::DCPSInfoRepo
:ref:`inforepo`

.. cmake:tgt:: OpenDDS::RtpsRelay
:ref:`rtpsrelay`

.. cmake:tgt:: OpenDDS::dcpsinfo_dump
Utility for :ref:`inforepo`

.. cmake:tgt:: OpenDDS::inspect
:ghfile:`tools/inspect/README.rst`

.. cmake:tgt:: OpenDDS::repoctl
Utility for :ref:`inforepo`

Functions
=========

Expand Down Expand Up @@ -805,6 +815,7 @@ Dependencies
:no-contents-entry:

Path to :ref:`deps-java`
Currently unsupported.

.. cmake:var:: OPENDDS_QT
:no-contents-entry:
Expand Down
6 changes: 3 additions & 3 deletions docs/devguide/internet_enabled_rtps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Using the RtpsRelay
Sect<15.2.1>
Support for the RtpsRelay is activated via configuration.
See :cfg:sec:`rtps_discovery` and ``transport@rtps_udp`` for details.
See :cfg:sec:`rtps_discovery` and :cfg:sec:`transport@rtps_udp` for details.
As an example:

.. code-block:: ini
Expand Down Expand Up @@ -336,8 +336,8 @@ ICE utilizes the STUN protocol that is defined in :rfc:`5389`.
The ICE implementation in OpenDDS does not use TURN servers.

ICE is enabled through configuration.
The minimum configuration involves setting the :cfg:prop:`[rtps_discovery]UseIce` and ``[transport@rtps_udp]UseIce`` flags and providing addresses for the STUN servers.
See :cfg:sec:`rtps_discovery` and ``transport@rtps_udp`` for details.
The minimum configuration involves setting the :cfg:prop:`[rtps_discovery]UseIce` and :cfg:prop:`[transport@rtps_udp]UseIce` flags and providing addresses for the STUN servers.
See :cfg:sec:`rtps_discovery` and :cfg:sec:`transport@rtps_udp` for details.

.. code-block:: ini
Expand Down
14 changes: 7 additions & 7 deletions docs/devguide/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -360,11 +360,11 @@ It also makes it easier to replace these libraries with custom ones.

- :ref:`security <sec>` [#plugins-sec]_

How to enable and use a particular plugin will differ based on the kind of plugin and the plugin itself, but generally they are enabled by some form of configuration setting, for example using ``[transport]transport_type`` or :cfg:prop:`DCPSSecurity` in a configuration file.
How to enable and use a particular plugin will differ based on the kind of plugin and the plugin itself, but generally they are enabled by some form of configuration setting, for example using :cfg:prop:`[transport]transport_type` or :cfg:prop:`DCPSSecurity` in a configuration file.
The plugin will also have to be linked and initialized at runtime.
For dynamic libraries (``.dll``, ``.dynlib`` or, ``.so`` files) this is done automatically as the OpenDDS will load the dynamic library and then run any initialization the plugin requires.
When the plugins are statically linked, then it requires explicit linking and including an initialization header in the application that contains a global object that will initialize the plugin.
If OpenDDS was :ref:`built using CMake <cmake-building>`, then :ghfile:`dds/DCPS/StaticIncludes.h` can be included and the initialization headers will be included automatically.
If OpenDDS was :ref:`built using CMake <cmake-building>`, then :ghfile:`dds/DCPS/StaticIncludes.h` can be included and the initialization headers will be included automatically based on the :ref:`static libraries <cmake-libraries>` that were linked.
Explicit linking and initialization headers can also be used with dynamic libraries.
This will always load and initialize the plugin when the application starts instead of delaying until the plugin is needed.

Expand Down Expand Up @@ -403,7 +403,7 @@ It's :ref:`reliable <qos-reliability>`, regardless of configuration.

:ref:`Initialization header <plugins>`: :ghfile:`dds/DCPS/transport/tcp/Tcp.h`

``[transport]transport_type``: ``tcp``
:cfg:prop:`[transport]transport_type`: :cfg:val:`tcp <[transport]transport_type=tcp>`

Configuration: :ref:`tcp-transport-config`

Expand All @@ -427,7 +427,7 @@ It supports :ref:`reliability <qos-reliability>`.

:ref:`Initialization header <plugins>`: :ghfile:`dds/DCPS/transport/rtps_udp/RtpsUdp.h`

``[transport]transport_type``: ``rtps_udp``
:cfg:prop:`[transport]transport_type`: :cfg:val:`rtps_udp <[transport]transport_type=rtps_udp>`

Configuration: :ref:`rtps-udp-transport-config`

Expand Down Expand Up @@ -457,7 +457,7 @@ It doesn't support :ref:`reliability <qos-reliability>` at all.

:ref:`Initialization header <plugins>`: :ghfile:`dds/DCPS/transport/udp/Udp.h`

``[transport]transport_type``: ``udp``
:cfg:prop:`[transport]transport_type`: :cfg:val:`udp <[transport]transport_type=udp>`

Configuration: :ref:`udp-transport-config`

Expand All @@ -479,7 +479,7 @@ It supports :ref:`reliability <qos-reliability>`.

:ref:`Initialization header <plugins>`: :ghfile:`dds/DCPS/transport/multicast/Multicast.h`

``[transport]transport_type``: ``mulicast``
:cfg:prop:`[transport]transport_type`: :cfg:val:`multicast <[transport]transport_type=multicast>`

Configuration: :ref:`multicast-transport-config`

Expand All @@ -505,7 +505,7 @@ It's :ref:`reliable <qos-reliability>`, regardless of configuration.

:ref:`Initialization header <plugins>`: :ghfile:`dds/DCPS/transport/shmem/Shmem.h`

``[transport]transport_type``: ``shmem``
:cfg:prop:`[transport]transport_type`: :cfg:val:`shmem <[transport]transport_type=shmem>`

Configuration: :ref:`shmem-transport-config`

Expand Down
Loading

0 comments on commit e8ee1db

Please sign in to comment.