engage-engine 1.234.90740002 → 1.236.90760003

package/include/ConfigurationObjects.h

@@ -53,6 +53,8 @@ namespace ConfigurationObjects
 namespace AppConfigurationObjects
 #endif
 {
+    static const char *ENGAGE_CONFIGURATION_OBJECT_ATTACHED_OBJECT = "_attached";
+
     //-----------------------------------------------------------
     #pragma pack(push, 1)
         typedef struct _DataSeriesHeader_t
@@ -298,6 +300,12 @@ namespace AppConfigurationObjects
     #define FROMJSON_IMPL(__var, __type, __default) \
         getOptional<__type>(#__var, p.__var, j, __default)
 
+    #define TOJSON_BASE_IMPL() \
+        to_json(j, (ConfigurationObjectBase&)p)
+
+    #define FROMJSON_BASE_IMPL() \
+        from_json(j, (ConfigurationObjectBase&)p);
+
 
     //-----------------------------------------------------------
     static std::string EMPTY_STRING;
@@ -408,10 +416,40 @@ namespace AppConfigurationObjects
             return _documenting;
         }
 
+        nlohmann::json      _attached;
+
     protected:
-        bool _documenting;
+        bool                _documenting;
     };
 
+    static void to_json(nlohmann::json& j, const ConfigurationObjectBase& p)
+    {
+        try
+        {
+            if(p._attached != nullptr)
+            {
+                j[ENGAGE_CONFIGURATION_OBJECT_ATTACHED_OBJECT] = p._attached;
+            }
+        }
+        catch(...)
+        {
+        }
+    }
+    static void from_json(const nlohmann::json& j, ConfigurationObjectBase& p)
+    {
+        try
+        {
+            if(j.contains(ENGAGE_CONFIGURATION_OBJECT_ATTACHED_OBJECT))
+            {
+                p._attached = j.at(ENGAGE_CONFIGURATION_OBJECT_ATTACHED_OBJECT);
+            }
+        }
+        catch(...)
+        {
+        }
+    }
+
+
     //-----------------------------------------------------------
     JSON_SERIALIZED_CLASS(FipsCryptoSettings)
     class FipsCryptoSettings : public ConfigurationObjectBase
@@ -2188,6 +2226,56 @@ namespace AppConfigurationObjects
     }
 
 
+    //-----------------------------------------------------------
+    JSON_SERIALIZED_CLASS(PacketCapturer)
+    /**
+     * @brief Description of a packet capturer
+     *
+     * Helper C++ class to serialize and de-serialize PacketCapturer JSON.
+     *
+     * Example: @include[doc] examples/PacketCapturer.json
+     *
+     */
+    class PacketCapturer : public ConfigurationObjectBase
+    {
+        IMPLEMENT_JSON_SERIALIZATION()
+        IMPLEMENT_JSON_DOCUMENTATION(PacketCapturer)
+
+    public:
+        bool            enabled;
+        uint32_t        maxMb;
+        std::string     filePrefix;
+
+        PacketCapturer()
+        {
+            clear();
+        }
+
+        void clear()
+        {
+            enabled = false;
+            maxMb = 10;
+            filePrefix.clear();
+        }
+    };
+
+    static void to_json(nlohmann::json& j, const PacketCapturer& p)
+    {
+        j = nlohmann::json{
+            TOJSON_IMPL(enabled),
+            TOJSON_IMPL(maxMb),
+            TOJSON_IMPL(filePrefix)
+        };
+    }
+    static void from_json(const nlohmann::json& j, PacketCapturer& p)
+    {
+        p.clear();
+        getOptional<bool>("enabled", p.enabled, j, false);
+        getOptional<uint32_t>("maxMb", p.maxMb, j, 10);
+        getOptional<std::string>("filePrefix", p.filePrefix, j, EMPTY_STRING);
+    }
+
+
     //-----------------------------------------------------------
     JSON_SERIALIZED_CLASS(TransportImpairment)
     /**
@@ -2806,7 +2894,7 @@ namespace AppConfigurationObjects
 
 
             /* PCM */
-            /** @brief PCM </a> */
+            /** @brief PCM */
             ctPcm           = 5,
 
             // AMR Narrowband */
@@ -4448,9 +4536,17 @@ namespace AppConfigurationObjects
         /** @brief [Optional] List of sources to ignore for this group */
         std::vector<Source>                     ignoreSources;
 
