aes70 2.0.16 → 2.0.18

package/bin/printDevice.js

@@ -7,19 +7,25 @@ import { UDPConnection } from '../src/controller/udp_connection.js';
 import { fetchDeviceContent } from '../src/controller/fetch_device_content.js';
 
 function badArguments() {
-  console.log('Usage: node print_tree.js [--json] [--udp] <ip> <port>');
+  console.log(
+    'Usage: node print_tree.js [--json] [--udp] [--progress] <ip> <port>'
+  );
   exit(1);
 }
 
 let jsonMode = false;
 let useUdp = false;
 const rest = [];
+let progress = false;
 
 argv.slice(2).forEach((option) => {
   switch (option) {
     case '--json':
       jsonMode = true;
       break;
+    case '--progress':
+      progress = true;
+      break;
     case '-h':
     case '--help':
       badArguments();
@@ -76,8 +82,13 @@ function printTreeJson(content) {
 
 async function printDevice(device) {
   try {
-    const content = await fetchDeviceContent(device);
-
+    const reportProgress = progress
+      ? (finished, total) => {
+          process.stderr.write(`\r${finished} of ${total}`);
+        }
+      : undefined;
+    const content = await fetchDeviceContent(device, reportProgress);
+    if (progress) process.stderr.write(`\ndone.\n`);
     if (jsonMode) {
       printTreeJson(content);
     } else {

package/dist/AES70.es5.js

@@ -1382,6 +1382,8 @@
 
       const t = seconds * 1000;
 
+      if (this.keepalive_interval === t) return;
+
       this.keepalive_interval = t;
 
       // Notify the other side about our new keepalive
@@ -1816,6 +1818,19 @@
       this.name = name;
       this.lastSent = 0;
       this.retries = 0;
+      this.duration = 0;
+    }
+
+    /**
+     * Sets the expected processing time for this command on the device.
+     * This duration is used when scheduling retries.
+     * Only has an effect for UDP connections.
+     *
+     * @param {number} interval
+     *  The interval in milliseconds.
+     */
+    set_duration(interval) {
+      this.duration = interval;
     }
 
     get_arguments() {
@@ -1886,7 +1901,7 @@
       this._scheduledPendingCommands = new Set();
       // All pending commands wich have been sent.
       this._sentPendingCommands = new Set();
-      this._nextCommandHandle = 0;
+      this._lastCommandHandle = 0;
       this._subscribers = new Map();
       this._sendCommandsTimer = new Timer(
         () => {
@@ -1970,8 +1985,8 @@
       }
 
       do {
-        handle = this._nextCommandHandle;
-        this._nextCommandHandle = (handle + 1) | 0;
+        handle = this._lastCommandHandle;
+        this._lastCommandHandle = (handle + 1) | 0;
       } while (pendingCommands.has(handle));
 
       return handle;
@@ -1993,6 +2008,10 @@
       }
     }
 
+    get_last_pending_command() {
+      return this._pendingCommands.get(this._lastCommandHandle);
+    }
+
     send_command(command, returnTypes, callback, stack, name) {
       const executor = (resolve, reject) => {
         const handle = this._getNextCommandHandle();
@@ -29173,6 +29192,13 @@
 
         _sentPendingCommands.delete(pendingCommand);
 
+        if (pendingCommand.lastSent + pendingCommand.duration > retryTime) {
+          // This command is expected to take longer. Simply push it back to the queue,
+          // we will pick it up later.
+          _sentPendingCommands.add(pendingCommand);
+          continue;
+        }
+
         if (pendingCommand.retries >= this.retry_count) {
           failed.push(pendingCommand);
         } else {
@@ -29188,7 +29214,8 @@
       if (failed.length) {
         const timeoutError = new Error('Timeout.');
 
-        failed.forEach(([handle, pendingCommand]) => {
+        failed.forEach((pendingCommand) => {
+          const handle = pendingCommand.handle;
           pendingCommands.delete(handle);
           pendingCommand.reject(timeoutError);
         });
@@ -29345,9 +29372,9 @@
     if (typeof value === 'object') {
       if (value instanceof Arguments) {
         return {
-          [name]: value.item(0),
-          ['Min' + name]: value.item(1),
-          ['Max' + name]: value.item(2),
+          [name]: formatValue(value.item(0)),
+          ['Min' + name]: formatValue(value.item(1)),
+          ['Max' + name]: formatValue(value.item(2)),
         };
       } else {
         value = formatValue(value);
@@ -29355,7 +29382,7 @@
     }
 
     return {
-      [name]: value,
+      [name]: formatValue(value),
     };
   }
 
@@ -29387,7 +29414,11 @@
 
           Object.assign(info, formatReturnValue(name, currentValue));
         } catch (err) {
-          if (err.status != 8)
+          // 8 - NotImplemented
+          // 11 - BadMethod
+          // Note: Some implementations respond with BadMethod for methods which have been
+          // defined in more recent vrsions of aes70
+          if (err.status != 8 && err.status != 11)
             console.error(
               'Fetching property',
               o.ClassName,
@@ -29415,10 +29446,13 @@
     }
   }
 
-  async function fetchDeviceContentRec(objects) {
+  async function fetchDeviceContentRec(objects, reportProgress) {
     const result = [];
 
     for (let i = 0; i < objects.length; i++) {
+      if (reportProgress) {
+        reportProgress(i, objects.length);
+      }
       const o = objects[i];
       const info = await fetchObjectInfo(o);
 
@@ -29437,7 +29471,7 @@
     return result;
   }
 
-  async function fetchDeviceContent(device) {
+  async function fetchDeviceContent(device, reportProgress) {
     const objects = await device.GetDeviceTree();
     const managers = [
       device.DeviceManager,
@@ -29459,7 +29493,7 @@
       if (await managerExists(manager)) objects.push(manager);
     }
 
-    return await fetchDeviceContentRec(objects);
+    return await fetchDeviceContentRec(objects, reportProgress);
   }
 
   /*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aes70",
-  "version": "2.0.16",
+  "version": "2.0.18",
   "description": "A controller library for the AES70 protocol.",
   "type": "module",
   "main": "src/index.js",

package/src/connection.js

@@ -219,6 +219,8 @@ export class Connection extends Events {
 
     const t = seconds * 1000;
 
+    if (this.keepalive_interval === t) return;
+
     this.keepalive_interval = t;
 
     // Notify the other side about our new keepalive

package/src/controller/abstract_udp_connection.js

@@ -192,6 +192,13 @@ export class AbstractUDPConnection extends ClientConnection {
 
       _sentPendingCommands.delete(pendingCommand);
 
+      if (pendingCommand.lastSent + pendingCommand.duration > retryTime) {
+        // This command is expected to take longer. Simply push it back to the queue,
+        // we will pick it up later.
+        _sentPendingCommands.add(pendingCommand);
+        continue;
+      }
+
       if (pendingCommand.retries >= this.retry_count) {
         failed.push(pendingCommand);
       } else {
@@ -207,7 +214,8 @@ export class AbstractUDPConnection extends ClientConnection {
     if (failed.length) {
       const timeoutError = new Error('Timeout.');
 
-      failed.forEach(([handle, pendingCommand]) => {
+      failed.forEach((pendingCommand) => {
+        const handle = pendingCommand.handle;
         pendingCommands.delete(handle);
         pendingCommand.reject(timeoutError);
       });

package/src/controller/client_connection.d.ts

@@ -25,7 +25,17 @@ export interface PendingCommand {
    * If available, returns the arguments of this
    * remote method call.
    */
-  get_arguments(): unknwon[] | undefined;
+  get_arguments(): unknown[] | undefined;
+
+  /**
+   * Sets the expected processing time for this command on the device.
+   * This duration is used when scheduling retries.
+   * Only has an effect for UDP connections.
+   *
+   * @param {number} interval
+   *  The interval in milliseconds.
+   */
+  set_duration(interval: number): void;
 }
 
 /**
@@ -42,4 +52,6 @@ export declare class ClientConnection extends Connection {
    *   Keepalive interval in seconds.
    */
   wait_for_keepalive(interval: number): Promise<void>;
+
+  get_last_pending_command(): PendingCommand | undefined;
 }

package/src/controller/client_connection.js

@@ -27,6 +27,19 @@ class PendingCommand {
     this.name = name;
     this.lastSent = 0;
     this.retries = 0;
+    this.duration = 0;
+  }
+
+  /**
+   * Sets the expected processing time for this command on the device.
+   * This duration is used when scheduling retries.
+   * Only has an effect for UDP connections.
+   *
+   * @param {number} interval
+   *  The interval in milliseconds.
+   */
+  set_duration(interval) {
+    this.duration = interval;
   }
 
   get_arguments() {
@@ -97,7 +110,7 @@ export class ClientConnection extends Connection {
     this._scheduledPendingCommands = new Set();
     // All pending commands wich have been sent.
     this._sentPendingCommands = new Set();
-    this._nextCommandHandle = 0;
+    this._lastCommandHandle = 0;
     this._subscribers = new Map();
     this._sendCommandsTimer = new Timer(
       () => {
@@ -181,8 +194,8 @@ export class ClientConnection extends Connection {
     }
 
     do {
-      handle = this._nextCommandHandle;
-      this._nextCommandHandle = (handle + 1) | 0;
+      handle = this._lastCommandHandle;
+      this._lastCommandHandle = (handle + 1) | 0;
     } while (pendingCommands.has(handle));
 
     return handle;
@@ -204,6 +217,10 @@ export class ClientConnection extends Connection {
     }
   }
 
+  get_last_pending_command() {
+    return this._pendingCommands.get(this._lastCommandHandle);
+  }
+
   send_command(command, returnTypes, callback, stack, name) {
     const executor = (resolve, reject) => {
       const handle = this._getNextCommandHandle();

package/src/controller/fetch_device_content.js

@@ -37,9 +37,9 @@ function formatReturnValue(name, value) {
   if (typeof value === 'object') {
     if (value instanceof Arguments) {
       return {
-        [name]: value.item(0),
-        ['Min' + name]: value.item(1),
-        ['Max' + name]: value.item(2),
+        [name]: formatValue(value.item(0)),
+        ['Min' + name]: formatValue(value.item(1)),
+        ['Max' + name]: formatValue(value.item(2)),
       };
     } else {
       value = formatValue(value);
@@ -47,7 +47,7 @@ function formatReturnValue(name, value) {
   }
 
   return {
-    [name]: value,
+    [name]: formatValue(value),
   };
 }
 
@@ -79,7 +79,11 @@ async function fetchObjectInfo(o) {
 
         Object.assign(info, formatReturnValue(name, currentValue));
       } catch (err) {
-        if (err.status != 8)
+        // 8 - NotImplemented
+        // 11 - BadMethod
+        // Note: Some implementations respond with BadMethod for methods which have been
+        // defined in more recent vrsions of aes70
+        if (err.status != 8 && err.status != 11)
           console.error(
             'Fetching property',
             o.ClassName,
@@ -107,10 +111,13 @@ async function managerExists(manager) {
   }
 }
 
-async function fetchDeviceContentRec(objects) {
+async function fetchDeviceContentRec(objects, reportProgress) {
   const result = [];
 
   for (let i = 0; i < objects.length; i++) {
+    if (reportProgress) {
+      reportProgress(i, objects.length);
+    }
     const o = objects[i];
     const info = await fetchObjectInfo(o);
 
@@ -129,7 +136,7 @@ async function fetchDeviceContentRec(objects) {
   return result;
 }
 
-export async function fetchDeviceContent(device) {
+export async function fetchDeviceContent(device, reportProgress) {
   const objects = await device.GetDeviceTree();
   const managers = [
     device.DeviceManager,
@@ -151,5 +158,5 @@ export async function fetchDeviceContent(device) {
     if (await managerExists(manager)) objects.push(manager);
   }
 
-  return await fetchDeviceContentRec(objects);
+  return await fetchDeviceContentRec(objects, reportProgress);
 }