engage-engine 1.251.90910019 → 1.251.90910020

package/engage.cpp

@@ -502,6 +502,10 @@ ENGAGE_CB_ID_PARAM(groupHealthReportFailed);
 ENGAGE_CB_ID_PLUS_ONE_STRING_PARAM(groupStatsReport);
 ENGAGE_CB_ID_PARAM(groupStatsReportFailed);
 
+ENGAGE_CB_ID_PARAM(bridgeCreated)
+ENGAGE_CB_ID_PARAM(bridgeCreateFailed)
+ENGAGE_CB_ID_PARAM(bridgeDeleted)
+
 void on_groupRxVolumeChanged(const char *id, int16_t leftLevelPerc, int16_t rightLevelPerc, const char * eventExtraJson)
 {
     CrossThreadCallbackWorker *cbw = getCallback("groupRxVolumeChanged");
@@ -661,6 +665,10 @@ NAN_METHOD(initialize)
     ENGAGE_CB_TABLE_ENTRY(PFN_ENGAGE_GROUP_RX_VOLUME_CHANGED, groupRxVolumeChanged);
     ENGAGE_CB_TABLE_ENTRY(PFN_ENGAGE_GROUP_RX_DTMF, groupRxDtmf);
 
+    ENGAGE_CB_TABLE_ENTRY(PFN_ENGAGE_BRIDGE_CREATED, bridgeCreated);
+    ENGAGE_CB_TABLE_ENTRY(PFN_ENGAGE_BRIDGE_CREATE_FAILED, bridgeCreateFailed);
+    ENGAGE_CB_TABLE_ENTRY(PFN_ENGAGE_BRIDGE_DELETED, bridgeDeleted);
+
     engageRegisterEventCallbacks(&g_eventCallbacks);
 
     NANRETI(engageInitialize(STRVAL(0), STRVAL(1), STRVAL(2)));
@@ -1214,6 +1222,17 @@ NAN_METHOD(endGroupPcmPowerTracking)
     NANRETI(engageEndGroupPcmPowerTracking(STRVAL(0)));
 }
 
+//--------------------------------------------------------
+NAN_METHOD(createBridge)
+{
+    NANRETI(engageCreateBridge(STRVAL(0)));
+}
+
+//--------------------------------------------------------
+NAN_METHOD(deleteBridge)
+{
+    NANRETI(engageDeleteBridge(STRVAL(0)));
+}
 
 //--------------------------------------------------------
 NAN_MODULE_INIT(Init)
@@ -1297,6 +1316,9 @@ NAN_MODULE_INIT(Init)
 
     ENGAGE_BINDING(beginGroupPcmPowerTracking);
     ENGAGE_BINDING(endGroupPcmPowerTracking);
+
+    ENGAGE_BINDING(createBridge);
+    ENGAGE_BINDING(deleteBridge);
 }
 
 NODE_MODULE(engage, Init)

package/include/ConfigurationObjects.h

@@ -2800,7 +2800,7 @@ namespace AppConfigurationObjects
         std::vector<std::string>    caCertificates;
 
         /**
-         * @brief [Optional, Default 5000] Number of milliseconds that a transaction may take before the link is considered broken.
+         * @brief [Optional, Default 10000] Number of milliseconds that a transaction may take before the link is considered broken.
          */
         int                         transactionTimeoutMs;
 
@@ -2815,6 +2815,14 @@ namespace AppConfigurationObjects
         /** @brief [Optional] Tx options for the TCP link */
         TcpNetworkTxOptions         tcpTxOptions;
 
+        /**
+         * @brief [Optional] A user-defined string sent as the Server Name Indication (SNI) field in 
+         * the TLS setup.  Be aware that this data is sent in the clear in the client hello message.
+         * 
+         */
+        std::string                 sni;
+
+
         Rallypoint()
         {
             clear();
@@ -2831,6 +2839,7 @@ namespace AppConfigurationObjects
             disableMessageSigning = false;
             connectionTimeoutSecs = 0;
             tcpTxOptions.clear();
+            sni.clear();
         }
 
         bool matches(const Rallypoint& other)
