vrpc 3.0.0-alpha.3 → 3.0.3

package/vrpc/VrpcNative.js

@@ -16,7 +16,7 @@ Author: Dr. Burkhard C. Heisen (https://github.com/heisenware/vrpc)
 
 
 Licensed under the MIT License <http://opensource.org/licenses/MIT>.
-Copyright (c) 2018 - 2021 Dr. Burkhard C. Heisen <burkhard.heisen@heisenware.com>.
+Copyright (c) 2018 - 2022 Dr. Burkhard C. Heisen <burkhard.heisen@heisenware.com>.
 
 Permission is hereby  granted, free of charge, to any  person obtaining a copy
 of this software and associated  documentation files (the "Software"), to deal
@@ -41,7 +41,7 @@ const EventEmitter = require('events')
 const { nanoid } = require('nanoid')
 
 /**
- * Client capable of creating proxy objects and locally calling
+ * Client capable of creating proxy classes and objects to locally call
  * functions as provided through native addons.
  */
 class VrpcNative {
@@ -64,6 +64,15 @@ class VrpcNative {
     })
   }
 
+  /**
+   * Provides a proxy class to an existing one in the native addon
+   *
+   * You can use the returned class in the usual way. Static function calls
+   * are forwarded to the native addon, as are any instantiations and member
+   * function calls.
+   * @param {String} className The name of the class
+   * @returns Proxy Class
+   */
   getClass (className) {
     if (!this.getAvailableClasses().includes(className)) {
       throw new Error(`Native addon does not provide class: ${className}`)
@@ -226,6 +235,11 @@ class VrpcNative {
     return Klass
   }
 
+  /**
+   * Deletes a proxy object and its underlying instance
+   * @param {Object} proxy A proxy object
+   * @returns True in case of success, false otherwise
+   */
   delete (proxy) {
     if (!typeof proxy === 'object' || !proxy.vrpcProxyId) {
       throw new Error('Provided argument seems not to be a VRPC proxy')
@@ -238,6 +252,15 @@ class VrpcNative {
     return JSON.parse(this._adapter.call(JSON.stringify(json))).r
   }
 
+  /**
+   * Secondary option to call a static function (when creation of a proxy class
+   * seems to be too much overhead)
+   *
+   * @param {String} className The class on which the static function should be called
+   * @param {String} functionName Name of the static function
+   * @param  {...any} args The function arguments
+   * @returns The output of the underlying static function
+   */
   callStatic (className, functionName, ...args) {
     if (functionName === 'vrpcOff') {
       const id = `__f__${className}-vrpcOn:${args[0]}`

package/vrpc/adapter.hpp

@@ -12,11 +12,11 @@ __\/\\\_______\/\\\__/\\\///////\\\___\/\\\/////////\\\____/\\\////////__
 
 Non-intrusively binds any C++ code and provides access in form of asynchronous
 remote procedural callbacks (RPC).
-Author: Dr. Burkhard C. Heisen (https://github.com/bheisen/vrpc)
+Author: Dr. Burkhard C. Heisen (https://github.com/heisenware/vrpc-hpp)
 
 
 Licensed under the MIT License <http://opensource.org/licenses/MIT>.
-Copyright (c) 2018 - 2021 Dr. Burkhard C. Heisen
+Copyright (c) 2018 - 2022 Dr. Burkhard C. Heisen
 <burkhard.heisen@heisenware.com>.
 
 Permission is hereby  granted, free of charge, to any  person obtaining a copy
@@ -373,6 +373,7 @@ template <std::size_t I = 0, typename... Args>
     I<sizeof...(Args), void>::type get_signature(std::string& signature,
                                                  const std::tuple<Args...>& t) {
   json j = {{"t", std::get<I>(t)}};
+  if (!signature.empty()) signature += ":";
   signature += j["t"].type_name();
   return get_signature<I + 1, Args...>(signature, t);
 }
@@ -389,6 +390,7 @@ inline std::string get_signature() {
 inline std::string get_signature(const json& json) {
   std::string signature;
   for (const auto& it : json) {
+    if (!signature.empty()) signature += ":";
     signature += it.type_name();
   }
   return signature.empty() ? signature : "-" + signature;

package/vrpc/addon.cpp

@@ -15,7 +15,7 @@ Author: Dr. Burkhard C. Heisen (https://github.com/heisenware/vrpc)
 
 
 Licensed under the MIT License <http://opensource.org/licenses/MIT>.
-Copyright (c) 2018 - 2021 Dr. Burkhard C. Heisen
+Copyright (c) 2018 - 2022 Dr. Burkhard C. Heisen
 <burkhard.heisen@heisenware.com>.
 
 Permission is hereby  granted, free of charge, to any  person obtaining a copy

package/vrpc/vrpc-agent-js

@@ -23,7 +23,7 @@ parser.add_argument(
   {
     help: 'The prefix for all vrpc communication',
     type: 'string',
-    default: 'public.vrpc'
+    default: 'vrpc'
   }
 )
 parser.add_argument(