aes70 2.0.2 → 2.0.4

package/dist/AES70.es5.js

@@ -61,6 +61,10 @@
      * @param {Function} cb - Callback function.
      */
     on(name, cb) {
+      if (typeof name !== 'string')
+        throw new TypeError('Event name must be a string.');
+      if (typeof cb !== 'function')
+        throw new TypeError('Event handler must be a function.');
       let handlers = this.event_handlers.get(name);
 
       if (!handlers) {
@@ -90,12 +94,36 @@
       handlers.delete(cb);
     }
 
+    /**
+     * Removes an event handler.
+     *
+     * @param {strign} name
+     * @param {Function} cb
+     */
+    off(name, cb) {
+      this.removeEventListener(name, cb);
+    }
+
     /**
      * Removes all event listeners.
      */
     removeAllEventListeners() {
       this.event_handlers.clear();
     }
+
+    /**
+     *
+     * @param {string} name
+     * @param {Function} cb
+     */
+    subscribe(name, cb) {
+      this.on(name, cb);
+      return () => {
+        if (name === undefined) return;
+        this.off(name, cb);
+        name = undefined;
+      };
+    }
   }
 
   class PDU {
@@ -1185,6 +1213,12 @@
      *    Keepalive interval in seconds.
      */
     set_keepalive_interval(seconds) {
+      if (!(seconds <= 10)) {
+        console.warn(
+          'Unusually large keepalive interval %o seconds. Confusion of ms vs. seconds?'
+        );
+      }
+
       const t = seconds * 1000;
 
       if (this._keepalive_interval_id !== null) {
@@ -1782,11 +1816,45 @@
           if (!(o.time > 0)) {
             throw new Error('Bad keepalive timeout.');
           }
+          this.emit('keepalive', o);
         } else {
           throw new Error('Unexpected PDU');
         }
       }
     }