@@ -2893,6 +2902,18 @@ namespace AppConfigurationObjects
             {
                 return false;
             }
+            if(connectionTimeoutSecs != other.connectionTimeoutSecs)
+            {
+                return false;
+            }
+            if(tcpTxOptions.priority != other.tcpTxOptions.priority)
+            {
+                return false;
+            }   
+            if(sni.compare(other.sni) != 0)
+            {
+                return false;
+            }
 
             return true;
         }
@@ -2910,7 +2931,8 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(transactionTimeoutMs),
             TOJSON_IMPL(disableMessageSigning),
             TOJSON_IMPL(connectionTimeoutSecs),
-            TOJSON_IMPL(tcpTxOptions)
+            TOJSON_IMPL(tcpTxOptions),
+            TOJSON_IMPL(sni)
         };
     }
 
@@ -2927,6 +2949,7 @@ namespace AppConfigurationObjects
         getOptional<bool>("disableMessageSigning", p.disableMessageSigning, j, false);
         getOptional<int>("connectionTimeoutSecs", p.connectionTimeoutSecs, j, 0);
         getOptional<TcpNetworkTxOptions>("tcpTxOptions", p.tcpTxOptions, j);
+        getOptional<std::string>("sni", p.sni, j);
     }
 
     //-----------------------------------------------------------
@@ -2970,10 +2993,10 @@ namespace AppConfigurationObjects
         /** @brief Seconds between switching to a new target */
         int                                 rolloverSecs;
 
-        /** @brief [Optional, Default: 0] Default connection timeout in seconds to any RP in the cluster */
+        /** @brief [Optional, Default: 5] Default connection timeout in seconds to any RP in the cluster */
         int                                 connectionTimeoutSecs;
 
-        /** @brief [Optional, Default: 0] Default transaction time in milliseconds to any RP in the cluster */
+        /** @brief [Optional, Default: 10000] Default transaction time in milliseconds to any RP in the cluster */
         int                                 transactionTimeoutMs;
 
         RallypointCluster()
@@ -2986,8 +3009,8 @@ namespace AppConfigurationObjects
             connectionStrategy = csRoundRobin;
             rallypoints.clear();
             rolloverSecs = 10;
-            connectionTimeoutSecs = 0;
-            transactionTimeoutMs = 0;
+            connectionTimeoutSecs = 5;
+            transactionTimeoutMs = 10000;
         }
     };
 
@@ -3007,8 +3030,8 @@ namespace AppConfigurationObjects
         getOptional<RallypointCluster::ConnectionStrategy_t>("connectionStrategy", p.connectionStrategy, RallypointCluster::ConnectionStrategy_t::csRoundRobin);
         getOptional<std::vector<Rallypoint>>("rallypoints", p.rallypoints, j);
         getOptional<int>("rolloverSecs", p.rolloverSecs, j, 10);
-        getOptional<int>("connectionTimeoutSecs", p.connectionTimeoutSecs, j, 0);
-        getOptional<int>("transactionTimeoutMs", p.connectionTimeoutSecs, j, 0);        
+        getOptional<int>("connectionTimeoutSecs", p.connectionTimeoutSecs, j, 5);
+        getOptional<int>("transactionTimeoutMs", p.transactionTimeoutMs, j, 10000);        
     }
 
 
@@ -4022,6 +4045,9 @@ namespace AppConfigurationObjects
         /** @brief [Optional, Default: 5] The minimum interval to send at to prevent network flooding */
         int             minIntervalSecs;
 
+        /** @brief [Optional, Default: false] Instructs the Engage Engine reduce the immediacy of presence announcements wherever possible */
+        bool            reduceImmediacy;
+
         Presence()
         {
             clear();
@@ -4033,6 +4059,7 @@ namespace AppConfigurationObjects
             intervalSecs = 30;
             listenOnly = false;
             minIntervalSecs = 5;
+            reduceImmediacy = false;
         }
     };
 
@@ -4042,7 +4069,8 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(format),
             TOJSON_IMPL(intervalSecs),
             TOJSON_IMPL(listenOnly),
