Merge pull request #281 from smartdevicelink/feature/sdl-manager-set-rpc-listeners

Add new API and use it in example apps

Author: crokita

examples/js/hello-sdl/SDL.min.js

@@ -56,7 +56,10 @@
                         SDL.rpc.enums.AppHMIType.DEFAULT,
                     ])
                     .setTransportConfig(new SDL.transport.WebSocketClientConfig('ws://localhost', 5050))
-                    .setAppIcon(file);
+                    .setAppIcon(file)
+                    .setRpcNotificationListeners({
+                        [SDL.rpc.enums.FunctionID.OnHMIStatus]: this._onHmiStatusListener.bind(this),
+                    });
 
                 this._appConfig = new SDL.manager.AppConfig()
                     .setLifecycleConfig(this._lifecycleConfig);
@@ -94,9 +97,7 @@
                     });
 
                 this._sdlManager = new SDL.manager.SdlManager(this._appConfig, managerListener);
-                this._sdlManager
-                    .start()
-                    .addRpcListener(SDL.rpc.enums.FunctionID.OnHMIStatus, this._onHmiStatusListener.bind(this));
+                this._sdlManager.start();
             }
 
             async _onConnected () {

examples/js/hello-sdl/index.html

@@ -51,7 +51,10 @@ class AppClient {
                 SDL.rpc.enums.AppHMIType.DEFAULT,
             ])
             .setTransportConfig(new SDL.transport.TcpClientConfig(CONFIG.host, CONFIG.port))
-            .setAppIcon(file);
+            .setAppIcon(file)
+            .setRpcNotificationListeners({
+                [SDL.rpc.enums.FunctionID.OnHMIStatus]: this._onHmiStatusListener.bind(this),
+            });
 
         this._appConfig = new SDL.manager.AppConfig()
             .setLifecycleConfig(this._lifecycleConfig);
@@ -89,9 +92,7 @@ class AppClient {
             });
 
         this._sdlManager = new SDL.manager.SdlManager(this._appConfig, managerListener);
-        this._sdlManager
-            .start()
-            .addRpcListener(SDL.rpc.enums.FunctionID.OnHMIStatus, this._onHmiStatusListener.bind(this));
+        this._sdlManager.start();
     }
 
     async _onConnected () {

examples/node/hello-sdl-tcp/SDL.min.js

@@ -56,7 +56,10 @@ class AppClient {
                     CONFIG.connectionLostTimeout
                 )
             )
-            .setAppIcon(file);
+            .setAppIcon(file)
+            .setRpcNotificationListeners({
+                [SDL.rpc.enums.FunctionID.OnHMIStatus]: this._onHmiStatusListener.bind(this),
+            });
 
         this._appConfig = new SDL.manager.AppConfig()
             .setLifecycleConfig(this._lifecycleConfig);
@@ -94,9 +97,7 @@ class AppClient {
             });
 
         this._sdlManager = new SDL.manager.SdlManager(this._appConfig, managerListener);
-        this._sdlManager
-            .start()
-            .addRpcListener(SDL.rpc.enums.FunctionID.OnHMIStatus, this._onHmiStatusListener.bind(this));
+        this._sdlManager.start();
 
         // for a cloud server app the hmi full will be received before the managers report that they're ready!
         this._managersReady = false;

examples/node/hello-sdl-tcp/index.js

@@ -50,7 +50,10 @@
                 this._lifecycleConfig = new SDL.manager.LifecycleConfig()
                     .loadManifest(sdl_manifest)
                     .setLanguageDesired(SDL.rpc.enums.Language.EN_US)
-                    .setTransportConfig(new SDL.transport.WebSocketClientConfig());
+                    .setTransportConfig(new SDL.transport.WebSocketClientConfig())
+                    .setRpcNotificationListeners({
+                        [SDL.rpc.enums.FunctionID.OnHMIStatus]: this._onHmiStatusListener.bind(this),
+                    });
 
                 this._appConfig = new SDL.manager.AppConfig()
                     .setLifecycleConfig(this._lifecycleConfig);
@@ -88,9 +91,7 @@
                     });
 
                 this._sdlManager = new SDL.manager.SdlManager(this._appConfig, managerListener);
-                this._sdlManager
-                    .start()
-                    .addRpcListener(SDL.rpc.enums.FunctionID.OnHMIStatus, this._onHmiStatusListener.bind(this));
+                this._sdlManager.start();
             }
 
             async _onConnected () {

examples/node/hello-sdl/AppClient.js

@@ -58,6 +58,7 @@ class LifecycleConfig {
         this._minimumRpcVersion = new Version(1, 0, 0);
         this._minimumProtocolVersion = new Version(1, 0, 0);
         this._resumeHash = null;
+        this._onRpcNotificationListeners = null;
     }
 
     /**
@@ -419,6 +420,26 @@ class LifecycleConfig {
         });
         return this;
     }
+
+    /**
+     * Get RPC notification listeners. SdlManager will preload these listeners before any RPCs are sent/received.
+     * @returns {Object} listeners - a map of listeners that will be called when a notification is received.
+     * Key represents the FunctionID of the notification and value represents the listener
+     */
+    getRpcNotificationListeners () {
+        return this._onRpcNotificationListeners;
+    }
+
+    /**
+     * Set RPC notification listeners. SdlManager will preload these listeners before any RPCs are sent/received.
+     * @param {Object} listeners - a map of listeners that will be called when a notification is received.
+     * Key represents the FunctionID of the notification and value represents the listener
+     * @returns {LifecycleConfig} - A reference to this instance to support method chaining.
+     */
+    setRpcNotificationListeners (listeners) {
+        this._onRpcNotificationListeners = listeners;
+        return this;
+    }
 }
 
 export { LifecycleConfig };