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.

Sign up for GitHub

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

Jump to bottom

Add documentation for Domain ID override #88

Merged
merged 3 commits into from
Jul 10, 2023
Merged

Add documentation for Domain ID override #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c864854
Add Agent documentation of Domain ID override
Acuadros95 Jul 10, 2023
60fdbc5
Fix refs
Acuadros95 Jul 10, 2023
13a256b
Address comments
Acuadros95 Jul 10, 2023
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
9 changes: 9 additions & 0 deletions docs/agent.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,15 @@ The following is a table listing these parameters and the functionalities they c
- :code:`<number>`
- :code:`65535`

.. _agent_configuration_domain_id:

Domain ID
^^^^^^^^^

The Domain ID of the Domain Participants created by the Agent can be overrided at runtime with the environment variable ``XRCE_DOMAIN_ID_OVERRIDE``.

To allow this override, the *Client* shall use the reserved Domain ID value ``255`` when the participant is created.

.. _creation_mode_agent:

Creation Mode: Agent
Expand Down
4 changes: 2 additions & 2 deletions docs/agent_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ It returns ``true`` if the creation was successful, ``false`` otherwise.

:client_key: The identifier of the ``ProxyClient`` to which the resulting participant will be attached to.
:participant_id: The identifier of the participant to be created.
:domain_id: The DDS domain ID associated to the participant.
:domain_id: The DDS domain ID associated to the participant. The value ``255`` is can be used to configure this value on the Agent at runtime (see :ref:`agent_configuration_domain_id`).
:xml: The XML describing the participant properties.
:flag: It determines the creation mode of the new participant (see :ref:`creation_mode_client` and :ref:`creation_mode_agent`).
:op_result: The result status of this operation.
Expand All @@ -182,7 +182,7 @@ Returns ``true`` if the creation was successful, ``false`` otherwise.

:client_key: The identifier of the ``ProxyClient`` to which the resulting participant will be attached to.
:participant_id: The identifier of the participant to be created.
:domain_id: The DDS domain ID associated to the participant.
:domain_id: The DDS domain ID associated to the participant. The value ``255`` is can be used to configure this value on the Agent at runtime (see :ref:`agent_configuration_domain_id`).
:ref: The reference tag which will retrieve the participant description from the file where the references are defined, previously loaded to the *Agent*.
:flag: It determines the creation mode of the new participant (see :ref:`creation_mode_client` and :ref:`creation_mode_agent`).
:op_result: The result status of this operation.
Expand Down