+
+    /**
+     * Activates keepalive handling (using set_keepalive_interval) and waits for
+     * at least one keepalive packet to arrive. If no keepalive message is received,
+     * the connection will be closed and the returned promise will reject.
+     * @param {number} interval
+     *   Keepalive interval in seconds.
+     */
+    wait_for_keepalive(interval) {
+      return new Promise((resolve, reject) => {
+        const subscriptions = [];
+
+        const cleanup = () => {
+          subscriptions.forEach((cb) => cb());
+          subscriptions.length = 0;
+        };
+        subscriptions.push(
+          this.subscribe('error', (error) => {
+            reject(error);
+            cleanup();
+          }),
+          this.subscribe('close', () => {
+            reject(new CloseError());
+            cleanup();
+          }),
+          this.subscribe('keepalive', () => {
+            resolve();
+            cleanup();
+          })
+        );
+        this.set_keepalive_interval(interval);
+      });
+    }
   }
 
   function getLengthEncoder(byteLength) {
@@ -7011,7 +7079,7 @@
       ['GetState', 3, 5, [], [OcaTaskManagerState]],
       ['GetTaskStatuses', 3, 6, [], [OcaTaskStatus]],
       ['GetTaskStatus', 3, 7, [OcaUint32], [OcaTaskStatus]],
-      ['AddTask', 3, 8, [], []],
+      ['AddTask', 3, 8, [OcaTask], [OcaTask]],
       ['GetTasks', 3, 9, [], [OcaMap(OcaUint32, OcaTask)]],
       ['GetTask', 3, 10, [OcaUint32], [OcaTask]],
       ['SetTask', 3, 11, [OcaUint32, OcaTask], []],
@@ -7096,7 +7164,10 @@
    * successfully created.
    *
    * @method OcaTaskManager#AddTask
-   * @returns {Promise<void>}
+   * @param {IOcaTask} Task
+   *
+   * @returns {Promise<OcaTask>}
+   *   A promise which resolves to a single value of type :class:`OcaTask`.
    */
   /**
    * Gets map of Tasks in the device. Return value indicates whether map was
@@ -20326,7 +20397,13 @@
         [OcaMediaSourceConnector, OcaMediaConnectorState],
         [],
       ],
-      ['AddSinkConnector', 3, 16, [OcaMediaConnectorStatus], []],
+      [
+        'AddSinkConnector',
+        3,
+        16,
+        [OcaMediaConnectorStatus, OcaMediaSinkConnector],
+        [OcaMediaSinkConnector],
+      ],
       ['ControlConnector', 3, 17, [OcaUint16, OcaMediaConnectorCommand], []],
       [
         'SetSourceConnectorPinMap',
@@ -20514,8 +20591,10 @@
    *
    * @method OcaMediaTransportNetwork#AddSinkConnector
    * @param {IOcaMediaConnectorStatus} InitialStatus
+   * @param {IOcaMediaSinkConnector} Connector
    *
-   * @returns {Promise<void>}
+   * @returns {Promise<OcaMediaSinkConnector>}
+   *   A promise which resolves to a single value of type :class:`OcaMediaSinkConnector`.
    */
   /**
    * Change the state of a given connector. Return status indicates the success of

package/package.json

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

package/src/connection.js

@@ -186,6 +186,12 @@ export class Connection extends Events {
    *    Keepalive interval in seconds.
    */
   set_keepalive_interval(seconds) {
+    if (!(seconds <= 10)) {
+      console.warn(
+        'Unusually large keepalive interval %o seconds. Confusion of ms vs. seconds?'
+      );
+    }
+
     const t = seconds * 1000;
 
     if (this._keepalive_interval_id !== null) {

package/src/controller/ControlClasses/OcaMediaTransportApplication.d.ts

@@ -1,7 +1,10 @@
 import { OcaCounter } from '../../types/OcaCounter';
 import { OcaCounterSet } from '../../types/OcaCounterSet';
 import { IOcaIODirection } from '../../types/OcaIODirection';
-import { OcaMediaStreamEndpoint } from '../../types/OcaMediaStreamEndpoint';
+import {
+  IOcaMediaStreamEndpoint,
+  OcaMediaStreamEndpoint,
+} from '../../types/OcaMediaStreamEndpoint';
 import { IOcaMediaStreamEndpointCommand } from '../../types/OcaMediaStreamEndpointCommand';
 import { IOcaMediaStreamEndpointState } from '../../types/OcaMediaStreamEndpointState';
 import { OcaMediaStreamEndpointStatus } from '../../types/OcaMediaStreamEndpointStatus';
@@ -375,11 +378,16 @@ export declare class OcaMediaTransportApplication extends OcaNetworkApplication
    * property **AlignmentLevelLimits**.
    *
    * @method OcaMediaTransportApplication#AddEndpoint
+   * @param {IOcaMediaStreamEndpoint} Endpoint
    * @param {IOcaMediaStreamEndpointState} InitialStatus
    *
-   * @returns {Promise<void>}
+   * @returns {Promise<OcaMediaStreamEndpoint>}
+   *   A promise which resolves to a single value of type :class:`OcaMediaStreamEndpoint`.
    */
-  AddEndpoint(InitialStatus: IOcaMediaStreamEndpointState): Promise<void>;
+  AddEndpoint(
+    Endpoint: IOcaMediaStreamEndpoint,
+    InitialStatus: IOcaMediaStreamEndpointState
+  ): Promise<OcaMediaStreamEndpoint>;
 
   /**
    * Deletes a stream endpoint from this media transport application object.

package/src/controller/ControlClasses/OcaMediaTransportApplication.js

@@ -99,7 +99,13 @@ export const OcaMediaTransportApplication = make_control_class(
       [OcaMap(OcaUint32, OcaMediaStreamEndpointStatus)],
     ],
     ['GetEndpointStatus', 3, 24, [OcaUint32], [OcaMediaStreamEndpointStatus]],
-    ['AddEndpoint', 3, 25, [OcaMediaStreamEndpointState], []],
+    [
+      'AddEndpoint',
+      3,
+      25,
+      [OcaMediaStreamEndpoint, OcaMediaStreamEndpointState],
+      [OcaMediaStreamEndpoint],
+    ],
     ['DeleteEndpoint', 3, 26, [OcaUint32], []],
     [
       'ApplyEndpointCommand',
@@ -427,9 +433,11 @@ export const OcaMediaTransportApplication = make_control_class(
  * property **AlignmentLevelLimits**.
  *
  * @method OcaMediaTransportApplication#AddEndpoint
+ * @param {IOcaMediaStreamEndpoint} Endpoint
  * @param {IOcaMediaStreamEndpointState} InitialStatus
  *
- * @returns {Promise<void>}
+ * @returns {Promise<OcaMediaStreamEndpoint>}
+ *   A promise which resolves to a single value of type :class:`OcaMediaStreamEndpoint`.
  */
 /**
  * Deletes a stream endpoint from this media transport application object.

package/src/controller/ControlClasses/OcaMediaTransportNetwork.d.ts

@@ -6,7 +6,10 @@ import {
   IOcaMediaConnectorStatus,
   OcaMediaConnectorStatus,
 } from '../../types/OcaMediaConnectorStatus';
-import { OcaMediaSinkConnector } from '../../types/OcaMediaSinkConnector';
+import {
+  IOcaMediaSinkConnector,
+  OcaMediaSinkConnector,
+} from '../../types/OcaMediaSinkConnector';
 import {
   IOcaMediaSourceConnector,
   OcaMediaSourceConnector,
@@ -267,10 +270,15 @@ export declare class OcaMediaTransportNetwork extends OcaApplicationNetwork {
    *
    * @method OcaMediaTransportNetwork#AddSinkConnector
    * @param {IOcaMediaConnectorStatus} InitialStatus
+   * @param {IOcaMediaSinkConnector} Connector
    *
-   * @returns {Promise<void>}
+   * @returns {Promise<OcaMediaSinkConnector>}
+   *   A promise which resolves to a single value of type :class:`OcaMediaSinkConnector`.
    */
-  AddSinkConnector(InitialStatus: IOcaMediaConnectorStatus): Promise<void>;
+  AddSinkConnector(
+    InitialStatus: IOcaMediaConnectorStatus,
+    Connector: IOcaMediaSinkConnector
+  ): Promise<OcaMediaSinkConnector>;
 
   /**
    * Change the state of a given connector. Return status indicates the success

package/src/controller/ControlClasses/OcaMediaTransportNetwork.js

@@ -51,7 +51,13 @@ export const OcaMediaTransportNetwork = make_control_class(
       [OcaMediaSourceConnector, OcaMediaConnectorState],
       [],
     ],
-    ['AddSinkConnector', 3, 16, [OcaMediaConnectorStatus], []],
+    [
+      'AddSinkConnector',
+      3,
+      16,
+      [OcaMediaConnectorStatus, OcaMediaSinkConnector],
+      [OcaMediaSinkConnector],
+    ],
     ['ControlConnector', 3, 17, [OcaUint16, OcaMediaConnectorCommand], []],
     [
       'SetSourceConnectorPinMap',
@@ -239,8 +245,10 @@ export const OcaMediaTransportNetwork = make_control_class(
  *
  * @method OcaMediaTransportNetwork#AddSinkConnector
  * @param {IOcaMediaConnectorStatus} InitialStatus
+ * @param {IOcaMediaSinkConnector} Connector
  *
- * @returns {Promise<void>}
+ * @returns {Promise<OcaMediaSinkConnector>}
+ *   A promise which resolves to a single value of type :class:`OcaMediaSinkConnector`.
  */
 /**
  * Change the state of a given connector. Return status indicates the success of

package/src/controller/ControlClasses/OcaMediaTransportSessionAgent.d.ts

@@ -1,4 +1,11 @@
-import { OcaMediaTransportSession } from '../../types/OcaMediaTransportSession';
+import {
+  IOcaMediaTransportSession,
+  OcaMediaTransportSession,
+} from '../../types/OcaMediaTransportSession';
+import {
+  IOcaMediaTransportSessionConnection,
+  OcaMediaTransportSessionConnection,
+} from '../../types/OcaMediaTransportSessionConnection';
 import { OcaMediaTransportSessionStatus } from '../../types/OcaMediaTransportSessionStatus';
 import { PropertyEvent } from '../property_event';
 import { RemoteDevice } from '../remote_device';
@@ -66,9 +73,14 @@ export declare class OcaMediaTransportSessionAgent extends OcaAgent {
    * with session ID filled in.
    *
    * @method OcaMediaTransportSessionAgent#AddSession
-   * @returns {Promise<void>}
+   * @param {IOcaMediaTransportSession} Session
+   *
+   * @returns {Promise<OcaMediaTransportSession>}
+   *   A promise which resolves to a single value of type :class:`OcaMediaTransportSession`.
    */
-  AddSession(): Promise<void>;
+  AddSession(
+    Session: IOcaMediaTransportSession
+  ): Promise<OcaMediaTransportSession>;
 
   /**
    * Configures a session.
@@ -170,10 +182,15 @@ export declare class OcaMediaTransportSessionAgent extends OcaAgent {
    *
    * @method OcaMediaTransportSessionAgent#AddConnection
    * @param {number} SessionID
+   * @param {IOcaMediaTransportSessionConnection} Connection
    *
-   * @returns {Promise<void>}
+   * @returns {Promise<OcaMediaTransportSessionConnection>}
+   *   A promise which resolves to a single value of type :class:`OcaMediaTransportSessionConnection`.
    */
-  AddConnection(SessionID: number): Promise<void>;
+  AddConnection(
+    SessionID: number,
+    Connection: IOcaMediaTransportSessionConnection
+  ): Promise<OcaMediaTransportSessionConnection>;
 
   /**
    * Configures a connection.

package/src/controller/ControlClasses/OcaMediaTransportSessionAgent.js

@@ -3,6 +3,7 @@ import { OcaBoolean } from '../../OCP1/OcaBoolean.js';
 import { OcaList } from '../../OCP1/OcaList.js';
 import { OcaMap } from '../../OCP1/OcaMap.js';
 import { OcaMediaTransportSession } from '../../OCP1/OcaMediaTransportSession.js';
+import { OcaMediaTransportSessionConnection } from '../../OCP1/OcaMediaTransportSessionConnection.js';
 import { OcaMediaTransportSessionStatus } from '../../OCP1/OcaMediaTransportSessionStatus.js';
 import { OcaString } from '../../OCP1/OcaString.js';
 import { OcaUint32 } from '../../OCP1/OcaUint32.js';
@@ -27,7 +28,13 @@ export const OcaMediaTransportSessionAgent = make_control_class(
     ['GetSessionType', 3, 1, [], [OcaString]],
     ['GetSessions', 3, 2, [], [OcaList(OcaMediaTransportSession)]],
     ['GetSession', 3, 3, [OcaUint32], [OcaMediaTransportSession]],
-    ['AddSession', 3, 4, [], []],
+    [
+      'AddSession',
+      3,
+      4,
+      [OcaMediaTransportSession],
+      [OcaMediaTransportSession],
+    ],
     ['ConfigureSession', 3, 5, [OcaUint32, OcaBlob, OcaString, OcaBlob], []],
     ['DeleteSession', 3, 6, [OcaUint32], []],
     ['ResetSession', 3, 7, [OcaUint32], []],
@@ -42,7 +49,13 @@ export const OcaMediaTransportSessionAgent = make_control_class(
       [OcaMap(OcaUint32, OcaMediaTransportSessionStatus)],
     ],
     ['GetSessionStatus', 3, 12, [OcaUint32], [OcaMediaTransportSessionStatus]],
-    ['AddConnection', 3, 13, [OcaUint32], []],
+    [
+      'AddConnection',
+      3,
+      13,
+      [OcaUint32, OcaMediaTransportSessionConnection],
+      [OcaMediaTransportSessionConnection],
+    ],
     [
       'ConfigureConnection',
       3,
@@ -100,7 +113,10 @@ export const OcaMediaTransportSessionAgent = make_control_class(
  * session ID filled in.
  *
  * @method OcaMediaTransportSessionAgent#AddSession
- * @returns {Promise<void>}
+ * @param {IOcaMediaTransportSession} Session
+ *
+ * @returns {Promise<OcaMediaTransportSession>}
+ *   A promise which resolves to a single value of type :class:`OcaMediaTransportSession`.
  */
 /**
  * Configures a session.
@@ -180,8 +196,10 @@ export const OcaMediaTransportSessionAgent = make_control_class(
  *
  * @method OcaMediaTransportSessionAgent#AddConnection
  * @param {number} SessionID
+ * @param {IOcaMediaTransportSessionConnection} Connection
  *
- * @returns {Promise<void>}
+ * @returns {Promise<OcaMediaTransportSessionConnection>}
+ *   A promise which resolves to a single value of type :class:`OcaMediaTransportSessionConnection`.
  */
 /**
  * Configures a connection.

package/src/controller/ControlClasses/OcaTaskManager.d.ts

@@ -149,9 +149,12 @@ export declare class OcaTaskManager extends OcaManager {
    * successfully created.
    *
    * @method OcaTaskManager#AddTask
-   * @returns {Promise<void>}
+   * @param {IOcaTask} Task
+   *
+   * @returns {Promise<OcaTask>}
+   *   A promise which resolves to a single value of type :class:`OcaTask`.
    */
-  AddTask(): Promise<void>;
+  AddTask(Task: IOcaTask): Promise<OcaTask>;
 
   /**
    * Gets map of Tasks in the device. Return value indicates whether map was

package/src/controller/ControlClasses/OcaTaskManager.js

@@ -53,7 +53,7 @@ export const OcaTaskManager = make_control_class(
     ['GetState', 3, 5, [], [OcaTaskManagerState]],
     ['GetTaskStatuses', 3, 6, [], [OcaTaskStatus]],
     ['GetTaskStatus', 3, 7, [OcaUint32], [OcaTaskStatus]],
-    ['AddTask', 3, 8, [], []],
+    ['AddTask', 3, 8, [OcaTask], [OcaTask]],
     ['GetTasks', 3, 9, [], [OcaMap(OcaUint32, OcaTask)]],
     ['GetTask', 3, 10, [OcaUint32], [OcaTask]],
     ['SetTask', 3, 11, [OcaUint32, OcaTask], []],
@@ -138,7 +138,10 @@ export const OcaTaskManager = make_control_class(
  * successfully created.
  *
  * @method OcaTaskManager#AddTask
- * @returns {Promise<void>}
+ * @param {IOcaTask} Task
+ *
+ * @returns {Promise<OcaTask>}
+ *   A promise which resolves to a single value of type :class:`OcaTask`.
  */
 /**
  * Gets map of Tasks in the device. Return value indicates whether map was

package/src/controller/client_connection.d.ts

@@ -33,4 +33,13 @@ export interface PendingCommand {
  */
 export declare class ClientConnection extends Connection {
   constructor(options: IClientConnectionOptions);
+
+  /**
+   * Activates keepalive handling (using set_keepalive_interval) and waits for
+   * at least one keepalive packet to arrive. If no keepalive message is received,
+   * the connection will be closed and the returned promise will reject.
+   * @param {number} interval
+   *   Keepalive interval in seconds.
+   */
+  wait_for_keepalive(interval: number): Promise<void>;
 }

package/src/controller/client_connection.js

@@ -241,9 +241,43 @@ export class ClientConnection extends Connection {
         if (!(o.time > 0)) {
           throw new Error('Bad keepalive timeout.');
         }
+        this.emit('keepalive', o);
       } else {
         throw new Error('Unexpected PDU');
       }
     }
   }
+
+  /**
+   * Activates keepalive handling (using set_keepalive_interval) and waits for
+   * at least one keepalive packet to arrive. If no keepalive message is received,
+   * the connection will be closed and the returned promise will reject.
+   * @param {number} interval
+   *   Keepalive interval in seconds.
+   */
+  wait_for_keepalive(interval) {
+    return new Promise((resolve, reject) => {
+      const subscriptions = [];
+
+      const cleanup = () => {
+        subscriptions.forEach((cb) => cb());
+        subscriptions.length = 0;
+      };
+      subscriptions.push(
+        this.subscribe('error', (error) => {
+          reject(error);
+          cleanup();
+        }),
+        this.subscribe('close', () => {
+          reject(new CloseError());
+          cleanup();
+        }),
+        this.subscribe('keepalive', () => {
+          resolve();
+          cleanup();
+        })
+      );
+      this.set_keepalive_interval(interval);
+    });
+  }
 }