-            TOJSON_IMPL(minIntervalSecs)
+            TOJSON_IMPL(minIntervalSecs),
+            TOJSON_IMPL(reduceImmediacy)
         };
     }
     static void from_json(const nlohmann::json& j, Presence& p)
@@ -4052,6 +4080,7 @@ namespace AppConfigurationObjects
         getOptional<int>("intervalSecs", p.intervalSecs, j, 30);
         getOptional<bool>("listenOnly", p.listenOnly, j, false);
         getOptional<int>("minIntervalSecs", p.minIntervalSecs, j, 5);
+        getOptional<bool>("reduceImmediacy", p.reduceImmediacy, j, false);
     }
 
 
@@ -4706,6 +4735,79 @@ namespace AppConfigurationObjects
         FROMJSON_IMPL_SIMPLE(alias);
     }
 
+    //-----------------------------------------------------------
+    JSON_SERIALIZED_CLASS(GroupBridgeTargetOutputDetail)
+    /**
+     * @brief Options for Source
+     *
+     *  Helper C++ class to serialize and de-serialize GroupBridgeTargetOutputDetail JSON
+     *
+     *  TODO: Complete this Class
+     *
+     *  Example: @include[doc] examples/GroupBridgeTargetOutputDetail.json
+     *
+     *  @see Group
+     */
+    class GroupBridgeTargetOutputDetail : public ConfigurationObjectBase
+    {
+        IMPLEMENT_JSON_SERIALIZATION()
+        IMPLEMENT_JSON_DOCUMENTATION(GroupBridgeTargetOutputDetail)
+
+    public:
+        /** @brief Enum describing bridging operation mode types where applicable. */
+        typedef enum
+        {
+            /** @brief Raw mode (default) - packet payloads are not accessed or modified and forwarded as raw packets. The
+             * group must have a type of @ref gtRaw.
+             */
+            bomRaw                      = 0,
+
+            /** @brief Audio payloads are transformed, headers are preserved, multiple parallel output streams are 
+             * possible/expected. The group must be gtAudio (type = 1).*/
+            bomMultistream    = 1,
+
+            /** @brief Audio payloads are mixed - output is anonymous (i.e. no metadata) if if the target group(s) 
+             * allow header extensions. The group must be gtAudio (type = 1)*/
+            bomMixedStream          = 2,
+        } BridgingOpMode_t;
+
+        /** @brief [Optional] The output mode */
+        BridgingOpMode_t        mode;
+
+        /** @brief [Optional] Parameters to be applied when output is mixed (bomMixedStream) */
+        AdvancedTxParams        mixedStreamTxParams;
+
+        GroupBridgeTargetOutputDetail()
+        {
+            clear();
+        }
+
+        void clear()
+        {
+            mode = BridgingOpMode_t::bomRaw;
+            mixedStreamTxParams.clear();
+        }
+
+        virtual void initForDocumenting()
+        {
+            clear();
+        }
+    };
+
+    static void to_json(nlohmann::json& j, const GroupBridgeTargetOutputDetail& p)
+    {
+        j = nlohmann::json{
+            TOJSON_IMPL(mode),
+            TOJSON_IMPL(mixedStreamTxParams)
+        };
+    }
+    static void from_json(const nlohmann::json& j, GroupBridgeTargetOutputDetail& p)
+    {
+        p.clear();
+        FROMJSON_IMPL_SIMPLE(mode);
+        FROMJSON_IMPL_SIMPLE(mixedStreamTxParams);
+    }    
+
     //-----------------------------------------------------------
     JSON_SERIALIZED_CLASS(Group)
     /**
@@ -4740,23 +4842,6 @@ namespace AppConfigurationObjects
             gtRaw       = 3
         } Type_t;
 
-
-        /** @brief Enum describing bridging operation mode types where applicable. */
-        typedef enum
-        {
-            /** @brief Raw mode (default) - packet payloads are not accessed or modified and forwarded as raw packets */
-            bomRaw                      = 0,
-
-            /** @brief Audio payloads are transformed, headers are preserved, multiple parallel output streams are possible/expected */
-            bomPayloadTransformation    = 1,
-
-            /** @brief Audio payloads are mixed - output is anonymous (i.e. no metadata) if if the target group(s) allow header extensions */
-            bomAnonymousMixing          = 2,
-
-            /** @brief The bridge performs language translations between groups */
-            bomLanguageTranslation      = 3
-        } BridgingOpMode_t;
-
         /** @brief Enum describing the alias generation policy. */
         typedef enum
         {
@@ -4770,8 +4855,8 @@ namespace AppConfigurationObjects
         /** @brief Specifies the group type (see @ref Type_t). */
         Type_t                                  type;
 
-        /** @brief Specifies the bridging operation mode if applicable (see @ref BridgingOpMode_t). */
-        BridgingOpMode_t                        bom;
+        /** @brief Output details for when the group is a target in a bridge (see @ref GroupBridgeTargetOutputDetail). */
+        GroupBridgeTargetOutputDetail          bridgeTargetOutputDetail;
 
         /**
          * @brief Unique identity for the group.
@@ -4937,7 +5022,7 @@ namespace AppConfigurationObjects
         void clear()
         {
             type = gtUnknown;
-            bom = bomRaw;
+            bridgeTargetOutputDetail.clear();
             id.clear();
             name.clear();
             spokenName.clear();
@@ -5014,7 +5099,7 @@ namespace AppConfigurationObjects
     {
         j = nlohmann::json{
             TOJSON_IMPL(type),
-            TOJSON_IMPL(bom),
+            TOJSON_IMPL(bridgeTargetOutputDetail),
             TOJSON_IMPL(id),
             TOJSON_IMPL(name),
             TOJSON_IMPL(spokenName),
@@ -5106,7 +5191,7 @@ namespace AppConfigurationObjects
     {
         p.clear();
         j.at("type").get_to(p.type);
-        getOptional<Group::BridgingOpMode_t>("bom", p.bom, j, Group::BridgingOpMode_t::bomRaw);
+        getOptional<GroupBridgeTargetOutputDetail>("bridgeTargetOutputDetail", p.bridgeTargetOutputDetail, j);
         j.at("id").get_to(p.id);
         getOptional<std::string>("name", p.name, j);
         getOptional<std::string>("spokenName", p.spokenName, j);
@@ -5724,7 +5809,9 @@ namespace AppConfigurationObjects
         /** @brief List of group IDs to be included in the session */
         std::vector<std::string>    groups;
 
-        /** @brief [Optional, Default: true] Enable the bridge */
+        /** @brief [Optional, Default: true] Enable the bridge 
+        * NOTE: this is only used bt EBS and is ignored when calling engageCreateBridge() is called
+        */
         bool                        enabled;
 
         Bridge()
@@ -8643,6 +8730,54 @@ namespace AppConfigurationObjects
     }
 
 