-        /** @brief ISO 639-2 lanuguage code for the group  */
+        /** @brief ISO 639-2 language code for the group  */
         std::string                             languageCode;
 
+        /** @brief Name of the synthesis voice to use for the group  */
+        std::string                             synVoice;
+
+        /** @brief Details for capture of received packets  */
+        PacketCapturer                          rxCapture;
+
+        /** @brief Details for capture of transmitted packets  */
+        PacketCapturer                          txCapture;
 
         Group()
         {
@@ -4524,6 +4620,10 @@ namespace AppConfigurationObjects
             ignoreSources.clear();
 
             languageCode.clear();
+            synVoice.clear();
+
+            rxCapture.clear();
+            txCapture.clear();
         }
     };
 
@@ -4581,9 +4681,15 @@ namespace AppConfigurationObjects
 
             TOJSON_IMPL(ignoreSources),
 
-            TOJSON_IMPL(languageCode)
+            TOJSON_IMPL(languageCode),
+            TOJSON_IMPL(synVoice),
+
+            TOJSON_IMPL(rxCapture),
+            TOJSON_IMPL(txCapture)
         };
 
+        TOJSON_BASE_IMPL();
+
         // TODO: need a better way to indicate whether rtpProfile is present
         if(p._wasDeserialized_rtpProfile || p.isDocumenting())
         {
@@ -4655,6 +4761,12 @@ namespace AppConfigurationObjects
         getOptional<uint32_t>("securityLevel", p.securityLevel, j, 0);
         getOptional<std::vector<Source>>("ignoreSources", p.ignoreSources, j);
         getOptional<std::string>("languageCode", p.languageCode, j);
+        getOptional<std::string>("synVoice", p.synVoice, j);        
+
+        getOptional<PacketCapturer>("rxCapture", p.rxCapture, j);
+        getOptional<PacketCapturer>("txCapture", p.txCapture, j);
+
+        FROMJSON_BASE_IMPL();
     }
 
 