package/src/events.d.ts

@@ -24,8 +24,19 @@ export class Events {
    */
   removeEventListener(name: string, cb: (...args) => void): void;
 
+  /**
+   * Unsubscribe from an event.
+   */
+  off(name: string, cb: (...args) => void): void;
+
   /**
    * Removes all event listeners.
    */
   removeAllEventListeners(): void;
+
+  /**
+   * Subscribe to an event. Returns a cleanup function which can be called to
+   * unsubscribe.
+   */
+  subscribe(name: string, cb: (...args) => void): () => void;
 }

package/src/events.js

@@ -34,6 +34,10 @@ export class Events {
    * @param {Function} cb - Callback function.
    */
   on(name, cb) {
+    if (typeof name !== 'string')
+      throw new TypeError('Event name must be a string.');
+    if (typeof cb !== 'function')
+      throw new TypeError('Event handler must be a function.');
     let handlers = this.event_handlers.get(name);
 
     if (!handlers) {
@@ -63,10 +67,34 @@ export class Events {
     handlers.delete(cb);
   }
 
+  /**
+   * Removes an event handler.
+   *
+   * @param {strign} name
+   * @param {Function} cb
+   */
+  off(name, cb) {
+    this.removeEventListener(name, cb);
+  }
+
   /**
    * Removes all event listeners.
    */
   removeAllEventListeners() {
     this.event_handlers.clear();
   }
+
+  /**
+   *
+   * @param {string} name
+   * @param {Function} cb
+   */
+  subscribe(name, cb) {
+    this.on(name, cb);
+    return () => {
+      if (name === undefined) return;
+      this.off(name, cb);
+      name = undefined;
+    };
+  }
 }