rticonnextdds-connector 1.3.1 → 1.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rticonnextdds-connector",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "RTI Connector for JavaScript",
   "main": "rticonnextdds-connector.js",
   "files": [
@@ -42,5 +42,6 @@
     "mocha": "^10.2.0",
     "mocha-junit-reporter": "^2.2.0",
     "sinon": "^10.0.0"
-  }
+  },
+  "rti.build-id": "BUILD_7.6.0.0_20250918T000000Z_RTI_REL"
 }

package/rticonnextdds-connector.js

@@ -33,26 +33,20 @@ class _ConnectorBinding {
       if (os.platform() === 'linux') {
         libDir = 'linux-arm64'
         libName = 'librtiddsconnector.so'
+      } else if (os.platform() === 'darwin') {
+        libDir = 'osx-arm64'
+        libName = 'librtiddsconnector.dylib'
       } else {
         throw new Error('This platform (' + os.platform() + ' ' + os.arch() + ') is not supported')
       }
     } else if (os.arch() === 'arm') {
-      if (os.platform() === 'linux') {
-        libDir = 'linux-arm'
-        libName = 'librtiddsconnector.so'
-      } else {
-        throw new Error('This platform (' + os.platform() + ' ' + os.arch() + ') is not supported')
-      }
+      throw new Error('This platform (' + os.platform() + ' ' + os.arch() + ') is not supported')
     } else {
       // Note that we are intentionally not checking if os.arch() is x64.
       // This allows somebody with access to 32-bit libraries to replace them
       // in the corresponding x64 directory and we will try to load them.
       // This behaviour is not officially supported.
       switch (os.platform()) {
-        case 'darwin':
-          libDir = 'osx-x64'
-          libName = 'librtiddsconnector.dylib'
-          break
         case 'linux':
           libDir = 'linux-x64'
           libName = 'librtiddsconnector.so'
@@ -99,6 +93,7 @@ class _ConnectorBinding {
       this.RTI_Connector_wait_for_acknowledgments = this.api.func('RTI_Connector_wait_for_acknowledgments', 'int', ['RTI_HANDLE', 'int']);
       this.RTI_Connector_read = this.api.func('RTI_Connector_read', 'int', ['RTI_HANDLE', 'string']);
       this.RTI_Connector_take = this.api.func('RTI_Connector_take', 'int', ['RTI_HANDLE', 'string']);
+      this.RTI_Connector_return_loan = this.api.func('RTI_Connector_return_loan', 'int', ['RTI_HANDLE', 'string']);
       this.RTI_Connector_wait_for_data = this.api.func('RTI_Connector_wait_for_data', 'int', ['RTI_HANDLE', 'int']);
       this.RTI_Connector_wait_for_data_on_reader = this.api.func('RTI_Connector_wait_for_data_on_reader', 'int', ['RTI_HANDLE', 'int']);
       this.RTI_Connector_wait_for_matched_publication = this.api.func('RTI_Connector_wait_for_matched_publication', 'int', ['RTI_HANDLE', 'int', koffi.out(koffi.pointer('int'))]);
@@ -245,6 +240,14 @@ function _isNumber (value) {
   return typeof value === 'number' && isFinite(value)
 }
 
+/**
+ * Checks if a value is an object
+ * @param {any} value - The value to check the type of
+ */
+function _isObject (value) {
+  return typeof value === 'object' && value !== null
+}
+
 /**
  * Function used to get any value from either the samples or infos (depending
  * on the supplied getter). The type of the fieldName need not be specified.
@@ -1160,31 +1163,58 @@ class Input {
     return JSON.parse(str[0])
   }
 
+  /**
+   * Returns any samples held by this Input
+   *
+   * After calling this method, the samples are no longer accessible from :meth:`Input.samples`.
+   */
+  returnSamples () {
+    _checkRetcode(connectorBinding.RTI_Connector_return_loan(
+      this.connector.native,
+      this.name))
+  }
+
   /**
    * Wait for this Input to receive data.
    *
    * .. note::
    *   This operation is asynchronous.
    *
-   * @param {number} [timeout] The maximum time to wait, in milliseconds.
+   * .. note::
+   *   If no object is provided as the first parameter and for backwards compatibility,
+   *   the arguments are interpreted sequentially as defined in the documentation.
+   *
+   * @param {Object} [options] Options for the wait operation.
+   * @param {number} [options.timeout] The maximum time to wait, in milliseconds.
    *   By default, infinite.
+   * @param {boolean} [options.returnSamples] Whether to return samples before waiting.
+   *   By default ``True``. Set it to ``False`` for backwards compatibility.
    * @throws {TimeoutError} :class:`TimeoutError` will be thrown if the
    *   timeout expires before data is received.
    * @returns {Promise} A ``Promise`` which will be resolved once data is
    *   available, or rejected if the timeout expires.
    */
-  wait (timeout) {
+  wait({ timeout, returnSamples } = {}) {
     return new Promise((resolve, reject) => {
-      // timeout is defaulted to -1 (infinite) if not supplied
-      if (timeout === undefined) {
-        timeout = -1
-      } else if (!_isNumber(timeout)) {
+      /* if the first parameter was not an object, parse it */
+      if (!_isObject(arguments[0])) {
+        [ timeout, returnSamples ] = arguments
+      }
+
+      /* Assign defaults */
+      timeout ??= -1
+      returnSamples ??= true
+
+      if (!_isNumber(timeout)) {
         throw new TypeError('timeout must be a number')
       }
       if (this.waitSetBusy) {
         throw new Error('Can not concurrently wait on the same Input')
       } else {
         this.waitSetBusy = true
+        if (returnSamples) {
+          this.returnSamples()
+        }
         connectorBinding.RTI_Connector_wait_for_data_on_reader.async(
           this.native,
           timeout,