@@ -4841,7 +4953,8 @@ namespace AppConfigurationObjects
     static void to_json(nlohmann::json& j, const LicenseDescriptor& p)
     {
         j = nlohmann::json{
-            TOJSON_IMPL(entitlement),
+            //TOJSON_IMPL(entitlement),
+            {"entitlement", "*entitlement*"},
             TOJSON_IMPL(key),
             TOJSON_IMPL(activationCode),
             TOJSON_IMPL(type),
@@ -4850,7 +4963,8 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(flags),
             TOJSON_IMPL(deviceId),
             TOJSON_IMPL(status),
-            TOJSON_IMPL(manufacturerId),
+            //TOJSON_IMPL(manufacturerId),
+            {"manufacturerId", "*manufacturerId*"},
             TOJSON_IMPL(cargo),
             TOJSON_IMPL(cargoFlags)
         };
@@ -7706,9 +7820,15 @@ namespace AppConfigurationObjects
         IMPLEMENT_JSON_DOCUMENTATION(RallypointWebsocketSettings)
 
     public:
+        /** @brief [Default: false] Websocket is enabled */
+        bool                                    enabled;
+
         /** @brief Listen port (TCP).  Default is 8443 */
         int                                     listenPort;
 
+        /** @brief Certificate to be used for WebSockets */
+        SecurityCertificate                     certificate;
+
         RallypointWebsocketSettings()
         {
             clear();
@@ -7716,22 +7836,113 @@ namespace AppConfigurationObjects
 
         void clear()
         {
+            enabled = false;
             listenPort = 8443;
+            certificate.clear();
         }
     };
 
     static void to_json(nlohmann::json& j, const RallypointWebsocketSettings& p)
     {
         j = nlohmann::json{
-            TOJSON_IMPL(listenPort)
+            TOJSON_IMPL(enabled),
+            TOJSON_IMPL(listenPort),
+            TOJSON_IMPL(certificate)
         };
     }
     static void from_json(const nlohmann::json& j, RallypointWebsocketSettings& p)
     {
         p.clear();
+        getOptional<bool>("enabled", p.enabled, j, false);
         getOptional<int>("listenPort", p.listenPort, j, 8443);
+        getOptional<SecurityCertificate>("certificate", p.certificate, j);
+    }
+
+
+
+    //-----------------------------------------------------------
+    JSON_SERIALIZED_CLASS(RallypointAdvertisingSettings)
+    /**
+     * @brief Defines settings for Rallypoint advertising
+     *
+     * Example: @include[doc] examples/RallypointAdvertisingSettings.json
+     *
+     */
+    class RallypointAdvertisingSettings : public ConfigurationObjectBase
+    {
+        IMPLEMENT_JSON_SERIALIZATION()
+        IMPLEMENT_JSON_DOCUMENTATION(RallypointAdvertisingSettings)
+
+    public:
+        /** @brief [Default: false] Advertising is enabled */
+        bool                                    enabled;
+
+        /** @brief [Optional] This Rallypoint's mesh name */
+        std::string                             meshName;
+
+        /** @brief [Optional] This Rallypoint's DNS-SD host name */
+        std::string                             hostName;
+
+        /** @brief [Optional, Default "_rallypoint._tcp.local."] The service name */
+        std::string                             serviceName;
+
+        /** @brief The multicast network interface for mDNS */
+        std::string                             interfaceName;
+
+        /** @brief [Default: RP port] The multicast network interface for mDNS */
+        int                                     port;
+
+        /** @brief [Default: 60] TTL for service TTL */
+        int                                     ttl;
+
+        /** @brief [Optional] List of additional meshes that can be reached via this RP */
+        std::vector<std::string>                extraMeshes;
+
+
+        RallypointAdvertisingSettings()
+        {
+            clear();
+        }
+
+        void clear()
+        {
+            enabled = false;
+            meshName.clear();
+            hostName.clear();
+            serviceName = "_rallypoint._tcp.local.";
+            interfaceName.clear();
+            port = 0;
+            ttl = 60;
+            extraMeshes.clear();
+        }
+    };
+
+    static void to_json(nlohmann::json& j, const RallypointAdvertisingSettings& p)
+    {
+        j = nlohmann::json{
+            TOJSON_IMPL(enabled),
+            TOJSON_IMPL(meshName),
+            TOJSON_IMPL(hostName),
+            TOJSON_IMPL(serviceName),
+            TOJSON_IMPL(interfaceName),
+            TOJSON_IMPL(port),
+            TOJSON_IMPL(ttl),
+            TOJSON_IMPL(extraMeshes)
+        };
     }
+    static void from_json(const nlohmann::json& j, RallypointAdvertisingSettings& p)
+    {
+        p.clear();
+        getOptional<bool>("enabled", p.enabled, j, false);
+        getOptional<std::string>("meshName", p.meshName, j);
+        getOptional<std::string>("hostName", p.hostName, j);
+        getOptional<std::string>("serviceName", p.serviceName, j, "_rallypoint._tcp.local.");
+        getOptional<std::string>("interfaceName", p.interfaceName, j);
 
+        getOptional<int>("port", p.port, j, 0);
+        getOptional<int>("ttl", p.ttl, j, 60);
+        getOptional<std::vector<std::string>>("extraMeshes", p.extraMeshes, j);
+    }
 
     //-----------------------------------------------------------
     JSON_SERIALIZED_CLASS(RallypointServer)
@@ -7890,6 +8101,9 @@ namespace AppConfigurationObjects
         /** @brief [Optional] Settings for NSM. */
         NsmConfiguration                            nsm;
 
+        /** @brief [Optional] Settings for advertising. */
+        RallypointAdvertisingSettings               advertising;
+
         RallypointServer()
         {
             clear();
@@ -7944,6 +8158,7 @@ namespace AppConfigurationObjects
             peerRtBehaviors.clear();
             websocket.clear();
             nsm.clear();
+            advertising.clear();
         }
     };
 
@@ -7996,7 +8211,8 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(peerRtTestIntervalMs),
             TOJSON_IMPL(peerRtBehaviors),
             TOJSON_IMPL(websocket),
-            TOJSON_IMPL(nsm)
+            TOJSON_IMPL(nsm),
+            TOJSON_IMPL(advertising)
         };
     }
     static void from_json(const nlohmann::json& j, RallypointServer& p)
@@ -8049,6 +8265,7 @@ namespace AppConfigurationObjects
         getOptional<std::vector<RallypointRpRtTimingBehavior>>("peerRtBehaviors", p.peerRtBehaviors, j);
         getOptional<RallypointWebsocketSettings>("websocket", p.websocket, j);
         getOptional<NsmConfiguration>("nsm", p.nsm, j);
+        getOptional<RallypointAdvertisingSettings>("advertising", p.advertising, j);
     }
 
     //-----------------------------------------------------------

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "engage-engine",
-  "version": "1.234.90740002",
+  "version": "1.236.90760003",
   "description": "Use Engage to communicate with everyone, everywhere, from any device",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"