+
+
+    //-----------------------------------------------------------
+    JSON_SERIALIZED_CLASS(NamedIdentity)
+    /**
+     * @brief Defines settings for a named identity
+     *
+     * Example: @include[doc] examples/NamedIdentity.json
+     *
+     */
+    class NamedIdentity : public ConfigurationObjectBase
+    {
+        IMPLEMENT_JSON_SERIALIZATION()
+        IMPLEMENT_JSON_DOCUMENTATION(NamedIdentity)
+
+    public:
+        /** @brief The identity name */
+        std::string                             name;
+
+        /** @brief The identity certificate */
+        SecurityCertificate                     certificate;
+
+        NamedIdentity()
+        {
+            clear();
+        }
+
+        void clear()
+        {
+            name.clear();
+            certificate.clear();
+        }
+    };
+
+    static void to_json(nlohmann::json& j, const NamedIdentity& p)
+    {
+        j = nlohmann::json{
+            TOJSON_IMPL(name),
+            TOJSON_IMPL(certificate)
+        };
+    }
+    static void from_json(const nlohmann::json& j, NamedIdentity& p)
+    {
+        p.clear();
+        getOptional<std::string>("name", p.name, j);
+        getOptional<SecurityCertificate>("certificate", p.certificate, j);
+    }
+
     //-----------------------------------------------------------
     JSON_SERIALIZED_CLASS(RallypointExtendedGroupRestriction)
     /**
@@ -8706,6 +8841,32 @@ namespace AppConfigurationObjects
         IMPLEMENT_JSON_DOCUMENTATION(RallypointServer)
 
     public:        
+        typedef enum
+        {
+            sptDefault              = 0,
+            sptCertificate          = 1,
+            sptCertPublicKey        = 2,
+            sptCertSubject          = 3,
+            sptCertIssuer           = 4,
+            sptCertFingerprint      = 5,
+            sptCertSerial           = 6,
+            sptSubjectC             = 7,
+            sptSubjectST            = 8,
+            sptSubjectL             = 9,
+            sptSubjectO             = 10,
+            sptSubjectOU            = 11,
+            sptSubjectCN            = 12,
+            sptIssuerC              = 13,
+            sptIssuerST             = 14,
+            sptIssuerL              = 15,
+            sptIssuerO              = 16,
+            sptIssuerOU             = 17,
+            sptIssuerCN             = 18
+        } StreamIdPrivacyType_t;
+
+        /** @brief [Optional, default sptDefault] Modes for stream ID transformation. */
+        StreamIdPrivacyType_t                       streamIdPrivacyType;
+
         /** @brief [Optional] Settings for the FIPS crypto. */
         FipsCryptoSettings                          fipsCrypto;
     
