Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
138 commits
Select commit Hold shift + click to select a range
ed9b205
Mention node.js support in getting_started.rst
alexcamposruiz Dec 12, 2019
1d2cc6d
Feature/con 173 node12 test (#14)
samuelraeburn Feb 10, 2020
b7bae91
CON-177: Added support for sample/view/instance state (#15)
samuelraeburn Feb 11, 2020
5047139
CON-173: Fixed unit tests which were failing
samuelraeburn Apr 7, 2020
12e7cfd
Merge pull request #16 from rticommunity/feature/CON-173-testFailures
alexcamposruiz Apr 7, 2020
60c4275
CON-173: Update docs so that we don't mention node 8 (#17)
samuelraeburn Apr 16, 2020
062e435
Feature/con 188 (#18)
samuelraeburn Jun 3, 2020
fa4dcaa
CON-209: Js doc update
alexcamposruiz Aug 25, 2020
4e40b85
Merge pull request #20 from rticommunity/featre/CON-209
alexcamposruiz Aug 27, 2020
d9f82be
Update README.md (#19)
rabbishuki Aug 28, 2020
7a6215b
Feature/con 163 test (#23)
samuelraeburn Sep 2, 2020
7a479a0
CON-212: Added CONTRIBUTING.md file (#21)
samuelraeburn Sep 2, 2020
95ecca8
CON-214: Test for creating Connector with participant_qos (#24)
samuelraeburn Sep 7, 2020
a0f9c26
CORE-10744: Updating docs for new system resource defaults (#26)
samuelraeburn Sep 18, 2020
7daef95
CON-211: updating links to other manuals for connector-js
rkorte Oct 8, 2020
11d7672
CON-211: in -js, updated GSG title and fixed an error in a GSG cross-…
rkorte Oct 8, 2020
9678318
CON-188: Updated instance support section of features.rst (#29)
samuelraeburn Oct 22, 2020
c3ea4d8
Feature/con 173 napi (#27)
samuelraeburn Oct 22, 2020
7ec97ae
GREEN-1938: Use the ffi-napi modules in tests (#30)
samuelraeburn Nov 5, 2020
9423a0b
Updated documentation to explain that we do not support Node 12.19.0.…
samuelraeburn Nov 12, 2020
3ff0d27
Feature/con 217 (#33)
samuelraeburn Dec 11, 2020
cd53ccf
PLATFORMS-1925. Updated supported platforms to match Hercules PAM.
adelleolson Jan 4, 2021
7b3116e
Merge pull request #36 from rticommunity/feature/PLATFORMS-1925-conne…
adelleolson Jan 7, 2021
8699cae
Introduce EOL normalization (#32)
samuelraeburn Jan 13, 2021
b7aa96d
CON-174: Handle armv8 architectures (#37)
samuelraeburn Jan 14, 2021
9c47ae7
CON-221: Added docs for the dynamic loading of libraries (#39)
samuelraeburn Jan 21, 2021
69ccd5c
CORE-11069: Customer facing XML has been updated (#38)
samuelraeburn Jan 21, 2021
981d39f
Feature/con 220 (#34)
samuelraeburn Jan 21, 2021
625ecbc
CON-211: merging latest develop changes into feature branch
rkorte Jan 22, 2021
8d4dda4
CON-211: removed a statement per reviewer feedback after resolving co…
rkorte Jan 22, 2021
f43aa1b
Merge pull request #28 from rticommunity/CON-211-js
rkorte Jan 22, 2021
f2c9d64
CON-215: Added release notes (#25)
samuelraeburn Jan 25, 2021
032dbe6
restore 'LICENSE.pdf' to git from lfs
samuelraeburn Jan 27, 2021
6cf228f
Removed the gitattributes file since it now has no use
samuelraeburn Jan 27, 2021
c6ac4fd
GREEN-2058: Added tests for new functionality in DD parser (#41)
samuelraeburn Feb 10, 2021
ed6d522
Updated native libs
samuelraeburn Feb 18, 2021
98b7f62
Feature/dir renames (#43)
samuelraeburn Mar 3, 2021
fa3b3e0
Merge branch 'develop' of https://www.github.com/rticommunity/rticonn…
samuelraeburn Mar 3, 2021
43b1eec
Updated platforms
samuelraeburn Mar 3, 2021
521ba02
Removed symbol from ARMv7 platform
samuelraeburn Mar 3, 2021
a3eee22
Updated submodule to feature/update-libs-for-internal-rel (#45)
samuelraeburn Mar 4, 2021
c81c831
Merge pull request #40 from rticommunity/feature/lfs-removal
alexcamposruiz Mar 5, 2021
317a8e3
Merge pull request #44 from rticommunity/feature/platforms
alexcamposruiz Mar 5, 2021
4aa4cac
Feature/release notes fix (#46)
samuelraeburn Mar 11, 2021
3ce4e64
Update README in web socket example (#48)
samuelraeburn Mar 15, 2021
6ea2cf1
Added Ubuntu 16.04 to release notes (x64, Armv8) (#47)
samuelraeburn Mar 16, 2021
89b0f93
Update minimum supported version of node v10 in docs (#49)
samuelraeburn Mar 24, 2021
b491dc9
CON-211: testing all links to core docs, fixing few that were broken …
rkorte Mar 31, 2021
35785d7
CON-215: added two new js release notes
rkorte Mar 31, 2021
3935ac9
Merge pull request #51 from rticommunity/feature/CON-211-fixes-js
rkorte Apr 1, 2021
be1b5a0
CON-194: js changes: updated copyrights, added logging to match python
rkorte Apr 2, 2021
2bd1dee
CON-194: Added additional setence to Managing Data Instances section.
samuelraeburn Apr 6, 2021
81113b4
Merge pull request #52 from rticommunity/feature/CON-215-more-js-rele…
rkorte Apr 6, 2021
0879842
Merge pull request #53 from rticommunity/feature/CON-194-js
rkorte Apr 7, 2021
5039ca8
HERCULES-186: updates to licenses doc for javascript
rkorte Apr 14, 2021
0cfe40a
Add support for loading 32-bit libs if present (#54)
samuelraeburn Apr 15, 2021
2d29271
HERCULES-186: modified lua and json-parser lines for Connector js
rkorte Apr 15, 2021
6e8afe1
Document dependency on Connext version from dynamic libs (#56)
samuelraeburn May 3, 2021
49b8d54
Merge pull request #55 from rticommunity/feature/HERCULES-186-js
rkorte May 3, 2021
203f34a
Release/connector/1.1.0 (#57) (#58)
samuelraeburn May 13, 2021
2e165e3
CON-223: Removed max_objects_per_thread API (#60)
samuelraeburn Jun 24, 2021
1d7a589
CON-178, CON-226, CON-227, CON-184 (#59)
samuelraeburn Jun 30, 2021
7ca0997
CON-92: Added APIs to obtain versions used by Connector (#61)
samuelraeburn Jun 30, 2021
9cface5
Fixed linting problems + committed the lint config file. (#63)
samuelraeburn Jun 30, 2021
2c5b560
CORE-11993: adding canonical link for connector js docs (#66)
rkorte Sep 23, 2021
85c5925
CON-191, CON-190 64-bit numner support (#64)
samuelraeburn Sep 30, 2021
c7ebb5c
PLATFORMS-2289. Adding macOS 11
adelleolson Nov 1, 2021
26b740d
PLATFORMS-2289. Applying review feedback. Don't mention version numbe…
adelleolson Nov 3, 2021
b50cd0d
Merge pull request #75 from rticommunity/feature/PLATFORMS-2289-doc-m…
adelleolson Nov 5, 2021
2ae9702
Feature/hmaint 235 (#76)
samuelraeburn Nov 9, 2021
1cf5f59
CON-246: Added warning about inf and Nan on windows (#74)
samuelraeburn Nov 15, 2021
bffd36c
CON-251: connector js release notes for 6.1.1/1.2.0
rkorte Nov 18, 2021
f3031a0
CON-252: updating links from current to 6.1.1, js
rkorte Nov 19, 2021
d98c8f3
CON-251: Doc changes for 1.2.0
samuelraeburn Nov 19, 2021
ede4831
Merge pull request #87 from rticommunity/feature/CON-252-js
rkorte Nov 19, 2021
070ec15
Merge pull request #86 from rticommunity/feature/CON-251-js
rkorte Nov 22, 2021
2c8f11d
CON-251: added missing release note
rkorte Nov 23, 2021
e2bf754
Merge pull request #92 from rticommunity/feature/CON-251-js-more
rkorte Nov 24, 2021
5fe2b51
CON-254: Document unsupport Node.JS v11 (#93)
samuelraeburn Dec 15, 2021
54827c8
CON-257: updating vulnerability assessment section again in correct b…
rkorte Feb 5, 2022
b15078d
CON-257: updated release notes and copyright for js
rkorte Feb 10, 2022
2de35df
Merge pull request #103 from rticommunity/doc/CON-257-js-again
rkorte Feb 11, 2022
ed77f01
CON-258: Update release notes to state we support v17 (#105)
samuelraeburn Feb 14, 2022
941b5c7
Feature/con 264 dependabot prs (#116)
samuelraeburn Apr 25, 2022
a3d1382
CON-264: Added release notes for 1.2.1 release (#117)
samuelraeburn Apr 25, 2022
eaca3ee
CON-261 CON-260: Document support node v18 + update node-gyp requirem…
samuelraeburn Apr 26, 2022
2f8f7a7
Feature/con 274 (#130)
samuelraeburn Oct 17, 2022
970663c
CON-276: Updated loading of redist + commit of submodule (#132)
samuelraeburn Oct 24, 2022
8a586ae
CON-276: Added release notes for CON-276 (#135)
samuelraeburn Oct 26, 2022
03897d7
CON-282: Document known limitations (#141)
samuelraeburn Nov 7, 2022
77403d8
Bump minimatch from 3.0.4 to 3.1.2 (#144)
samuelraeburn Nov 14, 2022
757c205
CON-290: Removed multiple dependencies of Connector (#155)
samuelraeburn Feb 13, 2023
3b6d263
BUILD-3774: add new CI pipelines for Connector JS (#156)
ManuelJNunez Jun 14, 2023
a04c018
CON-248: Add warning regarding the use of Infinity (#159)
samuelraeburn Sep 18, 2023
5bfbdba
Merge remote-tracking branch 'origin/master' into feature/CON-300-syn…
alejnp Dec 18, 2023
3a09c3f
CON-300: Missing bits
alejnp Dec 18, 2023
eb13657
CON-300: Removed extra bits
alejnp Dec 18, 2023
1ef602c
CON-300: Applied PR feedback
alejnp Dec 19, 2023
86ef7cc
CON-300: Updated package-lock.json
alejnp Dec 19, 2023
3e223ea
Merge pull request #162 from rticommunity/feature/CON-300-sync-branches
alejnp Dec 20, 2023
dd0dd91
CON-299: Replace incompatible library (#164)
alejnp Dec 21, 2023
7732579
COMMUNITY-67: prepare the CI to be executed for several node versions…
ManuelJNunez Dec 21, 2023
61b6829
CON-298 change package version to 1.3.0 ... (#166)
alvinkrebs Dec 21, 2023
bec1411
COMMUNITY-69 & COMMUNITY-70 | add network isolation for tests contain…
ManuelJNunez Dec 22, 2023
eb72a27
CON-298 -- Change mention of version string in doc/ (#167)
alvinkrebs Dec 29, 2023
9a99238
CON-299: Add 1.3.0 release note
lloadholt Jan 8, 2024
1c6d40b
Merge pull request #171 from rticommunity/doc/CON-299-130releasenote
lloadholt Jan 9, 2024
c72d110
Update Release Notes on supported Node versions (#169)
alejnp Jan 9, 2024
89650c7
COMMUNITY-71: add a new mechanism to publish only the documentation w…
ManuelJNunez Jan 16, 2024
aa0c865
Merge pull request #173 from rticommunity/develop
ManuelJNunez Jan 16, 2024
6bcdc61
COMMUNITY-71: remove the -doc suffix from the version string when it …
ManuelJNunez Jan 16, 2024
689b983
Merge pull request #175 from rticommunity/develop
ManuelJNunez Jan 16, 2024
1e726b1
COMMUNITY-72 | Fix documentation publication to AWS S3 (#176)
ManuelJNunez Jan 18, 2024
b07ef08
Merge pull request #177 from rticommunity/develop
ManuelJNunez Jan 18, 2024
d3e0e28
COMMUNITY-73: Update connext version string (#178)
ManuelJNunez Jan 26, 2024
33c0676
COMMUNITY-75: undo changes to config.yaml
ManuelJNunez Jan 29, 2024
39f3fa0
Merge pull request #181 from rticommunity/feature/COMMUNITY-75
ManuelJNunez Jan 29, 2024
4777af7
COMMUNITY-74 | Refactor CI pipelines to download everything from the …
ManuelJNunez Jan 30, 2024
f736aa9
COMMUNITY-76: move some files into directories and add build_doc.groo…
ManuelJNunez Jan 30, 2024
7a9853c
COMMUNITY-77: remove tag trigger to avoid accidental publications to …
ManuelJNunez Feb 1, 2024
696677f
COMMUNITY-78: update submodule
ManuelJNunez Feb 2, 2024
6211243
CON-287: Update 'maps' example dependency (#185)
alejnp Feb 2, 2024
c5a7e4c
Merge pull request #187 from rticommunity/feature/COMMUNITY-78
ManuelJNunez Feb 2, 2024
f19ec97
Merge pull request #188 from rticommunity/develop
alejnp Feb 5, 2024
972bb4e
COMMUNITY-86 | Backport COMMUNITY-79 and COMMUNITY-80 to release/conn…
ManuelJNunez Mar 6, 2024
62a9db9
CON-305: Update Platform Notes (#192)
alejnp Mar 7, 2024
ef7c34d
Apply suggestions from code review
alexcamposruiz Mar 8, 2024
45d1b64
Merge pull request #193 from rticommunity/feature/CON-305-to-release
alexcamposruiz Mar 8, 2024
5df69b2
CON-305: Update documentation (#194)
alejnp Mar 8, 2024
9072e80
Fix license pdf (#197)
alexcamposruiz Mar 8, 2024
f299a1a
Use the current lts instead of the latest one (#196)
ManuelJNunez Mar 11, 2024
b37f477
Update submodule commit
alejnp Mar 11, 2024
09b07cc
Update submodule commit
alejnp Mar 11, 2024
92495dd
CON-311: Add warning to documentation (#199)
alejnp Apr 9, 2024
7bbbe66
DOC-489: Correct headings in Previous Releases section (#200)
lloadholt Apr 9, 2024
f920b82
Update release_notes.rst (#201)
alexcamposruiz Apr 10, 2024
31db893
Update node version to one that will pass CI ...
Jul 8, 2024
798e21f
PR response, node versions update ...
Jul 9, 2024
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
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
package-lock.json binary
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,6 @@ docs/_build/
# node.js dependencies
node_modules/

# VSCode
.vscode/

Binary file modified LICENSE.pdf
Binary file not shown.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ The dependency [ref](https://www.npmjs.com/package/ref) is shipped as source cod

## License

RTI Connector for JavaScript and RTI Connector for Python are part of the Connext
DDS Professional Package. If you have a valid license for the RTI Connext DDS
Professional Package, such license shall govern your use of RTI Connector for
Python and RTI Connector for JavaScript. All other use of this software shall
RTI Connector for JavaScript is part of the Connext
Professional Package. If you have a valid license for the RTI Connext
Professional Package, such license shall govern your use of
RTI Connector for JavaScript. All other use of this software shall
be governed solely by the terms of RTI’s Software License for Non-Commercial
Use #4040, included at the top level of the `Connector for Python repository
Use #4040.
11 changes: 5 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,9 @@ source code and requires a C++11 compiler.
License
-------

RTI Connector for JavaScript and RTI Connector for Python are part of
the Connext DDS Professional Package. If you have a valid license for
the RTI Connext DDS Professional Package, such license shall govern your
use of RTI Connector for Python and RTI Connector for JavaScript. All
RTI Connector for JavaScript is part of
the Connext Professional Package. If you have a valid license for
the RTI Connext Professional Package, such license shall govern your
use of RTI Connector for JavaScript. All
other use of this software shall be governed solely by the terms of
RTI’s Software License for Non-Commercial Use #4040, included at the top
level of the \`Connector for Python repository
RTI’s Software License for Non-Commercial Use #4040.
5 changes: 5 additions & 0 deletions ci_config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
node_versions:
- "18.19"
- "19.9.0"
- "20.11"
publish_version: "20"
8 changes: 4 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@
# -- Project information -----------------------------------------------------

project = 'RTI Connector for JavaScript'
copyright = '2022, Real-Time Innovations, Inc.'
copyright = '2024, Real-Time Innovations, Inc.'
author = 'Real-Time Innovations, Inc.'

# The full version, including alpha/beta/rc tags
release = '1.2.2'
version = '1.2.2'
release = '1.3.0'
version = '1.3.0'

master_doc = 'index'
primary_domain = 'js'
Expand Down Expand Up @@ -145,7 +145,7 @@ def setup(app):
master_doc,
'rticonnectorforjavascript.tex',
'RTI Connector for Javascript',
'2022, Real-Time Innovations, Inc.',
'2024, Real-Time Innovations, Inc.',
'manual'
),
]
Expand Down
24 changes: 12 additions & 12 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ and *DataWriters*, data types and quality of service.
:align: center

*Connector* uses the XML schema defined by RTI's
`XML-Based Application Creation feature <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/xml_application_creation/index.htm>`__.
`XML-Based Application Creation feature <https://community.rti.com/static/documentation/connext-dds/7.3.0/doc/manuals/connext_dds_professional/xml_application_creation/index.htm>`__.

.. hint::
The *Connext DDS* C, C++, Java and .NET APIs can also load the same XML files
Expand Down Expand Up @@ -50,7 +50,7 @@ how they are exposed in the *Connector* API:

.. hint::

For an example configuration file, see `ShapeExample.xml <https://github.com/rticommunity/rticonnextdds-connector-py/blob/master/examples/python/ShapeExample.xml>`__.
For an example configuration file, see `ShapeExample.xml <https://github.com/rticommunity/rticonnextdds-connector-js/blob/master/examples/nodejs/ShapeExample.xml>`__.

Data types
~~~~~~~~~~
Expand All @@ -75,11 +75,11 @@ and ``shapesize``:
Types are associated with *Topics*, as explained in the next section, :ref:`Domain Library`.

.. hint::
You can define your types in IDL and convert them to XML with `rtiddsgen <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/code_generator/users_manual/index.htm>`__.
You can define your types in IDL and convert them to XML with `rtiddsgen <https://community.rti.com/static/documentation/connext-dds/7.3.0/doc/manuals/connext_dds_professional/code_generator/users_manual/index.htm>`__.
For example: ``rtiddsgen -convertToXml MyTypes.idl``

For more information about defining types, see
`Creating User Data Types with XML <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/Creating_User_Data_Types_with_Extensible.htm>`__
`Creating User Data Types with XML <https://community.rti.com/static/documentation/connext-dds/7.3.0/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/Creating_User_Data_Types_with_Extensible.htm>`__
in the *Connext DDS Core Libraries User's Manual*.

For more information about accessing the data samples, see :ref:`Accessing the data`.
Expand All @@ -89,10 +89,10 @@ Domain library

A domain library is a collection of domains. A domain specifies:

* A `domain id <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/ChoosingDomainID.htm>`__.
* A `domain id <https://community.rti.com/static/documentation/connext-dds/7.3.0/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/ChoosingDomainID.htm>`__.
* A set of registered types (from a subset of the types in ``<types>``).
A registered type can have a local name.
* A set of `topics <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/WorkingWithTopics.htm>`__,
* A set of `topics <https://community.rti.com/static/documentation/connext-dds/7.3.0/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/WorkingWithTopics.htm>`__,
which are used by *DataReaders* and *DataWriters*.

.. code-block:: xml
Expand All @@ -106,7 +106,7 @@ A domain library is a collection of domains. A domain specifies:
</domain_library>

For more information about the format of a domain library, see
`XML-Based Application Creation: Domain Library <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/DomainLibrary.htm>`__.
`XML-Based Application Creation: Domain Library <https://community.rti.com/static/documentation/connext-dds/7.3.0/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/DomainLibrary.htm>`__.

Participant library
~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -139,12 +139,12 @@ as described in :ref:`Reading data (Input)`.
</domain_participant_library>

For more information about the format of a participant library, see
`XML-Based Application Creation: Participant Library <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/ParticipantLibrary.htm>`__.
`XML-Based Application Creation: Participant Library <https://community.rti.com/static/documentation/connext-dds/7.3.0/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/ParticipantLibrary.htm>`__.

Quality of service
~~~~~~~~~~~~~~~~~~

All DDS entities have an associated `quality of service (QoS) <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/QosPolicies.htm>`__.
All DDS entities have an associated `quality of service (QoS) <https://community.rti.com/static/documentation/connext-dds/7.3.0/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/QosPolicies.htm>`__.
There are several ways to configure it.

You can define a QoS profile and make it the default. The following example
Expand Down Expand Up @@ -230,12 +230,12 @@ profile is equivalent to *MyQosProfile* above:
</qos_library>

You can read more in the *RTI Connext DDS Core Libraries User's Manual*,
`Configuring QoS with XML <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/XMLConfiguration.htm>`__.
`Configuring QoS with XML <https://community.rti.com/static/documentation/connext-dds/current/doc/manuals/connext_dds/html_files/RTI_ConnextDDS_CoreLibraries_UsersManual/index.htm#UsersManual/XMLConfiguration.htm>`__.

Logging
^^^^^^^

Logging can be configured as explained in `Configuring Logging via XML <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/Configuring_Logging_via_XML1.htm>`__.
Logging can be configured as explained in `Configuring Logging via XML <https://community.rti.com/static/documentation/connext-dds/7.3.0/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/Configuring_Logging_via_XML1.htm>`__.

For example, to increase the logging verbosity from the default (ERROR) to
WARNING, define a ``qos_profile`` with the attribute
Expand All @@ -249,4 +249,4 @@ WARNING, define a ``qos_profile`` with the attribute
<verbosity>WARNING</verbosity>
</logging>
</participant_factory_qos>
</qos_profile>
</qos_profile>
4 changes: 2 additions & 2 deletions docs/connector.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To create a new :class:`Connector`, pass an XML file and a configuration name to
const connector = new rti.Connector('MyParticipantLibrary::MyParticipant', 'ShapeExample.xml')

The XML file defines your types, QoS profiles, and DDS Entities. *Connector*
uses the XML schema of `RTI's XML-Based Application Creation <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/XMLTagsConfigEntities.htm>`__.
uses the XML schema of `RTI's XML-Based Application Creation <https://community.rti.com/static/documentation/connext-dds/7.3.0/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/XMLTagsConfigEntities.htm>`__.

The previous code loads the ``<domain_participant>`` named *MyParticipant* in
the ``<domain_participant_library>`` named *MyParticipantLibrary*, which is defined in the
Expand All @@ -42,7 +42,7 @@ When you create a :class:`Connector`, the DDS *DomainParticipant* that you selec
and all of its contained entities (*Topics*, *Subscribers*, *DataReaders*,
*Publishers*, *DataWriters*) are created.

For more information about the DDS entities, see `Core Concepts <https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/PartCoreConcepts.htm>`__
For more information about the DDS entities, see `Core Concepts <https://community.rti.com/static/documentation/connext-dds/7.3.0/doc/manuals/connext_dds_professional/users_manual/index.htm#users_manual/PartCoreConcepts.htm>`__
in the *RTI Connext DDS Core Libraries User's Manual*.

.. note::
Expand Down
16 changes: 9 additions & 7 deletions docs/copyright_license.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
Copyrights and License
**********************

© 2022 Real-Time Innovations, Inc. |br|
© 2024 Real-Time Innovations, Inc. |br|
All rights reserved. |br|
Printed in U.S.A. First printing. |br|
February 2022. |br|
March 2024. |br|

.. rubric:: License

RTI Connector for JavaScript and RTI Connector for Python are part of the Connext
DDS Professional Package. If you have a valid license for the RTI Connext DDS
Professional Package, such license shall govern your use of RTI Connector for
Python and RTI Connector for JavaScript. All other use of this software shall
RTI Connector for JavaScript is part of the Connext
Professional Package. If you have a valid license for the RTI Connext
Professional Package, such license shall govern your use of
RTI Connector for JavaScript. All other use of this software shall
be governed solely by the terms of RTI’s Software License for Non-Commercial
Use #4040, included at the top level of the `Connector for JavaScript repository
<https://github.com/rticommunity/rticonnextdds-connector-js>`__.
Expand Down Expand Up @@ -90,9 +90,11 @@ Website: https://support.rti.com/ |br|
* The source code of this software (from https://github.com/udp/json-parser)
is used to build the native libraries provided by *RTI Connector*.

* Version 1.1.0

* License:

Copyright (C) 2012, 2013, 2014 James McLaughlin et al. All rights reserved.
Copyright (C) 2012-2021 the json-parser authors All rights reserved.
https://github.com/udp/json-parser

Redistribution and use in source and binary forms, with or without
Expand Down
64 changes: 61 additions & 3 deletions docs/data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ and arrays of primitive types or structs, etc.

These types are defined in XML following the format of
`RTI's XML-Based Application Creation feature
<https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/XMLTagsConfigEntities.htm>`__.
<https://community.rti.com/static/documentation/connext-dds/7.3.0/doc/manuals/connext_dds_professional/xml_application_creation/index.htm#xml_based_app_creation_guide/UnderstandingXMLBased/XMLTagsConfigEntities.htm>`__.

To access the data, :class:`Instance` and :class:`SampleIterator` provide
setters and getters that expect a ``fieldName`` string, used to identify
Expand Down Expand Up @@ -239,6 +239,13 @@ then you must take the following into account.
The :meth:`Instance.setNumber()` operation can safely handle ``abs(value) < 2^53``,
whereas the :meth:`SampleIterator.getNumber()` operation can safely handle ``abs(value) <= 2^53``.

.. note::

The use of "Infinity", "-Infinity" and "-0" has some potential pitfalls and is
not recommended. If your application must use these values, refer to
`this knowledge base article <https://community.rti.com/kb/advanced-data-access-using-connector-javascript>`__
for more information.

Accessing structs
^^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -465,7 +472,7 @@ To clear a member, set it to ``null`` explicitly::

For more information about optional members in DDS, see
`Optional Members
<https://community.rti.com/static/documentation/connext-dds/6.1.2/doc/manuals/connext_dds_professional/extensible_types_guide/index.htm#extensible_types/Optional_Members.htm>`__
<https://community.rti.com/static/documentation/connext-dds/7.3.0/doc/manuals/connext_dds_professional/extensible_types_guide/index.htm#extensible_types/Optional_Members.htm>`__
in the *Extensible Types Guide*.

Accessing unions
Expand Down Expand Up @@ -539,4 +546,55 @@ The key fields can be accessed as follows:

.. warning::
When the sample has an instance state of ``'NOT_ALIVE_DISPOSED'`` only the
key fields should be accessed.
key fields should be accessed.

Accessing key values of disposed samples
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Using :meth:`Output.write`, an :class:`Output` can write data, or dispose or
unregister an instance.
Depending on which of these operations is performed, the ``instance_state`` of the
received sample will be ``'ALIVE'``, ``'NOT_ALIVE_NO_WRITERS'`` or ``'NOT_ALIVE_DISPOSED'``.
If the instance was disposed, this ``instance_state`` will be ``'NOT_ALIVE_DISPOSED'``.
In this state, it is possible to access the key fields of the instance that was disposed.

.. note::
:attr:`SampleInfo.valid_data` will be false when the :attr:`SampleInfo.instance_state`
is ``'NOT_ALIVE_DISPOSED'``. In this situation it's possible to access the
key fields in the received sample.

The key fields can be accessed as follows:

.. code-block::

// The output and input are using the following type:
// struct ShapeType {
// @key string<128> color;
// long x;
// long y;
// long shapesize;
// }

output.instance.set('x', 4)
output.instance.set('color', 'Green')
// Assume that some data associated with this instance has already been sent
output.write({ action: 'dispose' })
await input.wait()
input.take()
let sample = input.samples.get(0)

if (sample.info.get('instance_state') === 'NOT_ALIVE_DISPOSED') {
// sample.info.get('valid_data') will be false in this situation
// Only the key-fields should be accessed
let color = sample.get('color') // 'Green'
// The fields 'x','y' and 'shapesize' cannot be retrieved because they're
// not part of the key
// You can also call getJson() to get all of the key fields in a JSON object.
// Again, only the key fields returned within the JSON object should
// be used.
let keyValues = sample.getJson() // { color: 'Green', x: 0, y: 0, shapesize: 0 }
}

.. warning::
When the sample has an instance state of ``'NOT_ALIVE_DISPOSED'`` only the
key fields should be accessed.
Loading