@@ -8880,6 +9041,9 @@ namespace AppConfigurationObjects
         /** @brief [Optional] Low-level tuning */
         TuningSettings                          tuning; 
 
+        /** @brief [Optional] List of additional named identities */
+        std::vector<NamedIdentity>               additionalIdentities;
+
         RallypointServer()
         {
             clear();
@@ -8945,6 +9109,8 @@ namespace AppConfigurationObjects
             blockedDomains.clear();
             extraDomains.clear();
             tuning.clear();
+            additionalIdentities.clear();
+            streamIdPrivacyType = StreamIdPrivacyType_t::sptDefault;
         }
     };
 
@@ -9008,7 +9174,9 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(allowedDomains),
             TOJSON_IMPL(blockedDomains),
             TOJSON_IMPL(extraDomains),
-            TOJSON_IMPL(tuning)
+            TOJSON_IMPL(tuning),
+            TOJSON_IMPL(additionalIdentities),
+            TOJSON_IMPL(streamIdPrivacyType)
         };
     }
     static void from_json(const nlohmann::json& j, RallypointServer& p)
@@ -9072,6 +9240,8 @@ namespace AppConfigurationObjects
         getOptional<std::vector<std::string>>("blockedDomains", p.blockedDomains, j);
         getOptional<std::vector<std::string>>("extraDomains", p.extraDomains, j);
         getOptional<TuningSettings>("tuning", p.tuning, j);
+        getOptional<std::vector<NamedIdentity>>("additionalIdentities", p.additionalIdentities, j);
+        getOptional<RallypointServer::StreamIdPrivacyType_t>("streamIdPrivacyType", p.streamIdPrivacyType, j, RallypointServer::StreamIdPrivacyType_t::sptDefault);
     }
 
     //-----------------------------------------------------------
@@ -9609,6 +9779,9 @@ namespace AppConfigurationObjects
         /** @brief Array of subject elements */
         std::vector<CertificateSubjectElement>          subjectElements;
 
+        /** @brief Array of issuer elements */
+        std::vector<CertificateSubjectElement>          issuerElements;        
+
         /** @brief PEM version of the certificate */
         std::string                                     certificatePem;
 
@@ -9631,6 +9804,7 @@ namespace AppConfigurationObjects
             serial.clear();
             fingerprint.clear();
             subjectElements.clear();
+            issuerElements.clear();
             certificatePem.clear();
             publicKeyPem.clear();
         }
@@ -9648,6 +9822,7 @@ namespace AppConfigurationObjects
             TOJSON_IMPL(serial),
             TOJSON_IMPL(fingerprint),
             TOJSON_IMPL(subjectElements),
+            TOJSON_IMPL(issuerElements),
             TOJSON_IMPL(certificatePem),
             TOJSON_IMPL(publicKeyPem)
         };
@@ -9666,6 +9841,7 @@ namespace AppConfigurationObjects
         getOptional<std::string>("certificatePem", p.certificatePem, j, EMPTY_STRING);
         getOptional<std::string>("publicKeyPem", p.publicKeyPem, j, EMPTY_STRING);
         getOptional<std::vector<CertificateSubjectElement>>("subjectElements", p.subjectElements, j);
+        getOptional<std::vector<CertificateSubjectElement>>("issuerElements", p.issuerElements, j);
     }
 
 
@@ -9975,6 +10151,12 @@ namespace AppConfigurationObjects
 
             /** @brief  TX has ended with a failure */
             txsTxEndedWithFailure           = -10,
+
+            /** @brief  Attempt to transmit on a bridged group that is not bomMultistream */
+            txsBridgedButNotMultistream     = -11,
+
+            /** @brief  Transmission was automatically ended because the group became bridged on a non-multistream configuration */
+            txsAutoEndedDueToNonMultistreamBridge     = -12        
         } TxStatus_t;
 
         /** @brief ID of the group */
@@ -11250,26 +11432,33 @@ namespace AppConfigurationObjects
         IMPLEMENT_JSON_DOCUMENTATION(BridgingServerConfiguration)
 
     public:
-        /** @brief Enum describing the modes the briging service runs in. */
+        /** @brief Enum describing the default mode the bridging service runs in. Values of omRaw,
+         *          omMultistream, omAnonymousMixedStream all cause the service to force the
+         *          groups in a bridge to the appropriate type.  A value of omADictatedByGroup prevents
+         *          the service from forcing the individual groups' "type" and "bom" values and
+         *          instead relies on the individual groups to be correctly defined in the configuration.
+          */
         typedef enum
         {
-            /** @brief Raw mode (default) - packet payloads are not accessed or modified and forwarded as raw packets */
+            /** @brief Raw mode (default) - packet payloads are not accessed or modified and forwarded as raw packets. */
             omRaw                       = 0,
 
-            /** @brief Audio payloads are transformed, headers are preserved, multiple parallel output streams are possible/expected */
-            omPayloadTransformation     = 1,
+            /** @brief Audio payloads are transformed, headers are preserved, multiple parallel output streams are 
+             * possible/expected. In this mode all groups must be gtAudio (type = 1).*/
+            omMultistream               = 1,
 
-            /** @brief Audio payloads are mixed - output is anonymous (i.e. no metadata) if if the target group(s) allow header extensions */
-            omAnonymousMixing           = 2,
+            /** @brief Audio payloads are mixed - output is anonymous (i.e. no metadata) even if the target group(s) 
+             * allow header extensions.  In this mode all groups must be gtAudio (type = 1). */
+            omMixedStream               = 2,
 
-            /** @brief Audio payloads are translated between group-specific languages */
-            omLanguageTranslation       = 3
+            /** @brief Operation is dictated by the individual groups in the bridge */
+            omADictatedByGroup          = 3,
         } OpMode_t;
 
         /** @brief A unqiue identifier for the bridge server */
         std::string                                 id;
 
-        /** @brief Specifies the operation mode (see @ref OpMode_t). */
+        /** @brief Specifies the default operation mode (see @ref OpMode_t). */
         OpMode_t                                    mode;
 
         /** @brief Number of seconds between checks to see if the service configuration has been updated.  Default is 60.*/

package/include/EngageConstants.h

@@ -27,7 +27,7 @@ static const size_t ENGAGE_MAX_CRYPTO_PASSWORD_BYTES = 256;
 
 static const int ENGAGE_INVALID_IP_ADDRESS_FAMILY = -1;
 
-static const size_t ENGAGE_MAX_RTP_OUTPUT_QUEUE_PACKETS = 100;
+static const size_t ENGAGE_MAX_OUTPUT_QUEUED_UDP_PACKETS = 1024;
 
 static const size_t ENGAGE_MAX_IP_ADDR_SIZE = sizeof(struct sockaddr_in6);
 static const size_t ENGAGE_MAX_ALIAS_SIZE = 16;

package/package.json

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