20#ifndef ConfigurationObjects_h
21#define ConfigurationObjects_h
24#include "EngageConstants.h"
33#include <nlohmann/json.hpp>
36 #pragma GCC diagnostic push
37 #pragma GCC diagnostic ignored "-Wunused-function"
40#if !defined(ENGAGE_IGNORE_COMPILER_UNUSED_WARNING)
42 #define ENGAGE_IGNORE_COMPILER_UNUSED_WARNING __attribute__((unused))
44 #define ENGAGE_IGNORE_COMPILER_UNUSED_WARNING
50#if defined(RTS_CORE_BUILD)
51namespace ConfigurationObjects
53namespace AppConfigurationObjects
56 static const char *ENGAGE_CONFIGURATION_OBJECT_ATTACHED_OBJECT =
"_attached";
150 } DataSeriesValueType_t;
164 bloodOxygenation = 5,
166 taskEffectiveness = 7
167 } HumanBiometricsTypes_t;
171 static FILE *_internalFileOpener(
const char *fn,
const char *mode)
176 fp = fopen(fn, mode);
178 if(fopen_s(&fp, fn, mode) != 0)
187 #define JSON_SERIALIZED_CLASS(_cn) \
189 static void to_json(nlohmann::json& j, const _cn& p); \
190 static void from_json(const nlohmann::json& j, _cn& p);
192 #define IMPLEMENT_JSON_DOCUMENTATION(_cn) \
194 static void document(const char *path = nullptr) \
197 example.initForDocumenting(); \
198 std::string theJson = example.serialize(3); \
199 std::cout << "------------------------------------------------" << std::endl \
200 << #_cn << std::endl \
201 << theJson << std::endl \
202 << "------------------------------------------------" << std::endl; \
204 if(path != nullptr && path[0] != 0) \
206 std::string fn = path; \
209 fn.append(".json"); \
211 FILE *fp = _internalFileOpener(fn.c_str(), "wt");\
215 fputs(theJson.c_str(), fp); \
220 std::cout << "ERROR: Cannot write to " << fn << std::endl; \
224 static const char *className() \
229 #define IMPLEMENT_JSON_SERIALIZATION() \
231 bool deserialize(const char *s) \
235 if(s != nullptr && s[0] != 0) \
237 from_json(nlohmann::json::parse(s), *this); \
251 std::string serialize(const int indent = -1) \
257 return j.dump(indent); \
261 return std::string("{}"); \
265 #define IMPLEMENT_WRAPPED_JSON_SERIALIZATION(_cn) \
267 std::string serializeWrapped(const int indent = -1) \
276 firstChar[0] = #_cn[0]; \
278 firstChar[0] = tolower(firstChar[0]); \
280 rc.append(firstChar); \
281 rc.append((#_cn) + 1); \
283 rc.append(j.dump(indent)); \
290 return std::string("{}"); \
294 #define TOJSON_IMPL(__var) \
297 #define FROMJSON_IMPL_SIMPLE(__var) \
298 getOptional(#__var, p.__var, j)
300 #define FROMJSON_IMPL(__var, __type, __default) \
301 getOptional<__type>(#__var, p.__var, j, __default)
303 #define TOJSON_BASE_IMPL() \
304 to_json(j, (ConfigurationObjectBase&)p)
306 #define FROMJSON_BASE_IMPL() \
307 from_json(j, (ConfigurationObjectBase&)p);
311 static std::string EMPTY_STRING;
314 static void getOptional(
const char *name, T& v,
const nlohmann::json& j, T def)
320 j.at(name).get_to(v);
334 static void getOptional(
const char *name, T& v,
const nlohmann::json& j)
340 j.at(name).get_to(v);
349 static void getOptionalWithIndicator(
const char *name, T& v,
const nlohmann::json& j, T def,
bool *wasFound)
355 j.at(name).get_to(v);
372 static void getOptionalWithIndicator(
const char *name, T& v,
const nlohmann::json& j,
bool *wasFound)
378 j.at(name).get_to(v);
397 _documenting =
false;
404 virtual void initForDocumenting()
409 virtual std::string toString()
411 return std::string(
"");
414 inline virtual bool isDocumenting()
const
419 nlohmann::json _attached;
429 if(p._attached !=
nullptr)
431 j[ENGAGE_CONFIGURATION_OBJECT_ATTACHED_OBJECT] = p._attached;
438 static void from_json(
const nlohmann::json& j, ConfigurationObjectBase& p)
442 if(j.contains(ENGAGE_CONFIGURATION_OBJECT_ATTACHED_OBJECT))
444 p._attached = j.at(ENGAGE_CONFIGURATION_OBJECT_ATTACHED_OBJECT);
453 JSON_SERIALIZED_CLASS(KvPair)
462 IMPLEMENT_JSON_SERIALIZATION()
463 IMPLEMENT_JSON_DOCUMENTATION(
KvPair)
484 static void to_json(nlohmann::json& j,
const KvPair& p)
491 static void from_json(
const nlohmann::json& j, KvPair& p)
494 getOptional<std::string>(
"key", p.key, j, EMPTY_STRING);
495 getOptional<std::string>(
"tags", p.value, j, EMPTY_STRING);
499 JSON_SERIALIZED_CLASS(TuningSettings)
502 IMPLEMENT_JSON_SERIALIZATION()
546 maxPooledRtpObjects = 0;
547 maxActiveRtpObjects = 0;
550 maxPooledBlobObjects = 0;
551 maxActiveBlobObjects = 0;
553 maxPooledBufferMb = 0;
554 maxPooledBufferObjects = 0;
555 maxActiveBufferObjects = 0;
557 maxActiveRtpProcessors = 0;
560 virtual void initForDocumenting()
566 static void to_json(nlohmann::json& j,
const TuningSettings& p)
569 TOJSON_IMPL(maxPooledRtpMb),
570 TOJSON_IMPL(maxPooledRtpObjects),
571 TOJSON_IMPL(maxActiveRtpObjects),
573 TOJSON_IMPL(maxPooledBlobMb),
574 TOJSON_IMPL(maxPooledBlobObjects),
575 TOJSON_IMPL(maxActiveBlobObjects),
577 TOJSON_IMPL(maxPooledBufferMb),
578 TOJSON_IMPL(maxPooledBufferObjects),
579 TOJSON_IMPL(maxActiveBufferObjects),
581 TOJSON_IMPL(maxActiveRtpProcessors)
584 static void from_json(
const nlohmann::json& j, TuningSettings& p)
587 FROMJSON_IMPL(maxPooledRtpMb, uint32_t, 0);
588 FROMJSON_IMPL(maxPooledRtpObjects, uint32_t, 0);
589 FROMJSON_IMPL(maxActiveRtpObjects, uint32_t, 0);
591 FROMJSON_IMPL(maxPooledBlobMb, uint32_t, 0);
592 FROMJSON_IMPL(maxPooledBlobObjects, uint32_t, 0);
593 FROMJSON_IMPL(maxActiveBlobObjects, uint32_t, 0);
595 FROMJSON_IMPL(maxPooledBufferMb, uint32_t, 0);
596 FROMJSON_IMPL(maxPooledBufferObjects, uint32_t, 0);
597 FROMJSON_IMPL(maxActiveBufferObjects, uint32_t, 0);
599 FROMJSON_IMPL(maxActiveRtpProcessors, uint32_t, 0);
604 JSON_SERIALIZED_CLASS(FipsCryptoSettings)
607 IMPLEMENT_JSON_SERIALIZATION()
640 virtual void initForDocumenting()
646 static void to_json(nlohmann::json& j,
const FipsCryptoSettings& p)
649 TOJSON_IMPL(enabled),
656 static void from_json(
const nlohmann::json& j, FipsCryptoSettings& p)
659 FROMJSON_IMPL_SIMPLE(enabled);
660 FROMJSON_IMPL_SIMPLE(path);
661 FROMJSON_IMPL_SIMPLE(debug);
662 FROMJSON_IMPL_SIMPLE(curves);
663 FROMJSON_IMPL_SIMPLE(ciphers);
668 JSON_SERIALIZED_CLASS(WatchdogSettings)
671 IMPLEMENT_JSON_SERIALIZATION()
699 hangDetectionMs = 2000;
701 slowExecutionThresholdMs = 100;
704 virtual void initForDocumenting()
710 static void to_json(nlohmann::json& j,
const WatchdogSettings& p)
713 TOJSON_IMPL(enabled),
714 TOJSON_IMPL(intervalMs),
715 TOJSON_IMPL(hangDetectionMs),
716 TOJSON_IMPL(abortOnHang),
717 TOJSON_IMPL(slowExecutionThresholdMs)
720 static void from_json(
const nlohmann::json& j, WatchdogSettings& p)
723 getOptional<bool>(
"enabled", p.enabled, j,
true);
724 getOptional<int>(
"intervalMs", p.intervalMs, j, 5000);
725 getOptional<int>(
"hangDetectionMs", p.hangDetectionMs, j, 2000);
726 getOptional<bool>(
"abortOnHang", p.abortOnHang, j,
true);
727 getOptional<int>(
"slowExecutionThresholdMs", p.slowExecutionThresholdMs, j, 100);
732 JSON_SERIALIZED_CLASS(FileRecordingRequest)
735 IMPLEMENT_JSON_SERIALIZATION()
740 std::string fileName;
755 virtual void initForDocumenting()
758 id =
"1-2-3-4-5-6-7-8-9";
759 fileName =
"/tmp/test.wav";
768 TOJSON_IMPL(fileName),
772 static void from_json(
const nlohmann::json& j, FileRecordingRequest& p)
775 j.at(
"id").get_to(p.id);
776 j.at(
"fileName").get_to(p.fileName);
777 getOptional<uint32_t>(
"maxMs", p.maxMs, j, 60000);
782 JSON_SERIALIZED_CLASS(Feature)
785 IMPLEMENT_JSON_SERIALIZATION()
786 IMPLEMENT_JSON_DOCUMENTATION(
Feature)
791 std::string description;
792 std::string comments;
811 virtual void initForDocumenting()
814 id =
"{af9540d1-3e86-4fa6-8b80-e26daecb61ab}";
815 name =
"A sample feature";
816 description =
"This is an example of a feature";
817 comments =
"These are comments for this feature";
823 static void to_json(nlohmann::json& j,
const Feature& p)
828 TOJSON_IMPL(description),
829 TOJSON_IMPL(comments),
834 static void from_json(
const nlohmann::json& j, Feature& p)
837 j.at(
"id").get_to(p.id);
838 getOptional(
"name", p.name, j);
839 getOptional(
"description", p.description, j);
840 getOptional(
"comments", p.comments, j);
841 getOptional(
"count", p.count, j, 0);
849 JSON_SERIALIZED_CLASS(Featureset)
852 IMPLEMENT_JSON_SERIALIZATION()
856 std::string signature;
858 std::vector<Feature> features;
868 lockToDeviceId =
false;
872 virtual void initForDocumenting()
875 signature =
"c39df3f36c6444e686e47e70fc45cf91e6ed2d8de62d4a1e89f507d567ff48aaabb1a70e54b44377b46fc4a1a2e319e5b77e4abffc444db98f8eb55d709aad5f";
876 lockToDeviceId =
false;
880 static void to_json(nlohmann::json& j,
const Featureset& p)
883 TOJSON_IMPL(signature),
884 TOJSON_IMPL(lockToDeviceId),
885 TOJSON_IMPL(features)
888 static void from_json(
const nlohmann::json& j, Featureset& p)
891 getOptional(
"signature", p.signature, j);
892 getOptional<bool>(
"lockToDeviceId", p.lockToDeviceId, j,
false);
893 getOptional<std::vector<Feature>>(
"features", p.features, j);
898 JSON_SERIALIZED_CLASS(Agc)
909 IMPLEMENT_JSON_SERIALIZATION()
910 IMPLEMENT_JSON_DOCUMENTATION(
Agc)
941 compressionGainDb = 25;
942 enableLimiter =
false;
947 static void to_json(nlohmann::json& j,
const Agc& p)
950 TOJSON_IMPL(enabled),
951 TOJSON_IMPL(minLevel),
952 TOJSON_IMPL(maxLevel),
953 TOJSON_IMPL(compressionGainDb),
954 TOJSON_IMPL(enableLimiter),
955 TOJSON_IMPL(targetLevelDb)
958 static void from_json(
const nlohmann::json& j, Agc& p)
961 getOptional<bool>(
"enabled", p.enabled, j,
false);
962 getOptional<int>(
"minLevel", p.minLevel, j, 0);
963 getOptional<int>(
"maxLevel", p.maxLevel, j, 255);
964 getOptional<int>(
"compressionGainDb", p.compressionGainDb, j, 25);
965 getOptional<bool>(
"enableLimiter", p.enableLimiter, j,
false);
966 getOptional<int>(
"targetLevelDb", p.targetLevelDb, j, 3);
971 JSON_SERIALIZED_CLASS(RtpPayloadTypeTranslation)
982 IMPLEMENT_JSON_SERIALIZATION()
1003 bool matches(
const RtpPayloadTypeTranslation& other)
1005 return ( (external == other.external) && (engage == other.engage) );
1009 static void to_json(nlohmann::json& j,
const RtpPayloadTypeTranslation& p)
1012 TOJSON_IMPL(external),
1016 static void from_json(
const nlohmann::json& j, RtpPayloadTypeTranslation& p)
1019 getOptional<uint16_t>(
"external", p.external, j);
1020 getOptional<uint16_t>(
"engage", p.engage, j);
1024 JSON_SERIALIZED_CLASS(NetworkInterfaceDevice)
1027 IMPLEMENT_JSON_SERIALIZATION()
1032 std::string friendlyName;
1033 std::string description;
1035 std::string address;
1038 bool supportsMulticast;
1039 std::string hardwareAddress;
1049 friendlyName.clear();
1050 description.clear();
1055 supportsMulticast =
false;
1056 hardwareAddress.clear();
1059 virtual void initForDocumenting()
1063 friendlyName =
"Wi-Fi";
1064 description =
"A wi-fi adapter";
1066 address =
"127.0.0.1";
1069 supportsMulticast =
false;
1070 hardwareAddress =
"DE:AD:BE:EF:01:02:03";
1078 TOJSON_IMPL(friendlyName),
1079 TOJSON_IMPL(description),
1080 TOJSON_IMPL(family),
1081 TOJSON_IMPL(address),
1082 TOJSON_IMPL(available),
1083 TOJSON_IMPL(isLoopback),
1084 TOJSON_IMPL(supportsMulticast),
1085 TOJSON_IMPL(hardwareAddress)
1088 static void from_json(
const nlohmann::json& j, NetworkInterfaceDevice& p)
1091 getOptional(
"name", p.name, j);
1092 getOptional(
"friendlyName", p.friendlyName, j);
1093 getOptional(
"description", p.description, j);
1094 getOptional(
"family", p.family, j, -1);
1095 getOptional(
"address", p.address, j);
1096 getOptional(
"available", p.available, j,
false);
1097 getOptional(
"isLoopback", p.isLoopback, j,
false);
1098 getOptional(
"supportsMulticast", p.supportsMulticast, j,
false);
1099 getOptional(
"hardwareAddress", p.hardwareAddress, j);
1103 JSON_SERIALIZED_CLASS(ListOfNetworkInterfaceDevice)
1106 IMPLEMENT_JSON_SERIALIZATION()
1110 std::vector<NetworkInterfaceDevice> list;
1129 static void from_json(
const nlohmann::json& j, ListOfNetworkInterfaceDevice& p)
1132 getOptional<std::vector<NetworkInterfaceDevice>>(
"list", p.list, j);
1137 JSON_SERIALIZED_CLASS(RtpHeader)
1148 IMPLEMENT_JSON_SERIALIZATION()
1182 virtual void initForDocumenting()
1193 static void to_json(nlohmann::json& j,
const RtpHeader& p)
1199 TOJSON_IMPL(marker),
1206 static void from_json(
const nlohmann::json& j, RtpHeader& p)
1209 getOptional<int>(
"pt", p.pt, j, -1);
1210 getOptional<bool>(
"marker", p.marker, j,
false);
1211 getOptional<uint16_t>(
"seq", p.seq, j, 0);
1212 getOptional<uint32_t>(
"ssrc", p.ssrc, j, 0);
1213 getOptional<uint32_t>(
"ts", p.ts, j, 0);
1217 JSON_SERIALIZED_CLASS(Rfc4733Event)
1226 IMPLEMENT_JSON_SERIALIZATION()
1260 virtual void initForDocumenting()
1271 static void to_json(nlohmann::json& j,
const Rfc4733Event& p)
1276 TOJSON_IMPL(reserved),
1277 TOJSON_IMPL(volume),
1278 TOJSON_IMPL(duration)
1281 static void from_json(
const nlohmann::json& j, Rfc4733Event& p)
1284 getOptional<int>(
"id", p.id, j, -1);
1285 getOptional<bool>(
"end", p.end, j,
false);
1286 getOptional<int>(
"reserved", p.reserved, j, 0);
1287 getOptional<int>(
"volume", p.volume, j, 0);
1288 getOptional<int>(
"duration", p.duration, j, 0);
1292 JSON_SERIALIZED_CLASS(BlobInfo)
1303 IMPLEMENT_JSON_SERIALIZATION()
1304 IMPLEMENT_JSON_DOCUMENTATION(
BlobInfo)
1319 bptJsonTextUtf8 = 2,
1325 bptEngageBinaryHumanBiometrics = 4,
1328 bptAppMimeMessage = 5,
1331 bptRfc4733Events = 6,
1334 bptEngageInternal = 42
1369 payloadType = PayloadType_t::bptUndefined;
1374 virtual void initForDocumenting()
1377 rtpHeader.initForDocumenting();
1381 static void to_json(nlohmann::json& j,
const BlobInfo& p)
1385 TOJSON_IMPL(source),
1386 TOJSON_IMPL(target),
1387 TOJSON_IMPL(rtpHeader),
1388 TOJSON_IMPL(payloadType),
1390 TOJSON_IMPL(txnTimeoutSecs)
1393 static void from_json(
const nlohmann::json& j, BlobInfo& p)
1396 getOptional<size_t>(
"size", p.size, j, 0);
1397 getOptional<std::string>(
"source", p.source, j, EMPTY_STRING);
1398 getOptional<std::string>(
"target", p.target, j, EMPTY_STRING);
1399 getOptional<RtpHeader>(
"rtpHeader", p.rtpHeader, j);
1400 getOptional<BlobInfo::PayloadType_t>(
"payloadType", p.payloadType, j, BlobInfo::PayloadType_t::bptUndefined);
1401 getOptional<std::string>(
"txnId", p.txnId, j, EMPTY_STRING);
1402 getOptional<int>(
"txnTimeoutSecs", p.txnTimeoutSecs, j, 0);
1407 JSON_SERIALIZED_CLASS(TxAudioUri)
1421 IMPLEMENT_JSON_SERIALIZATION()
1442 virtual void initForDocumenting()
1447 static void to_json(nlohmann::json& j,
const TxAudioUri& p)
1451 TOJSON_IMPL(repeatCount)
1454 static void from_json(
const nlohmann::json& j, TxAudioUri& p)
1457 getOptional<std::string>(
"uri", p.uri, j, EMPTY_STRING);
1458 getOptional<int>(
"repeatCount", p.repeatCount, j, 0);
1463 JSON_SERIALIZED_CLASS(AdvancedTxParams)
1477 IMPLEMENT_JSON_SERIALIZATION()
1525 includeNodeId =
false;
1530 aliasSpecializer = 0;
1531 receiverRxMuteForAliasSpecializer =
false;
1535 virtual void initForDocumenting()
1540 static void to_json(nlohmann::json& j,
const AdvancedTxParams& p)
1544 TOJSON_IMPL(priority),
1545 TOJSON_IMPL(subchannelTag),
1546 TOJSON_IMPL(includeNodeId),
1550 TOJSON_IMPL(audioUri),
1551 TOJSON_IMPL(aliasSpecializer),
1552 TOJSON_IMPL(receiverRxMuteForAliasSpecializer),
1553 TOJSON_IMPL(reBegin)
1556 static void from_json(
const nlohmann::json& j, AdvancedTxParams& p)
1559 getOptional<uint16_t>(
"flags", p.flags, j, 0);
1560 getOptional<uint8_t>(
"priority", p.priority, j, 0);
1561 getOptional<uint16_t>(
"subchannelTag", p.subchannelTag, j, 0);
1562 getOptional<bool>(
"includeNodeId", p.includeNodeId, j,
false);
1563 getOptional<std::string>(
"alias", p.alias, j, EMPTY_STRING);
1564 getOptional<bool>(
"muted", p.muted, j,
false);
1565 getOptional<uint32_t>(
"txId", p.txId, j, 0);
1566 getOptional<TxAudioUri>(
"audioUri", p.audioUri, j);
1567 getOptional<uint16_t>(
"aliasSpecializer", p.aliasSpecializer, j, 0);
1568 getOptional<bool>(
"receiverRxMuteForAliasSpecializer", p.receiverRxMuteForAliasSpecializer, j,
false);
1569 getOptional<bool>(
"reBegin", p.reBegin, j,
false);
1573 JSON_SERIALIZED_CLASS(Identity)
1587 IMPLEMENT_JSON_SERIALIZATION()
1588 IMPLEMENT_JSON_DOCUMENTATION(
Identity)
1618 displayName.clear();
1622 virtual void initForDocumenting()
1627 static void to_json(nlohmann::json& j,
const Identity& p)
1630 TOJSON_IMPL(nodeId),
1631 TOJSON_IMPL(userId),
1632 TOJSON_IMPL(displayName),
1636 static void from_json(
const nlohmann::json& j, Identity& p)
1639 getOptional<std::string>(
"nodeId", p.nodeId, j);
1640 getOptional<std::string>(
"userId", p.userId, j);
1641 getOptional<std::string>(
"displayName", p.displayName, j);
1642 getOptional<std::string>(
"avatar", p.avatar, j);
1647 JSON_SERIALIZED_CLASS(Location)
1661 IMPLEMENT_JSON_SERIALIZATION()
1662 IMPLEMENT_JSON_DOCUMENTATION(
Location)
1665 constexpr static double INVALID_LOCATION_VALUE = -999.999;
1693 latitude = INVALID_LOCATION_VALUE;
1694 longitude = INVALID_LOCATION_VALUE;
1695 altitude = INVALID_LOCATION_VALUE;
1696 direction = INVALID_LOCATION_VALUE;
1697 speed = INVALID_LOCATION_VALUE;
1700 virtual void initForDocumenting()
1706 longitude = 456.789;
1713 static void to_json(nlohmann::json& j,
const Location& p)
1715 if(p.latitude != Location::INVALID_LOCATION_VALUE && p.longitude != Location::INVALID_LOCATION_VALUE)
1718 TOJSON_IMPL(latitude),
1719 TOJSON_IMPL(longitude),
1722 if(p.ts != 0) j[
"ts"] = p.ts;
1723 if(p.altitude != Location::INVALID_LOCATION_VALUE) j[
"altitude"] = p.altitude;
1724 if(p.speed != Location::INVALID_LOCATION_VALUE) j[
"speed"] = p.speed;
1725 if(p.direction != Location::INVALID_LOCATION_VALUE) j[
"direction"] = p.direction;
1728 static void from_json(
const nlohmann::json& j, Location& p)
1731 getOptional<uint32_t>(
"ts", p.ts, j, 0);
1732 j.at(
"latitude").get_to(p.latitude);
1733 j.at(
"longitude").get_to(p.longitude);
1734 getOptional<double>(
"altitude", p.altitude, j, Location::INVALID_LOCATION_VALUE);
1735 getOptional<double>(
"direction", p.direction, j, Location::INVALID_LOCATION_VALUE);
1736 getOptional<double>(
"speed", p.speed, j, Location::INVALID_LOCATION_VALUE);
1740 JSON_SERIALIZED_CLASS(Power)
1752 IMPLEMENT_JSON_SERIALIZATION()
1753 IMPLEMENT_JSON_DOCUMENTATION(
Power)
1799 virtual void initForDocumenting()
1804 static void to_json(nlohmann::json& j,
const Power& p)
1806 if(p.source != 0 && p.state != 0 && p.level != 0)
1809 TOJSON_IMPL(source),
1815 static void from_json(
const nlohmann::json& j, Power& p)
1818 getOptional<int>(
"source", p.source, j, 0);
1819 getOptional<int>(
"state", p.state, j, 0);
1820 getOptional<int>(
"level", p.level, j, 0);
1825 JSON_SERIALIZED_CLASS(Connectivity)
1837 IMPLEMENT_JSON_SERIALIZATION()
1874 virtual void initForDocumenting()
1884 static void to_json(nlohmann::json& j,
const Connectivity& p)
1890 TOJSON_IMPL(strength),
1895 static void from_json(
const nlohmann::json& j, Connectivity& p)
1898 getOptional<int>(
"type", p.type, j, 0);
1899 getOptional<int>(
"strength", p.strength, j, 0);
1900 getOptional<int>(
"rating", p.rating, j, 0);
1905 JSON_SERIALIZED_CLASS(PresenceDescriptorGroupItem)
1917 IMPLEMENT_JSON_SERIALIZATION()
1942 virtual void initForDocumenting()
1944 groupId =
"{123-456}";
1950 static void to_json(nlohmann::json& j,
const PresenceDescriptorGroupItem& p)
1953 TOJSON_IMPL(groupId),
1958 static void from_json(
const nlohmann::json& j, PresenceDescriptorGroupItem& p)
1961 getOptional<std::string>(
"groupId", p.groupId, j);
1962 getOptional<std::string>(
"alias", p.alias, j);
1963 getOptional<uint16_t>(
"status", p.status, j);
1968 JSON_SERIALIZED_CLASS(PresenceDescriptor)
1980 IMPLEMENT_JSON_SERIALIZATION()
2058 groupAliases.clear();
2061 announceOnReceive =
false;
2062 connectivity.clear();
2066 virtual void initForDocumenting()
2073 identity.initForDocumenting();
2074 comment =
"This is a comment";
2077 PresenceDescriptorGroupItem gi;
2078 gi.initForDocumenting();
2079 groupAliases.push_back(gi);
2081 location.initForDocumenting();
2083 announceOnReceive =
true;
2084 connectivity.initForDocumenting();
2085 power.initForDocumenting();
2089 static void to_json(nlohmann::json& j,
const PresenceDescriptor& p)
2093 TOJSON_IMPL(nextUpdate),
2094 TOJSON_IMPL(identity),
2095 TOJSON_IMPL(comment),
2096 TOJSON_IMPL(disposition),
2097 TOJSON_IMPL(groupAliases),
2098 TOJSON_IMPL(location),
2099 TOJSON_IMPL(custom),
2100 TOJSON_IMPL(announceOnReceive),
2101 TOJSON_IMPL(connectivity),
2105 if(!p.comment.empty()) j[
"comment"] = p.comment;
2106 if(!p.custom.empty()) j[
"custom"] = p.custom;
2113 static void from_json(
const nlohmann::json& j, PresenceDescriptor& p)
2116 getOptional<bool>(
"self", p.self, j);
2117 getOptional<uint32_t>(
"ts", p.ts, j);
2118 getOptional<uint32_t>(
"nextUpdate", p.nextUpdate, j);
2119 getOptional<Identity>(
"identity", p.identity, j);
2120 getOptional<std::string>(
"comment", p.comment, j);
2121 getOptional<uint32_t>(
"disposition", p.disposition, j);
2122 getOptional<std::vector<PresenceDescriptorGroupItem>>(
"groupAliases", p.groupAliases, j);
2123 getOptional<Location>(
"location", p.location, j);
2124 getOptional<std::string>(
"custom", p.custom, j);
2125 getOptional<bool>(
"announceOnReceive", p.announceOnReceive, j);
2126 getOptional<Connectivity>(
"connectivity", p.connectivity, j);
2127 getOptional<Power>(
"power", p.power, j);
2168 } AddressResolutionPolicy_t;
2171 JSON_SERIALIZED_CLASS(NetworkTxOptions)
2185 IMPLEMENT_JSON_SERIALIZATION()
2210 virtual void initForDocumenting()
2215 static void to_json(nlohmann::json& j,
const NetworkTxOptions& p)
2218 TOJSON_IMPL(priority),
2222 static void from_json(
const nlohmann::json& j, NetworkTxOptions& p)
2225 getOptional<TxPriority_t>(
"priority", p.priority, j, TxPriority_t::priVoice);
2226 getOptional<int>(
"ttl", p.ttl, j, 1);
2231 JSON_SERIALIZED_CLASS(TcpNetworkTxOptions)
2241 IMPLEMENT_JSON_SERIALIZATION()
2256 virtual void initForDocumenting()
2264 TOJSON_IMPL(priority),
2268 static void from_json(
const nlohmann::json& j, TcpNetworkTxOptions& p)
2271 getOptional<TxPriority_t>(
"priority", p.priority, j, TxPriority_t::priVoice);
2272 getOptional<int>(
"ttl", p.ttl, j, -1);
2288 JSON_SERIALIZED_CLASS(NetworkAddress)
2301 IMPLEMENT_JSON_SERIALIZATION()
2322 bool matches(
const NetworkAddress& other)
2324 if(address.compare(other.address) != 0)
2329 if(port != other.port)
2338 static void to_json(nlohmann::json& j,
const NetworkAddress& p)
2341 TOJSON_IMPL(address),
2345 static void from_json(
const nlohmann::json& j, NetworkAddress& p)
2348 getOptional<std::string>(
"address", p.address, j);
2349 getOptional<int>(
"port", p.port, j);
2354 JSON_SERIALIZED_CLASS(NetworkAddressRxTx)
2367 IMPLEMENT_JSON_SERIALIZATION()
2389 static void to_json(nlohmann::json& j,
const NetworkAddressRxTx& p)
2396 static void from_json(
const nlohmann::json& j, NetworkAddressRxTx& p)
2399 getOptional<NetworkAddress>(
"rx", p.rx, j);
2400 getOptional<NetworkAddress>(
"tx", p.tx, j);
2411 } GroupRestrictionAccessPolicyType_t;
2413 static bool isValidGroupRestrictionAccessPolicyType(GroupRestrictionAccessPolicyType_t t)
2415 return (t == GroupRestrictionAccessPolicyType_t::graptPermissive ||
2416 t == GroupRestrictionAccessPolicyType_t::graptStrict );
2430 } RestrictionType_t;
2432 static bool isValidRestrictionType(RestrictionType_t t)
2434 return (t == RestrictionType_t::rtUndefined ||
2435 t == RestrictionType_t::rtWhitelist ||
2436 t == RestrictionType_t::rtBlacklist );
2462 } RestrictionElementType_t;
2464 static bool isValidRestrictionElementType(RestrictionElementType_t t)
2466 return (t == RestrictionElementType_t::retGroupId ||
2467 t == RestrictionElementType_t::retGroupIdPattern ||
2468 t == RestrictionElementType_t::retGenericAccessTagPattern ||
2469 t == RestrictionElementType_t::retCertificateSerialNumberPattern ||
2470 t == RestrictionElementType_t::retCertificateFingerprintPattern ||
2471 t == RestrictionElementType_t::retCertificateSubjectPattern ||
2472 t == RestrictionElementType_t::retCertificateIssuerPattern);
2477 JSON_SERIALIZED_CLASS(NetworkAddressRestrictionList)
2490 IMPLEMENT_JSON_SERIALIZATION()
2507 type = RestrictionType_t::rtUndefined;
2512 static void to_json(nlohmann::json& j,
const NetworkAddressRestrictionList& p)
2516 TOJSON_IMPL(elements)
2519 static void from_json(
const nlohmann::json& j, NetworkAddressRestrictionList& p)
2522 getOptional<RestrictionType_t>(
"type", p.type, j, RestrictionType_t::rtUndefined);
2523 getOptional<std::vector<NetworkAddressRxTx>>(
"elements", p.elements, j);
2527 JSON_SERIALIZED_CLASS(StringRestrictionList)
2540 IMPLEMENT_JSON_SERIALIZATION()
2555 type = RestrictionType_t::rtUndefined;
2556 elementsType = RestrictionElementType_t::retGroupId;
2566 static void to_json(nlohmann::json& j,
const StringRestrictionList& p)
2570 TOJSON_IMPL(elementsType),
2571 TOJSON_IMPL(elements)
2574 static void from_json(
const nlohmann::json& j, StringRestrictionList& p)
2577 getOptional<RestrictionType_t>(
"type", p.type, j, RestrictionType_t::rtUndefined);
2578 getOptional<RestrictionElementType_t>(
"elementsType", p.elementsType, j, RestrictionElementType_t::retGroupId);
2579 getOptional<std::vector<std::string>>(
"elements", p.elements, j);
2584 JSON_SERIALIZED_CLASS(PacketCapturer)
2595 IMPLEMENT_JSON_SERIALIZATION()
2601 std::string filePrefix;
2619 TOJSON_IMPL(enabled),
2621 TOJSON_IMPL(filePrefix)
2624 static void from_json(
const nlohmann::json& j, PacketCapturer& p)
2627 getOptional<bool>(
"enabled", p.enabled, j,
false);
2628 getOptional<uint32_t>(
"maxMb", p.maxMb, j, 10);
2629 getOptional<std::string>(
"filePrefix", p.filePrefix, j, EMPTY_STRING);
2634 JSON_SERIALIZED_CLASS(TransportImpairment)
2645 IMPLEMENT_JSON_SERIALIZATION()
2665 errorPercentage = 0;
2669 static void to_json(nlohmann::json& j,
const TransportImpairment& p)
2672 TOJSON_IMPL(jitterMs),
2673 TOJSON_IMPL(lossPercentage),
2674 TOJSON_IMPL(errorPercentage)
2677 static void from_json(
const nlohmann::json& j, TransportImpairment& p)
2680 getOptional<int>(
"jitterMs", p.jitterMs, j, 0);
2681 getOptional<int>(
"lossPercentage", p.lossPercentage, j, 0);
2682 getOptional<int>(
"errorPercentage", p.errorPercentage, j, 0);
2687 JSON_SERIALIZED_CLASS(NsmNetworking)
2701 IMPLEMENT_JSON_SERIALIZATION()
2705 std::string address;
2712 std::string cryptoPassword;
2713 int maxUdpPayloadBytes;
2725 priority = TxPriority_t::priVoice;
2727 rxImpairment.clear();
2728 txImpairment.clear();
2729 cryptoPassword.clear();
2730 maxUdpPayloadBytes = 800;
2734 static void to_json(nlohmann::json& j,
const NsmNetworking& p)
2736 nlohmann::json pathJson;
2737 to_json(pathJson, p.address);
2741 TOJSON_IMPL(priority),
2742 TOJSON_IMPL(txOversend),
2743 TOJSON_IMPL(rxImpairment),
2744 TOJSON_IMPL(txImpairment),
2745 TOJSON_IMPL(cryptoPassword),
2746 TOJSON_IMPL(maxUdpPayloadBytes)
2749 static void from_json(
const nlohmann::json& j, NsmNetworking& p)
2752 getOptional<std::string>(
"address", p.address, j);
2753 getOptional<int>(
"port", p.port, j, 8513);
2754 getOptional<int>(
"ttl", p.ttl, j, 1);
2755 getOptional<TxPriority_t>(
"priority", p.priority, j, TxPriority_t::priVoice);
2756 getOptional<int>(
"txOversend", p.txOversend, j, 0);
2757 getOptional<TransportImpairment>(
"rxImpairment", p.rxImpairment, j);
2758 getOptional<TransportImpairment>(
"txImpairment", p.txImpairment, j);
2759 getOptional(
"cryptoPassword", p.cryptoPassword, j, EMPTY_STRING);
2760 getOptional<int>(
"maxUdpPayloadBytes", p.maxUdpPayloadBytes, j, 800);
2764 JSON_SERIALIZED_CLASS(NsmNodeResource)
2772 IMPLEMENT_JSON_SERIALIZATION()
2793 static void to_json(nlohmann::json& j,
const NsmNodeResource& p)
2797 TOJSON_IMPL(priority)
2800 static void from_json(
const nlohmann::json& j, NsmNodeResource& p)
2803 getOptional<std::string>(
"id", p.id, j);
2804 getOptional<int>(
"priority", p.priority, j, -1);
2811 if (!j.contains(
"resources") || !j[
"resources"].is_array())
2815 for (
const auto& el : j[
"resources"])
2817 if (!el.is_object())
2823 getOptional<std::string>(
"id", nr.
id, el);
2824 getOptional<int>(
"priority", nr.
priority, el, -1);
2834 JSON_SERIALIZED_CLASS(NsmConfiguration)
2845 IMPLEMENT_JSON_SERIALIZATION()
2853 std::vector<NsmNodeResource> resources;
2857 int transitionSecsFactor;
2862 bool logCommandOutput;
2872 favorUptime =
false;
2875 tokenStart = 1000000;
2878 transitionSecsFactor = 3;
2879 internalMultiplier = 1;
2880 goingActiveRandomDelayMs = 500;
2881 logCommandOutput =
false;
2885 static void to_json(nlohmann::json& j,
const NsmConfiguration& p)
2889 TOJSON_IMPL(favorUptime),
2890 TOJSON_IMPL(networking),
2891 TOJSON_IMPL(resources),
2892 TOJSON_IMPL(tokenStart),
2893 TOJSON_IMPL(tokenEnd),
2894 TOJSON_IMPL(intervalSecs),
2895 TOJSON_IMPL(transitionSecsFactor),
2896 TOJSON_IMPL(internalMultiplier),
2897 TOJSON_IMPL(goingActiveRandomDelayMs),
2898 TOJSON_IMPL(logCommandOutput),
2901 static void from_json(
const nlohmann::json& j, NsmConfiguration& p)
2904 getOptional(
"id", p.id, j);
2905 getOptional<bool>(
"favorUptime", p.favorUptime, j,
false);
2906 getOptional<NsmNetworking>(
"networking", p.networking, j);
2908 getOptional<int>(
"tokenStart", p.tokenStart, j, 1000000);
2909 getOptional<int>(
"tokenEnd", p.tokenEnd, j, 2000000);
2910 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 1);
2911 getOptional<int>(
"transitionSecsFactor", p.transitionSecsFactor, j, 3);
2912 getOptional<int>(
"internalMultiplier", p.internalMultiplier, j, 1);
2913 getOptional<int>(
"goingActiveRandomDelayMs", p.goingActiveRandomDelayMs, j, 500);
2914 getOptional<bool>(
"logCommandOutput", p.logCommandOutput, j,
false);
2919 JSON_SERIALIZED_CLASS(Rallypoint)
2929 IMPLEMENT_JSON_SERIALIZATION()
3041 certificate.clear();
3042 certificateKey.clear();
3043 caCertificates.clear();
3045 transactionTimeoutMs = 0;
3046 disableMessageSigning =
false;
3047 connectionTimeoutSecs = 0;
3048 tcpTxOptions.clear();
3050 protocol = rppTlsTcp;
3052 additionalProtocols.clear();
3055 bool matches(
const Rallypoint& other)
3057 if(!host.matches(other.host))
3062 if(protocol != other.protocol)
3067 if(path.compare(other.path) != 0)
3072 if(certificate.compare(other.certificate) != 0)
3077 if(certificateKey.compare(other.certificateKey) != 0)
3082 if(verifyPeer != other.verifyPeer)
3087 if(allowSelfSignedCertificate != other.allowSelfSignedCertificate)
3092 if(caCertificates.size() != other.caCertificates.size())
3097 for(
size_t x = 0; x < caCertificates.size(); x++)
3101 for(
size_t y = 0; y < other.caCertificates.size(); y++)
3103 if(caCertificates[x].compare(other.caCertificates[y]) == 0)
3116 if(transactionTimeoutMs != other.transactionTimeoutMs)
3121 if(disableMessageSigning != other.disableMessageSigning)
3125 if(connectionTimeoutSecs != other.connectionTimeoutSecs)
3129 if(tcpTxOptions.
priority != other.tcpTxOptions.priority)
3133 if(sni.compare(other.sni) != 0)
3142 static void to_json(nlohmann::json& j,
const Rallypoint& p)
3146 TOJSON_IMPL(certificate),
3147 TOJSON_IMPL(certificateKey),
3148 TOJSON_IMPL(verifyPeer),
3149 TOJSON_IMPL(allowSelfSignedCertificate),
3150 TOJSON_IMPL(caCertificates),
3151 TOJSON_IMPL(transactionTimeoutMs),
3152 TOJSON_IMPL(disableMessageSigning),
3153 TOJSON_IMPL(connectionTimeoutSecs),
3154 TOJSON_IMPL(tcpTxOptions),
3156 TOJSON_IMPL(protocol),
3158 TOJSON_IMPL(additionalProtocols)
3162 static void from_json(
const nlohmann::json& j, Rallypoint& p)
3165 j.at(
"host").get_to(p.host);
3166 getOptional(
"certificate", p.certificate, j);
3167 getOptional(
"certificateKey", p.certificateKey, j);
3168 getOptional<bool>(
"verifyPeer", p.verifyPeer, j,
true);
3169 getOptional<bool>(
"allowSelfSignedCertificate", p.allowSelfSignedCertificate, j,
false);
3170 getOptional<std::vector<std::string>>(
"caCertificates", p.caCertificates, j);
3171 getOptional<int>(
"transactionTimeoutMs", p.transactionTimeoutMs, j, 0);
3172 getOptional<bool>(
"disableMessageSigning", p.disableMessageSigning, j,
false);
3173 getOptional<int>(
"connectionTimeoutSecs", p.connectionTimeoutSecs, j, 0);
3174 getOptional<TcpNetworkTxOptions>(
"tcpTxOptions", p.tcpTxOptions, j);
3175 getOptional<std::string>(
"sni", p.sni, j);
3176 getOptional<Rallypoint::RpProtocol_t>(
"protocol", p.protocol, j, Rallypoint::RpProtocol_t::rppTlsTcp);
3177 getOptional<std::string>(
"path", p.path, j);
3178 getOptional<std::string>(
"additionalProtocols", p.additionalProtocols, j);
3182 JSON_SERIALIZED_CLASS(RallypointCluster)
3195 IMPLEMENT_JSON_SERIALIZATION()
3211 } ConnectionStrategy_t;
3235 connectionStrategy = csRoundRobin;
3236 rallypoints.clear();
3238 connectionTimeoutSecs = 5;
3239 transactionTimeoutMs = 10000;
3243 static void to_json(nlohmann::json& j,
const RallypointCluster& p)
3246 TOJSON_IMPL(connectionStrategy),
3247 TOJSON_IMPL(rallypoints),
3248 TOJSON_IMPL(rolloverSecs),
3249 TOJSON_IMPL(connectionTimeoutSecs),
3250 TOJSON_IMPL(transactionTimeoutMs)
3253 static void from_json(
const nlohmann::json& j, RallypointCluster& p)
3256 getOptional<RallypointCluster::ConnectionStrategy_t>(
"connectionStrategy", p.connectionStrategy, j, RallypointCluster::ConnectionStrategy_t::csRoundRobin);
3257 getOptional<std::vector<Rallypoint>>(
"rallypoints", p.rallypoints, j);
3258 getOptional<int>(
"rolloverSecs", p.rolloverSecs, j, 10);
3259 getOptional<int>(
"connectionTimeoutSecs", p.connectionTimeoutSecs, j, 5);
3260 getOptional<int>(
"transactionTimeoutMs", p.transactionTimeoutMs, j, 10000);
3265 JSON_SERIALIZED_CLASS(NetworkDeviceDescriptor)
3277 IMPLEMENT_JSON_SERIALIZATION()
3318 manufacturer.clear();
3321 serialNumber.clear();
3326 virtual std::string toString()
3330 snprintf(buff,
sizeof(buff),
"deviceId=%d, name=%s, manufacturer=%s, model=%s, hardwareId=%s, serialNumber=%s, type=%s, extra=%s",
3333 manufacturer.c_str(),
3336 serialNumber.c_str(),
3340 return std::string(buff);
3344 static void to_json(nlohmann::json& j,
const NetworkDeviceDescriptor& p)
3347 TOJSON_IMPL(deviceId),
3349 TOJSON_IMPL(manufacturer),
3351 TOJSON_IMPL(hardwareId),
3352 TOJSON_IMPL(serialNumber),
3357 static void from_json(
const nlohmann::json& j, NetworkDeviceDescriptor& p)
3360 getOptional<int>(
"deviceId", p.deviceId, j, 0);
3361 getOptional(
"name", p.name, j);
3362 getOptional(
"manufacturer", p.manufacturer, j);
3363 getOptional(
"model", p.model, j);
3364 getOptional(
"hardwareId", p.hardwareId, j);
3365 getOptional(
"serialNumber", p.serialNumber, j);
3366 getOptional(
"type", p.type, j);
3367 getOptional(
"extra", p.extra, j);
3371 JSON_SERIALIZED_CLASS(AudioGate)
3382 IMPLEMENT_JSON_SERIALIZATION()
3421 static void to_json(nlohmann::json& j,
const AudioGate& p)
3424 TOJSON_IMPL(enabled),
3425 TOJSON_IMPL(useVad),
3426 TOJSON_IMPL(hangMs),
3427 TOJSON_IMPL(windowMin),
3428 TOJSON_IMPL(windowMax),
3429 TOJSON_IMPL(coefficient)
3432 static void from_json(
const nlohmann::json& j, AudioGate& p)
3435 getOptional<bool>(
"enabled", p.enabled, j,
false);
3436 getOptional<bool>(
"useVad", p.useVad, j,
false);
3437 getOptional<uint32_t>(
"hangMs", p.hangMs, j, 1500);
3438 getOptional<uint32_t>(
"windowMin", p.windowMin, j, 25);
3439 getOptional<uint32_t>(
"windowMax", p.windowMax, j, 125);
3440 getOptional<double>(
"coefficient", p.coefficient, j, 1.75);
3444 JSON_SERIALIZED_CLASS(TxAudio)
3459 IMPLEMENT_JSON_SERIALIZATION()
3460 IMPLEMENT_JSON_DOCUMENTATION(
TxAudio)
3631 hetEngageStandard = 0,
3634 hetNatoStanga5643 = 1
3635 } HeaderExtensionType_t;
3717 encoder = TxAudio::TxCodec_t::ctUnknown;
3718 encoderName.clear();
3724 extensionSendInterval = 10;
3725 initialHeaderBurst = 5;
3726 trailingHeaderBurst = 5;
3727 startTxNotifications = 5;
3728 customRtpPayloadType = -1;
3730 resetRtpOnTx =
true;
3731 enableSmoothing =
true;
3733 smoothedHangTimeMs = 0;
3734 hdrExtType = HeaderExtensionType_t::hetEngageStandard;
3738 static void to_json(nlohmann::json& j,
const TxAudio& p)
3741 TOJSON_IMPL(enabled),
3742 TOJSON_IMPL(encoder),
3743 TOJSON_IMPL(encoderName),
3744 TOJSON_IMPL(framingMs),
3745 TOJSON_IMPL(blockCount),
3747 TOJSON_IMPL(noHdrExt),
3748 TOJSON_IMPL(maxTxSecs),
3749 TOJSON_IMPL(extensionSendInterval),
3750 TOJSON_IMPL(initialHeaderBurst),
3751 TOJSON_IMPL(trailingHeaderBurst),
3752 TOJSON_IMPL(startTxNotifications),
3753 TOJSON_IMPL(customRtpPayloadType),
3754 TOJSON_IMPL(resetRtpOnTx),
3755 TOJSON_IMPL(enableSmoothing),
3757 TOJSON_IMPL(smoothedHangTimeMs),
3758 TOJSON_IMPL(hdrExtType)
3763 static void from_json(
const nlohmann::json& j, TxAudio& p)
3766 getOptional<bool>(
"enabled", p.enabled, j,
true);
3767 getOptional<TxAudio::TxCodec_t>(
"encoder", p.encoder, j, TxAudio::TxCodec_t::ctOpus8000);
3768 getOptional<std::string>(
"encoderName", p.encoderName, j, EMPTY_STRING);
3769 getOptional(
"framingMs", p.framingMs, j, 60);
3770 getOptional(
"blockCount", p.blockCount, j, 0);
3771 getOptional(
"fdx", p.fdx, j,
false);
3772 getOptional(
"noHdrExt", p.noHdrExt, j,
false);
3773 getOptional(
"maxTxSecs", p.maxTxSecs, j, 0);
3774 getOptional(
"extensionSendInterval", p.extensionSendInterval, j, 10);
3775 getOptional(
"initialHeaderBurst", p.initialHeaderBurst, j, 5);
3776 getOptional(
"trailingHeaderBurst", p.trailingHeaderBurst, j, 5);
3777 getOptional(
"startTxNotifications", p.startTxNotifications, j, 5);
3778 getOptional(
"customRtpPayloadType", p.customRtpPayloadType, j, -1);
3779 getOptional(
"resetRtpOnTx", p.resetRtpOnTx, j,
true);
3780 getOptional(
"enableSmoothing", p.enableSmoothing, j,
true);
3781 getOptional(
"dtx", p.dtx, j,
false);
3782 getOptional(
"smoothedHangTimeMs", p.smoothedHangTimeMs, j, 0);
3783 getOptional(
"hdrExtType", p.hdrExtType, j, TxAudio::HeaderExtensionType_t::hetEngageStandard);
3789 JSON_SERIALIZED_CLASS(AudioRegistryDevice)
3801 IMPLEMENT_JSON_SERIALIZATION()
3840 manufacturer.clear();
3842 serialNumber.clear();
3847 virtual std::string toString()
3851 snprintf(buff,
sizeof(buff),
"hardwareId=%s, isDefault=%d, name=%s, manufacturer=%s, model=%s, serialNumber=%s, type=%s, extra=%s",
3855 manufacturer.c_str(),
3857 serialNumber.c_str(),
3861 return std::string(buff);
3865 static void to_json(nlohmann::json& j,
const AudioRegistryDevice& p)
3868 TOJSON_IMPL(hardwareId),
3869 TOJSON_IMPL(isDefault),
3871 TOJSON_IMPL(manufacturer),
3873 TOJSON_IMPL(serialNumber),
3878 static void from_json(
const nlohmann::json& j, AudioRegistryDevice& p)
3881 getOptional<std::string>(
"hardwareId", p.hardwareId, j, EMPTY_STRING);
3882 getOptional<bool>(
"isDefault", p.isDefault, j,
false);
3883 getOptional(
"name", p.name, j);
3884 getOptional(
"manufacturer", p.manufacturer, j);
3885 getOptional(
"model", p.model, j);
3886 getOptional(
"serialNumber", p.serialNumber, j);
3887 getOptional(
"type", p.type, j);
3888 getOptional(
"extra", p.extra, j);
3893 JSON_SERIALIZED_CLASS(AudioRegistry)
3905 IMPLEMENT_JSON_SERIALIZATION()
3926 virtual std::string toString()
3928 return std::string(
"");
3932 static void to_json(nlohmann::json& j,
const AudioRegistry& p)
3935 TOJSON_IMPL(inputs),
3936 TOJSON_IMPL(outputs)
3939 static void from_json(
const nlohmann::json& j, AudioRegistry& p)
3942 getOptional<std::vector<AudioRegistryDevice>>(
"inputs", p.inputs, j);
3943 getOptional<std::vector<AudioRegistryDevice>>(
"outputs", p.outputs, j);
3947 JSON_SERIALIZED_CLASS(AudioDeviceDescriptor)
3959 IMPLEMENT_JSON_SERIALIZATION()
4053 direction = dirUnknown;
4054 boostPercentage = 0;
4059 manufacturer.clear();
4062 serialNumber.clear();
4068 virtual std::string toString()
4072 snprintf(buff,
sizeof(buff),
"deviceId=%d, samplingRate=%d, channels=%d, direction=%d, boostPercentage=%d, isAdad=%d, name=%s, manufacturer=%s, model=%s, hardwareId=%s, serialNumber=%s, isDefault=%d, type=%s, present=%d, extra=%s",
4080 manufacturer.c_str(),
4083 serialNumber.c_str(),
4089 return std::string(buff);
4093 static void to_json(nlohmann::json& j,
const AudioDeviceDescriptor& p)
4096 TOJSON_IMPL(deviceId),
4097 TOJSON_IMPL(samplingRate),
4098 TOJSON_IMPL(channels),
4099 TOJSON_IMPL(direction),
4100 TOJSON_IMPL(boostPercentage),
4101 TOJSON_IMPL(isAdad),
4103 TOJSON_IMPL(manufacturer),
4105 TOJSON_IMPL(hardwareId),
4106 TOJSON_IMPL(serialNumber),
4107 TOJSON_IMPL(isDefault),
4110 TOJSON_IMPL(isPresent)
4113 static void from_json(
const nlohmann::json& j, AudioDeviceDescriptor& p)
4116 getOptional<int>(
"deviceId", p.deviceId, j, 0);
4117 getOptional<int>(
"samplingRate", p.samplingRate, j, 0);
4118 getOptional<int>(
"channels", p.channels, j, 0);
4119 getOptional<AudioDeviceDescriptor::Direction_t>(
"direction", p.direction, j,
4120 AudioDeviceDescriptor::Direction_t::dirUnknown);
4121 getOptional<int>(
"boostPercentage", p.boostPercentage, j, 0);
4123 getOptional<bool>(
"isAdad", p.isAdad, j,
false);
4124 getOptional(
"name", p.name, j);
4125 getOptional(
"manufacturer", p.manufacturer, j);
4126 getOptional(
"model", p.model, j);
4127 getOptional(
"hardwareId", p.hardwareId, j);
4128 getOptional(
"serialNumber", p.serialNumber, j);
4129 getOptional(
"isDefault", p.isDefault, j);
4130 getOptional(
"type", p.type, j);
4131 getOptional(
"extra", p.extra, j);
4132 getOptional<bool>(
"isPresent", p.isPresent, j,
false);
4136 JSON_SERIALIZED_CLASS(ListOfAudioDeviceDescriptor)
4139 IMPLEMENT_JSON_SERIALIZATION()
4143 std::vector<AudioDeviceDescriptor> list;
4162 static void from_json(
const nlohmann::json& j, ListOfAudioDeviceDescriptor& p)
4165 getOptional<std::vector<AudioDeviceDescriptor>>(
"list", p.list, j);
4169 JSON_SERIALIZED_CLASS(Audio)
4179 IMPLEMENT_JSON_SERIALIZATION()
4180 IMPLEMENT_JSON_DOCUMENTATION(
Audio)
4222 inputHardwareId.clear();
4225 outputHardwareId.clear();
4227 outputLevelLeft = 100;
4228 outputLevelRight = 100;
4229 outputMuted =
false;
4233 static void to_json(nlohmann::json& j,
const Audio& p)
4236 TOJSON_IMPL(enabled),
4237 TOJSON_IMPL(inputId),
4238 TOJSON_IMPL(inputHardwareId),
4239 TOJSON_IMPL(inputGain),
4240 TOJSON_IMPL(outputId),
4241 TOJSON_IMPL(outputHardwareId),
4242 TOJSON_IMPL(outputLevelLeft),
4243 TOJSON_IMPL(outputLevelRight),
4244 TOJSON_IMPL(outputMuted)
4247 static void from_json(
const nlohmann::json& j, Audio& p)
4250 getOptional<bool>(
"enabled", p.enabled, j,
true);
4251 getOptional<int>(
"inputId", p.inputId, j, 0);
4252 getOptional<std::string>(
"inputHardwareId", p.inputHardwareId, j, EMPTY_STRING);
4253 getOptional<int>(
"inputGain", p.inputGain, j, 0);
4254 getOptional<int>(
"outputId", p.outputId, j, 0);
4255 getOptional<std::string>(
"outputHardwareId", p.outputHardwareId, j, EMPTY_STRING);
4256 getOptional<int>(
"outputGain", p.outputGain, j, 0);
4257 getOptional<int>(
"outputLevelLeft", p.outputLevelLeft, j, 100);
4258 getOptional<int>(
"outputLevelRight", p.outputLevelRight, j, 100);
4259 getOptional<bool>(
"outputMuted", p.outputMuted, j,
false);
4263 JSON_SERIALIZED_CLASS(TalkerInformation)
4275 IMPLEMENT_JSON_SERIALIZATION()
4291 matSsrcGenerated = 2
4292 } ManufacturedAliasType_t;
4337 aliasSpecializer = 0;
4339 manufacturedAliasType = ManufacturedAliasType_t::matNone;
4344 static void to_json(nlohmann::json& j,
const TalkerInformation& p)
4348 TOJSON_IMPL(nodeId),
4349 TOJSON_IMPL(rxFlags),
4350 TOJSON_IMPL(txPriority),
4352 TOJSON_IMPL(duplicateCount),
4353 TOJSON_IMPL(aliasSpecializer),
4354 TOJSON_IMPL(rxMuted),
4355 TOJSON_IMPL(manufacturedAliasType),
4359 static void from_json(
const nlohmann::json& j, TalkerInformation& p)
4362 getOptional<std::string>(
"alias", p.alias, j, EMPTY_STRING);
4363 getOptional<std::string>(
"nodeId", p.nodeId, j, EMPTY_STRING);
4364 getOptional<uint16_t>(
"rxFlags", p.rxFlags, j, 0);
4365 getOptional<int>(
"txPriority", p.txPriority, j, 0);
4366 getOptional<uint32_t>(
"txId", p.txId, j, 0);
4367 getOptional<int>(
"duplicateCount", p.duplicateCount, j, 0);
4368 getOptional<uint16_t>(
"aliasSpecializer", p.aliasSpecializer, j, 0);
4369 getOptional<bool>(
"rxMuted", p.rxMuted, j,
false);
4370 getOptional<TalkerInformation::ManufacturedAliasType_t>(
"manufacturedAliasType", p.manufacturedAliasType, j, TalkerInformation::ManufacturedAliasType_t::matNone);
4371 getOptional<uint32_t>(
"ssrc", p.ssrc, j, 0);
4375 JSON_SERIALIZED_CLASS(GroupTalkers)
4389 IMPLEMENT_JSON_SERIALIZATION()
4394 std::vector<TalkerInformation>
list;
4407 static void to_json(nlohmann::json& j,
const GroupTalkers& p)
4413 static void from_json(
const nlohmann::json& j, GroupTalkers& p)
4416 getOptional<std::vector<TalkerInformation>>(
"list", p.list, j);
4420 JSON_SERIALIZED_CLASS(Presence)
4432 IMPLEMENT_JSON_SERIALIZATION()
4433 IMPLEMENT_JSON_DOCUMENTATION(
Presence)
4481 minIntervalSecs = 5;
4482 reduceImmediacy =
false;
4486 static void to_json(nlohmann::json& j,
const Presence& p)
4489 TOJSON_IMPL(format),
4490 TOJSON_IMPL(intervalSecs),
4491 TOJSON_IMPL(listenOnly),
4492 TOJSON_IMPL(minIntervalSecs),
4493 TOJSON_IMPL(reduceImmediacy)
4496 static void from_json(
const nlohmann::json& j, Presence& p)
4499 getOptional<Presence::Format_t>(
"format", p.format, j, Presence::Format_t::pfEngage);
4500 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 30);
4501 getOptional<bool>(
"listenOnly", p.listenOnly, j,
false);
4502 getOptional<int>(
"minIntervalSecs", p.minIntervalSecs, j, 5);
4503 getOptional<bool>(
"reduceImmediacy", p.reduceImmediacy, j,
false);
4508 JSON_SERIALIZED_CLASS(Advertising)
4520 IMPLEMENT_JSON_SERIALIZATION()
4542 alwaysAdvertise =
false;
4546 static void to_json(nlohmann::json& j,
const Advertising& p)
4549 TOJSON_IMPL(enabled),
4550 TOJSON_IMPL(intervalMs),
4551 TOJSON_IMPL(alwaysAdvertise)
4554 static void from_json(
const nlohmann::json& j, Advertising& p)
4557 getOptional(
"enabled", p.enabled, j,
false);
4558 getOptional<int>(
"intervalMs", p.intervalMs, j, 20000);
4559 getOptional<bool>(
"alwaysAdvertise", p.alwaysAdvertise, j,
false);
4563 JSON_SERIALIZED_CLASS(GroupPriorityTranslation)
4575 IMPLEMENT_JSON_SERIALIZATION()
4601 static void to_json(nlohmann::json& j,
const GroupPriorityTranslation& p)
4606 TOJSON_IMPL(priority)
4609 static void from_json(
const nlohmann::json& j, GroupPriorityTranslation& p)
4612 j.at(
"rx").get_to(p.rx);
4613 j.at(
"tx").get_to(p.tx);
4614 FROMJSON_IMPL(priority,
int, 0);
4618 JSON_SERIALIZED_CLASS(GroupTimeline)
4632 IMPLEMENT_JSON_SERIALIZATION()
4651 maxAudioTimeMs = 30000;
4656 static void to_json(nlohmann::json& j,
const GroupTimeline& p)
4659 TOJSON_IMPL(enabled),
4660 TOJSON_IMPL(maxAudioTimeMs),
4661 TOJSON_IMPL(recordAudio)
4664 static void from_json(
const nlohmann::json& j, GroupTimeline& p)
4667 getOptional(
"enabled", p.enabled, j,
true);
4668 getOptional<int>(
"maxAudioTimeMs", p.maxAudioTimeMs, j, 30000);
4669 getOptional(
"recordAudio", p.recordAudio, j,
true);
4772 IMPLEMENT_JSON_SERIALIZATION()
4794 static void to_json(nlohmann::json& j,
const GroupAppTransport& p)
4797 TOJSON_IMPL(enabled),
4801 static void from_json(
const nlohmann::json& j, GroupAppTransport& p)
4804 getOptional<bool>(
"enabled", p.enabled, j,
false);
4805 getOptional<std::string>(
"id", p.id, j);
4809 JSON_SERIALIZED_CLASS(RtpProfile)
4821 IMPLEMENT_JSON_SERIALIZATION()
4839 jmReleaseOnTxEnd = 2
4902 jitterMaxMs = 10000;
4904 jitterMaxFactor = 8;
4905 jitterTrimPercentage = 10;
4906 jitterUnderrunReductionThresholdMs = 1500;
4907 jitterUnderrunReductionAger = 100;
4908 latePacketSequenceRange = 5;
4909 latePacketTimestampRangeMs = 2000;
4910 inboundProcessorInactivityMs = 500;
4911 jitterForceTrimAtMs = 0;
4912 rtcpPresenceTimeoutMs = 45000;
4913 jitterMaxExceededClipPerc = 10;
4914 jitterMaxExceededClipHangMs = 1500;
4915 zombieLifetimeMs = 15000;
4916 jitterMaxTrimMs = 250;
4917 signalledInboundProcessorInactivityMs = (inboundProcessorInactivityMs * 4);
4921 static void to_json(nlohmann::json& j,
const RtpProfile& p)
4925 TOJSON_IMPL(jitterMaxMs),
4926 TOJSON_IMPL(inboundProcessorInactivityMs),
4927 TOJSON_IMPL(jitterMinMs),
4928 TOJSON_IMPL(jitterMaxFactor),
4929 TOJSON_IMPL(jitterTrimPercentage),
4930 TOJSON_IMPL(jitterUnderrunReductionThresholdMs),
4931 TOJSON_IMPL(jitterUnderrunReductionAger),
4932 TOJSON_IMPL(latePacketSequenceRange),
4933 TOJSON_IMPL(latePacketTimestampRangeMs),
4934 TOJSON_IMPL(inboundProcessorInactivityMs),
4935 TOJSON_IMPL(jitterForceTrimAtMs),
4936 TOJSON_IMPL(jitterMaxExceededClipPerc),
4937 TOJSON_IMPL(jitterMaxExceededClipHangMs),
4938 TOJSON_IMPL(zombieLifetimeMs),
4939 TOJSON_IMPL(jitterMaxTrimMs),
4940 TOJSON_IMPL(signalledInboundProcessorInactivityMs)
4943 static void from_json(
const nlohmann::json& j, RtpProfile& p)
4946 FROMJSON_IMPL(mode, RtpProfile::JitterMode_t, RtpProfile::JitterMode_t::jmStandard);
4947 FROMJSON_IMPL(jitterMaxMs,
int, 10000);
4948 FROMJSON_IMPL(jitterMinMs,
int, 20);
4949 FROMJSON_IMPL(jitterMaxFactor,
int, 8);
4950 FROMJSON_IMPL(jitterTrimPercentage,
int, 10);
4951 FROMJSON_IMPL(jitterUnderrunReductionThresholdMs,
int, 1500);
4952 FROMJSON_IMPL(jitterUnderrunReductionAger,
int, 100);
4953 FROMJSON_IMPL(latePacketSequenceRange,
int, 5);
4954 FROMJSON_IMPL(latePacketTimestampRangeMs,
int, 2000);
4955 FROMJSON_IMPL(inboundProcessorInactivityMs,
int, 500);
4956 FROMJSON_IMPL(jitterForceTrimAtMs,
int, 0);
4957 FROMJSON_IMPL(rtcpPresenceTimeoutMs,
int, 45000);
4958 FROMJSON_IMPL(jitterMaxExceededClipPerc,
int, 10);
4959 FROMJSON_IMPL(jitterMaxExceededClipHangMs,
int, 1500);
4960 FROMJSON_IMPL(zombieLifetimeMs,
int, 15000);
4961 FROMJSON_IMPL(jitterMaxTrimMs,
int, 250);
4962 FROMJSON_IMPL(signalledInboundProcessorInactivityMs,
int, (p.inboundProcessorInactivityMs * 4));
4966 JSON_SERIALIZED_CLASS(Tls)
4978 IMPLEMENT_JSON_SERIALIZATION()
4979 IMPLEMENT_JSON_DOCUMENTATION(
Tls)
5009 allowSelfSignedCertificates =
false;
5010 caCertificates.clear();
5011 subjectRestrictions.clear();
5012 issuerRestrictions.clear();
5017 static void to_json(nlohmann::json& j,
const Tls& p)
5020 TOJSON_IMPL(verifyPeers),
5021 TOJSON_IMPL(allowSelfSignedCertificates),
5022 TOJSON_IMPL(caCertificates),
5023 TOJSON_IMPL(subjectRestrictions),
5024 TOJSON_IMPL(issuerRestrictions),
5025 TOJSON_IMPL(crlSerials)
5028 static void from_json(
const nlohmann::json& j, Tls& p)
5031 getOptional<bool>(
"verifyPeers", p.verifyPeers, j,
true);
5032 getOptional<bool>(
"allowSelfSignedCertificates", p.allowSelfSignedCertificates, j,
false);
5033 getOptional<std::vector<std::string>>(
"caCertificates", p.caCertificates, j);
5034 getOptional<StringRestrictionList>(
"subjectRestrictions", p.subjectRestrictions, j);
5035 getOptional<StringRestrictionList>(
"issuerRestrictions", p.issuerRestrictions, j);
5036 getOptional<std::vector<std::string>>(
"crlSerials", p.crlSerials, j);
5040 JSON_SERIALIZED_CLASS(RangerPackets)
5054 IMPLEMENT_JSON_SERIALIZATION()
5075 virtual void initForDocumenting()
5080 static void to_json(nlohmann::json& j,
const RangerPackets& p)
5083 TOJSON_IMPL(hangTimerSecs),
5087 static void from_json(
const nlohmann::json& j, RangerPackets& p)
5090 getOptional<int>(
"hangTimerSecs", p.hangTimerSecs, j, 11);
5091 getOptional<int>(
"count", p.count, j, 5);
5095 JSON_SERIALIZED_CLASS(Source)
5109 IMPLEMENT_JSON_SERIALIZATION()
5110 IMPLEMENT_JSON_DOCUMENTATION(
Source)
5117 uint8_t _internal_binary_nodeId[ENGAGE_MAX_NODE_ID_SIZE];
5123 uint8_t _internal_binary_alias[ENGAGE_MAX_ALIAS_SIZE];
5133 memset(_internal_binary_nodeId, 0,
sizeof(_internal_binary_nodeId));
5136 memset(_internal_binary_alias, 0,
sizeof(_internal_binary_alias));
5139 virtual void initForDocumenting()
5144 static void to_json(nlohmann::json& j,
const Source& p)
5147 TOJSON_IMPL(nodeId),
5151 static void from_json(
const nlohmann::json& j, Source& p)
5154 FROMJSON_IMPL_SIMPLE(nodeId);
5155 FROMJSON_IMPL_SIMPLE(alias);
5159 JSON_SERIALIZED_CLASS(GroupBridgeTargetOutputDetail)
5173 IMPLEMENT_JSON_SERIALIZATION()
5210 mode = BridgingOpMode_t::bomRaw;
5211 mixedStreamTxParams.clear();
5214 virtual void initForDocumenting()
5220 static void to_json(nlohmann::json& j,
const GroupBridgeTargetOutputDetail& p)
5224 TOJSON_IMPL(mixedStreamTxParams)
5227 static void from_json(
const nlohmann::json& j, GroupBridgeTargetOutputDetail& p)
5230 FROMJSON_IMPL_SIMPLE(mode);
5231 FROMJSON_IMPL_SIMPLE(mixedStreamTxParams);
5235 JSON_SERIALIZED_CLASS(GroupDefaultAudioPriority)
5249 IMPLEMENT_JSON_SERIALIZATION()
5270 virtual void initForDocumenting()
5276 static void to_json(nlohmann::json& j,
const GroupDefaultAudioPriority& p)
5283 static void from_json(
const nlohmann::json& j, GroupDefaultAudioPriority& p)
5286 FROMJSON_IMPL_SIMPLE(tx);
5287 FROMJSON_IMPL_SIMPLE(rx);
5291 JSON_SERIALIZED_CLASS(Group)
5304 IMPLEMENT_JSON_SERIALIZATION()
5305 IMPLEMENT_JSON_DOCUMENTATION(
Group)
5328 iagpAnonymousAlias = 0,
5332 } InboundAliasGenerationPolicy_t;
5507 bridgeTargetOutputDetail.clear();
5508 defaultAudioPriority.clear();
5512 interfaceName.clear();
5518 cryptoPassword.clear();
5522 rallypoints.clear();
5523 rallypointCluster.clear();
5528 blockAdvertising =
false;
5534 enableMulticastFailover =
false;
5535 multicastFailoverSecs = 10;
5537 rtcpPresenceRx.clear();
5539 presenceGroupAffinities.clear();
5540 disablePacketEvents =
false;
5542 rfc4733RtpPayloadId = 0;
5543 inboundRtpPayloadTypeTranslations.clear();
5544 priorityTranslation.clear();
5546 stickyTidHangSecs = 10;
5547 anonymousAlias.clear();
5550 appTransport.clear();
5551 allowLoopback =
false;
5554 rangerPackets.clear();
5556 _wasDeserialized_rtpProfile =
false;
5558 txImpairment.clear();
5559 rxImpairment.clear();
5561 specializerAffinities.clear();
5565 ignoreSources.clear();
5567 languageCode.clear();
5574 inboundAliasGenerationPolicy = iagpAnonymousAlias;
5577 ignoreAudioTraffic =
false;
5581 static void to_json(nlohmann::json& j,
const Group& p)
5585 TOJSON_IMPL(bridgeTargetOutputDetail),
5586 TOJSON_IMPL(defaultAudioPriority),
5589 TOJSON_IMPL(spokenName),
5590 TOJSON_IMPL(interfaceName),
5593 TOJSON_IMPL(txOptions),
5594 TOJSON_IMPL(txAudio),
5595 TOJSON_IMPL(presence),
5596 TOJSON_IMPL(cryptoPassword),
5605 TOJSON_IMPL(timeline),
5606 TOJSON_IMPL(blockAdvertising),
5607 TOJSON_IMPL(source),
5608 TOJSON_IMPL(maxRxSecs),
5609 TOJSON_IMPL(enableMulticastFailover),
5610 TOJSON_IMPL(multicastFailoverSecs),
5611 TOJSON_IMPL(rtcpPresenceRx),
5612 TOJSON_IMPL(presenceGroupAffinities),
5613 TOJSON_IMPL(disablePacketEvents),
5614 TOJSON_IMPL(rfc4733RtpPayloadId),
5615 TOJSON_IMPL(inboundRtpPayloadTypeTranslations),
5616 TOJSON_IMPL(priorityTranslation),
5617 TOJSON_IMPL(stickyTidHangSecs),
5618 TOJSON_IMPL(anonymousAlias),
5619 TOJSON_IMPL(lbCrypto),
5620 TOJSON_IMPL(appTransport),
5621 TOJSON_IMPL(allowLoopback),
5622 TOJSON_IMPL(rangerPackets),
5624 TOJSON_IMPL(txImpairment),
5625 TOJSON_IMPL(rxImpairment),
5627 TOJSON_IMPL(specializerAffinities),
5629 TOJSON_IMPL(securityLevel),
5631 TOJSON_IMPL(ignoreSources),
5633 TOJSON_IMPL(languageCode),
5634 TOJSON_IMPL(synVoice),
5636 TOJSON_IMPL(rxCapture),
5637 TOJSON_IMPL(txCapture),
5639 TOJSON_IMPL(blobRtpPayloadType),
5641 TOJSON_IMPL(inboundAliasGenerationPolicy),
5643 TOJSON_IMPL(gateIn),
5645 TOJSON_IMPL(ignoreAudioTraffic)
5651 if(p._wasDeserialized_rtpProfile || p.isDocumenting())
5653 j[
"rtpProfile"] = p.rtpProfile;
5656 if(p.isDocumenting())
5658 j[
"rallypointCluster"] = p.rallypointCluster;
5659 j[
"rallypoints"] = p.rallypoints;
5664 if(!p.rallypointCluster.rallypoints.empty())
5666 j[
"rallypointCluster"] = p.rallypointCluster;
5668 else if(!p.rallypoints.empty())
5670 j[
"rallypoints"] = p.rallypoints;
5674 static void from_json(
const nlohmann::json& j, Group& p)
5677 j.at(
"type").get_to(p.type);
5678 getOptional<GroupBridgeTargetOutputDetail>(
"bridgeTargetOutputDetail", p.bridgeTargetOutputDetail, j);
5679 j.at(
"id").get_to(p.id);
5680 getOptional<std::string>(
"name", p.name, j);
5681 getOptional<std::string>(
"spokenName", p.spokenName, j);
5682 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
5683 getOptional<NetworkAddress>(
"rx", p.rx, j);
5684 getOptional<NetworkAddress>(
"tx", p.tx, j);
5685 getOptional<NetworkTxOptions>(
"txOptions", p.txOptions, j);
5686 getOptional<std::string>(
"cryptoPassword", p.cryptoPassword, j);
5687 getOptional<std::string>(
"alias", p.alias, j);
5688 getOptional<TxAudio>(
"txAudio", p.txAudio, j);
5689 getOptional<Presence>(
"presence", p.presence, j);
5690 getOptional<std::vector<Rallypoint>>(
"rallypoints", p.rallypoints, j);
5691 getOptional<RallypointCluster>(
"rallypointCluster", p.rallypointCluster, j);
5692 getOptional<Audio>(
"audio", p.audio, j);
5693 getOptional<GroupTimeline>(
"timeline", p.timeline, j);
5694 getOptional<bool>(
"blockAdvertising", p.blockAdvertising, j,
false);
5695 getOptional<std::string>(
"source", p.source, j);
5696 getOptional<int>(
"maxRxSecs", p.maxRxSecs, j, 0);
5697 getOptional<bool>(
"enableMulticastFailover", p.enableMulticastFailover, j,
false);
5698 getOptional<int>(
"multicastFailoverSecs", p.multicastFailoverSecs, j, 10);
5699 getOptional<NetworkAddress>(
"rtcpPresenceRx", p.rtcpPresenceRx, j);
5700 getOptional<std::vector<std::string>>(
"presenceGroupAffinities", p.presenceGroupAffinities, j);
5701 getOptional<bool>(
"disablePacketEvents", p.disablePacketEvents, j,
false);
5702 getOptional<int>(
"rfc4733RtpPayloadId", p.rfc4733RtpPayloadId, j, 0);
5703 getOptional<std::vector<RtpPayloadTypeTranslation>>(
"inboundRtpPayloadTypeTranslations", p.inboundRtpPayloadTypeTranslations, j);
5704 getOptional<GroupPriorityTranslation>(
"priorityTranslation", p.priorityTranslation, j);
5705 getOptional<GroupDefaultAudioPriority>(
"defaultAudioPriority", p.defaultAudioPriority, j);
5706 getOptional<int>(
"stickyTidHangSecs", p.stickyTidHangSecs, j, 10);
5707 getOptional<std::string>(
"anonymousAlias", p.anonymousAlias, j);
5708 getOptional<bool>(
"lbCrypto", p.lbCrypto, j,
false);
5709 getOptional<GroupAppTransport>(
"appTransport", p.appTransport, j);
5710 getOptional<bool>(
"allowLoopback", p.allowLoopback, j,
false);
5711 getOptionalWithIndicator<RtpProfile>(
"rtpProfile", p.rtpProfile, j, &p._wasDeserialized_rtpProfile);
5712 getOptional<RangerPackets>(
"rangerPackets", p.rangerPackets, j);
5713 getOptional<TransportImpairment>(
"txImpairment", p.txImpairment, j);
5714 getOptional<TransportImpairment>(
"rxImpairment", p.rxImpairment, j);
5715 getOptional<std::vector<uint16_t>>(
"specializerAffinities", p.specializerAffinities, j);
5716 getOptional<uint32_t>(
"securityLevel", p.securityLevel, j, 0);
5717 getOptional<std::vector<Source>>(
"ignoreSources", p.ignoreSources, j);
5718 getOptional<std::string>(
"languageCode", p.languageCode, j);
5719 getOptional<std::string>(
"synVoice", p.synVoice, j);
5721 getOptional<PacketCapturer>(
"rxCapture", p.rxCapture, j);
5722 getOptional<PacketCapturer>(
"txCapture", p.txCapture, j);
5726 getOptional<Group::InboundAliasGenerationPolicy_t>(
"inboundAliasGenerationPolicy", p.inboundAliasGenerationPolicy, j, Group::InboundAliasGenerationPolicy_t::iagpAnonymousAlias);
5728 getOptional<AudioGate>(
"gateIn", p.gateIn, j);
5730 getOptional<bool>(
"ignoreAudioTraffic", p.ignoreAudioTraffic, j,
false);
5732 FROMJSON_BASE_IMPL();
5737 JSON_SERIALIZED_CLASS(Mission)
5740 IMPLEMENT_JSON_SERIALIZATION()
5741 IMPLEMENT_JSON_DOCUMENTATION(
Mission)
5746 std::vector<Group> groups;
5747 std::chrono::system_clock::time_point begins;
5748 std::chrono::system_clock::time_point ends;
5749 std::string certStoreId;
5750 int multicastFailoverPolicy;
5758 certStoreId.clear();
5759 multicastFailoverPolicy = 0;
5764 static void to_json(nlohmann::json& j,
const Mission& p)
5769 TOJSON_IMPL(groups),
5770 TOJSON_IMPL(certStoreId),
5771 TOJSON_IMPL(multicastFailoverPolicy),
5772 TOJSON_IMPL(rallypoint)
5776 static void from_json(
const nlohmann::json& j, Mission& p)
5779 j.at(
"id").get_to(p.id);
5780 j.at(
"name").get_to(p.name);
5785 j.at(
"groups").get_to(p.groups);
5792 FROMJSON_IMPL(certStoreId, std::string, EMPTY_STRING);
5793 FROMJSON_IMPL(multicastFailoverPolicy,
int, 0);
5794 getOptional<Rallypoint>(
"rallypoint", p.rallypoint, j);
5798 JSON_SERIALIZED_CLASS(LicenseDescriptor)
5810 IMPLEMENT_JSON_SERIALIZATION()
5819 static const int STATUS_OK = 0;
5820 static const int ERR_NULL_ENTITLEMENT_KEY = -1;
5821 static const int ERR_NULL_LICENSE_KEY = -2;
5822 static const int ERR_INVALID_LICENSE_KEY_LEN = -3;
5823 static const int ERR_LICENSE_KEY_VERIFICATION_FAILURE = -4;
5824 static const int ERR_ACTIVATION_CODE_VERIFICATION_FAILURE = -5;
5825 static const int ERR_INVALID_EXPIRATION_DATE = -6;
5826 static const int ERR_GENERAL_FAILURE = -7;
5827 static const int ERR_NOT_INITIALIZED = -8;
5828 static const int ERR_REQUIRES_ACTIVATION = -9;
5829 static const int ERR_LICENSE_NOT_SUITED_FOR_ACTIVATION = -10;
5837 static const uint8_t LIC_CARGO_FLAG_LIMIT_TO_FEATURES = 0x01;
5904 entitlement.clear();
5906 activationCode.clear();
5909 expiresFormatted.clear();
5914 status = ERR_NOT_INITIALIZED;
5915 manufacturerId.clear();
5916 activationHmac.clear();
5920 static void to_json(nlohmann::json& j,
const LicenseDescriptor& p)
5924 {
"entitlement",
"*entitlement*"},
5926 TOJSON_IMPL(activationCode),
5928 TOJSON_IMPL(expires),
5929 TOJSON_IMPL(expiresFormatted),
5931 TOJSON_IMPL(deviceId),
5932 TOJSON_IMPL(status),
5934 {
"manufacturerId",
"*manufacturerId*"},
5936 TOJSON_IMPL(cargoFlags),
5937 TOJSON_IMPL(activationHmac)
5941 static void from_json(
const nlohmann::json& j, LicenseDescriptor& p)
5944 FROMJSON_IMPL(entitlement, std::string, EMPTY_STRING);
5945 FROMJSON_IMPL(key, std::string, EMPTY_STRING);
5946 FROMJSON_IMPL(activationCode, std::string, EMPTY_STRING);
5947 FROMJSON_IMPL(type,
int, 0);
5948 FROMJSON_IMPL(expires, time_t, 0);
5949 FROMJSON_IMPL(expiresFormatted, std::string, EMPTY_STRING);
5950 FROMJSON_IMPL(flags, uint32_t, 0);
5951 FROMJSON_IMPL(deviceId, std::string, EMPTY_STRING);
5952 FROMJSON_IMPL(status,
int, LicenseDescriptor::ERR_NOT_INITIALIZED);
5953 FROMJSON_IMPL(manufacturerId, std::string, EMPTY_STRING);
5954 FROMJSON_IMPL(cargo, std::string, EMPTY_STRING);
5955 FROMJSON_IMPL(cargoFlags, uint8_t, 0);
5956 FROMJSON_IMPL(activationHmac, std::string, EMPTY_STRING);
5961 JSON_SERIALIZED_CLASS(EngineNetworkingRpUdpStreaming)
5975 IMPLEMENT_JSON_SERIALIZATION()
6003 keepaliveIntervalSecs = 15;
6004 priority = TxPriority_t::priVoice;
6008 virtual void initForDocumenting()
6013 static void to_json(nlohmann::json& j,
const EngineNetworkingRpUdpStreaming& p)
6016 TOJSON_IMPL(enabled),
6018 TOJSON_IMPL(keepaliveIntervalSecs),
6019 TOJSON_IMPL(priority),
6023 static void from_json(
const nlohmann::json& j, EngineNetworkingRpUdpStreaming& p)
6026 getOptional<bool>(
"enabled", p.enabled, j,
false);
6027 getOptional<int>(
"port", p.port, j, 0);
6028 getOptional<int>(
"keepaliveIntervalSecs", p.keepaliveIntervalSecs, j, 15);
6029 getOptional<TxPriority_t>(
"priority", p.priority, j, TxPriority_t::priVoice);
6030 getOptional<int>(
"ttl", p.ttl, j, 64);
6034 JSON_SERIALIZED_CLASS(EnginePolicyNetworking)
6045 IMPLEMENT_JSON_SERIALIZATION()
6084 multicastRejoinSecs = 8;
6085 rallypointRtTestIntervalMs = 60000;
6086 logRtpJitterBufferStats =
false;
6087 preventMulticastFailover =
false;
6088 addressResolutionPolicy = AddressResolutionPolicy_t::arpIpv6ThenIpv4;
6089 requireMulticast =
true;
6090 rpUdpStreaming.clear();
6095 static void to_json(nlohmann::json& j,
const EnginePolicyNetworking& p)
6098 TOJSON_IMPL(defaultNic),
6099 TOJSON_IMPL(multicastRejoinSecs),
6101 TOJSON_IMPL(rallypointRtTestIntervalMs),
6102 TOJSON_IMPL(logRtpJitterBufferStats),
6103 TOJSON_IMPL(preventMulticastFailover),
6104 TOJSON_IMPL(requireMulticast),
6105 TOJSON_IMPL(rpUdpStreaming),
6106 TOJSON_IMPL(rtpProfile),
6107 TOJSON_IMPL(addressResolutionPolicy)
6110 static void from_json(
const nlohmann::json& j, EnginePolicyNetworking& p)
6113 FROMJSON_IMPL(defaultNic, std::string, EMPTY_STRING);
6114 FROMJSON_IMPL(multicastRejoinSecs,
int, 8);
6115 FROMJSON_IMPL(rallypointRtTestIntervalMs,
int, 60000);
6116 FROMJSON_IMPL(logRtpJitterBufferStats,
bool,
false);
6117 FROMJSON_IMPL(preventMulticastFailover,
bool,
false);
6118 FROMJSON_IMPL(requireMulticast,
bool,
true);
6119 getOptional<EngineNetworkingRpUdpStreaming>(
"rpUdpStreaming", p.rpUdpStreaming, j);
6120 getOptional<RtpProfile>(
"rtpProfile", p.rtpProfile, j);
6121 getOptional<AddressResolutionPolicy_t>(
"addressResolutionPolicy", p.addressResolutionPolicy, j, AddressResolutionPolicy_t::arpIpv6ThenIpv4);
6125 JSON_SERIALIZED_CLASS(Aec)
6137 IMPLEMENT_JSON_SERIALIZATION()
6138 IMPLEMENT_JSON_DOCUMENTATION(
Aec)
6193 static void to_json(nlohmann::json& j,
const Aec& p)
6196 TOJSON_IMPL(enabled),
6198 TOJSON_IMPL(speakerTailMs),
6202 static void from_json(
const nlohmann::json& j, Aec& p)
6205 FROMJSON_IMPL(enabled,
bool,
false);
6206 FROMJSON_IMPL(mode, Aec::Mode_t, Aec::Mode_t::aecmDefault);
6207 FROMJSON_IMPL(speakerTailMs,
int, 60);
6208 FROMJSON_IMPL(cng,
bool,
true);
6212 JSON_SERIALIZED_CLASS(Vad)
6224 IMPLEMENT_JSON_SERIALIZATION()
6225 IMPLEMENT_JSON_DOCUMENTATION(
Vad)
6245 vamVeryAggressive = 3
6266 static void to_json(nlohmann::json& j,
const Vad& p)
6269 TOJSON_IMPL(enabled),
6273 static void from_json(
const nlohmann::json& j, Vad& p)
6276 FROMJSON_IMPL(enabled,
bool,
false);
6277 FROMJSON_IMPL(mode, Vad::Mode_t, Vad::Mode_t::vamDefault);
6281 JSON_SERIALIZED_CLASS(Bridge)
6293 IMPLEMENT_JSON_SERIALIZATION()
6294 IMPLEMENT_JSON_DOCUMENTATION(
Bridge)
6330 static void to_json(nlohmann::json& j,
const Bridge& p)
6335 TOJSON_IMPL(groups),
6336 TOJSON_IMPL(enabled),
6340 static void from_json(
const nlohmann::json& j, Bridge& p)
6343 FROMJSON_IMPL(
id, std::string, EMPTY_STRING);
6344 FROMJSON_IMPL(name, std::string, EMPTY_STRING);
6345 getOptional<std::vector<std::string>>(
"groups", p.groups, j);
6346 FROMJSON_IMPL(enabled,
bool,
true);
6347 FROMJSON_IMPL(active,
bool,
true);
6351 JSON_SERIALIZED_CLASS(AndroidAudio)
6363 IMPLEMENT_JSON_SERIALIZATION()
6367 constexpr static int INVALID_SESSION_ID = -9999;
6428 performanceMode = 12;
6432 sessionId = AndroidAudio::INVALID_SESSION_ID;
6437 static void to_json(nlohmann::json& j,
const AndroidAudio& p)
6441 TOJSON_IMPL(sharingMode),
6442 TOJSON_IMPL(performanceMode),
6444 TOJSON_IMPL(contentType),
6445 TOJSON_IMPL(inputPreset),
6446 TOJSON_IMPL(sessionId),
6447 TOJSON_IMPL(engineMode)
6450 static void from_json(
const nlohmann::json& j, AndroidAudio& p)
6453 FROMJSON_IMPL(api,
int, 0);
6454 FROMJSON_IMPL(sharingMode,
int, 0);
6455 FROMJSON_IMPL(performanceMode,
int, 12);
6456 FROMJSON_IMPL(usage,
int, 2);
6457 FROMJSON_IMPL(contentType,
int, 1);
6458 FROMJSON_IMPL(inputPreset,
int, 7);
6459 FROMJSON_IMPL(sessionId,
int, AndroidAudio::INVALID_SESSION_ID);
6460 FROMJSON_IMPL(engineMode,
int, 0);
6464 JSON_SERIALIZED_CLASS(Denoiser)
6477 IMPLEMENT_JSON_SERIALIZATION()
6478 IMPLEMENT_JSON_DOCUMENTATION(
Denoiser)
6503 static void to_json(nlohmann::json& j,
const Denoiser& p)
6508 TOJSON_IMPL(vadGate)
6511 static void from_json(
const nlohmann::json& j, Denoiser& p)
6514 FROMJSON_IMPL(mix,
float, 1.0f);
6515 FROMJSON_IMPL(model, std::string,
"");
6516 FROMJSON_IMPL(vadGate,
float, 0.0f);
6520 JSON_SERIALIZED_CLASS(EnginePolicyAudio)
6532 IMPLEMENT_JSON_SERIALIZATION()
6593 hardwareEnabled =
true;
6594 internalRate = 16000;
6595 internalChannels = 2;
6602 denoiseInput =
false;
6603 denoiseOutput =
false;
6605 saveInputPcm =
false;
6606 saveOutputPcm =
false;
6611 static void to_json(nlohmann::json& j,
const EnginePolicyAudio& p)
6614 TOJSON_IMPL(enabled),
6615 TOJSON_IMPL(hardwareEnabled),
6616 TOJSON_IMPL(internalRate),
6617 TOJSON_IMPL(internalChannels),
6618 TOJSON_IMPL(muteTxOnTx),
6621 TOJSON_IMPL(android),
6622 TOJSON_IMPL(inputAgc),
6623 TOJSON_IMPL(outputAgc),
6624 TOJSON_IMPL(denoiseInput),
6625 TOJSON_IMPL(denoiseOutput),
6626 TOJSON_IMPL(denoiser),
6627 TOJSON_IMPL(saveInputPcm),
6628 TOJSON_IMPL(saveOutputPcm),
6629 TOJSON_IMPL(registry)
6632 static void from_json(
const nlohmann::json& j, EnginePolicyAudio& p)
6635 getOptional<bool>(
"enabled", p.enabled, j,
true);
6636 getOptional<bool>(
"hardwareEnabled", p.hardwareEnabled, j,
true);
6637 FROMJSON_IMPL(internalRate,
int, 16000);
6638 FROMJSON_IMPL(internalChannels,
int, 2);
6640 FROMJSON_IMPL(muteTxOnTx,
bool,
false);
6641 getOptional<Aec>(
"aec", p.aec, j);
6642 getOptional<Vad>(
"vad", p.vad, j);
6643 getOptional<AndroidAudio>(
"android", p.android, j);
6644 getOptional<Agc>(
"inputAgc", p.inputAgc, j);
6645 getOptional<Agc>(
"outputAgc", p.outputAgc, j);
6646 FROMJSON_IMPL(denoiseInput,
bool,
false);
6647 FROMJSON_IMPL(denoiseOutput,
bool,
false);
6648 getOptional<Denoiser>(
"denoiser", p.denoiser, j);
6649 FROMJSON_IMPL(saveInputPcm,
bool,
false);
6650 FROMJSON_IMPL(saveOutputPcm,
bool,
false);
6651 getOptional<AudioRegistry>(
"registry", p.registry, j);
6655 JSON_SERIALIZED_CLASS(SecurityCertificate)
6667 IMPLEMENT_JSON_SERIALIZATION()
6689 certificate.clear();
6694 static void to_json(nlohmann::json& j,
const SecurityCertificate& p)
6697 TOJSON_IMPL(certificate),
6701 static void from_json(
const nlohmann::json& j, SecurityCertificate& p)
6704 FROMJSON_IMPL(certificate, std::string, EMPTY_STRING);
6705 FROMJSON_IMPL(key, std::string, EMPTY_STRING);
6710 JSON_SERIALIZED_CLASS(EnginePolicySecurity)
6723 IMPLEMENT_JSON_SERIALIZATION()
6756 certificate.clear();
6757 caCertificates.clear();
6761 static void to_json(nlohmann::json& j,
const EnginePolicySecurity& p)
6764 TOJSON_IMPL(certificate),
6765 TOJSON_IMPL(caCertificates)
6768 static void from_json(
const nlohmann::json& j, EnginePolicySecurity& p)
6771 getOptional(
"certificate", p.certificate, j);
6772 getOptional<std::vector<std::string>>(
"caCertificates", p.caCertificates, j);
6776 JSON_SERIALIZED_CLASS(EnginePolicyLogging)
6788 IMPLEMENT_JSON_SERIALIZATION()
6821 enableSyslog =
false;
6825 static void to_json(nlohmann::json& j,
const EnginePolicyLogging& p)
6828 TOJSON_IMPL(maxLevel),
6829 TOJSON_IMPL(enableSyslog)
6832 static void from_json(
const nlohmann::json& j, EnginePolicyLogging& p)
6835 getOptional(
"maxLevel", p.maxLevel, j, 4);
6836 getOptional(
"enableSyslog", p.enableSyslog, j);
6841 JSON_SERIALIZED_CLASS(EnginePolicyDatabase)
6844 IMPLEMENT_JSON_SERIALIZATION()
6855 DatabaseType_t type;
6856 std::string fixedFileName;
6857 bool forceMaintenance;
6867 type = DatabaseType_t::dbtFixedMemory;
6868 fixedFileName.clear();
6869 forceMaintenance =
false;
6870 reclaimSpace =
false;
6878 TOJSON_IMPL(fixedFileName),
6879 TOJSON_IMPL(forceMaintenance),
6880 TOJSON_IMPL(reclaimSpace)
6883 static void from_json(
const nlohmann::json& j, EnginePolicyDatabase& p)
6886 FROMJSON_IMPL(type, EnginePolicyDatabase::DatabaseType_t, EnginePolicyDatabase::DatabaseType_t::dbtFixedMemory);
6887 FROMJSON_IMPL(fixedFileName, std::string, EMPTY_STRING);
6888 FROMJSON_IMPL(forceMaintenance,
bool,
false);
6889 FROMJSON_IMPL(reclaimSpace,
bool,
false);
6894 JSON_SERIALIZED_CLASS(SecureSignature)
6904 IMPLEMENT_JSON_SERIALIZATION()
6925 certificate.clear();
6931 static void to_json(nlohmann::json& j,
const SecureSignature& p)
6934 TOJSON_IMPL(certificate),
6936 TOJSON_IMPL(signature)
6939 static void from_json(
const nlohmann::json& j, SecureSignature& p)
6942 FROMJSON_IMPL(certificate, std::string, EMPTY_STRING);
6944 FROMJSON_IMPL(signature, std::string, EMPTY_STRING);
6948 JSON_SERIALIZED_CLASS(NamedAudioDevice)
6951 IMPLEMENT_JSON_SERIALIZATION()
6956 std::string manufacturer;
6959 std::string serialNumber;
6972 manufacturer.clear();
6975 serialNumber.clear();
6986 TOJSON_IMPL(manufacturer),
6989 TOJSON_IMPL(serialNumber),
6992 TOJSON_IMPL(isDefault),
6995 static void from_json(
const nlohmann::json& j, NamedAudioDevice& p)
6998 getOptional<std::string>(
"name", p.name, j, EMPTY_STRING);
6999 getOptional<std::string>(
"manufacturer", p.manufacturer, j, EMPTY_STRING);
7000 getOptional<std::string>(
"model", p.model, j, EMPTY_STRING);
7001 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
7002 getOptional<std::string>(
"serialNumber", p.serialNumber, j, EMPTY_STRING);
7003 getOptional<std::string>(
"type", p.type, j, EMPTY_STRING);
7004 getOptional<std::string>(
"extra", p.extra, j, EMPTY_STRING);
7005 getOptional<bool>(
"isDefault", p.isDefault, j,
false);
7010 JSON_SERIALIZED_CLASS(EnginePolicyNamedAudioDevices)
7013 IMPLEMENT_JSON_SERIALIZATION()
7017 std::vector<NamedAudioDevice> inputs;
7018 std::vector<NamedAudioDevice> outputs;
7035 TOJSON_IMPL(inputs),
7036 TOJSON_IMPL(outputs)
7039 static void from_json(
const nlohmann::json& j, EnginePolicyNamedAudioDevices& p)
7042 getOptional<std::vector<NamedAudioDevice>>(
"inputs", p.inputs, j);
7043 getOptional<std::vector<NamedAudioDevice>>(
"outputs", p.outputs, j);
7047 JSON_SERIALIZED_CLASS(Licensing)
7061 IMPLEMENT_JSON_SERIALIZATION()
7088 entitlement.clear();
7090 activationCode.clear();
7092 manufacturerId.clear();
7096 static void to_json(nlohmann::json& j,
const Licensing& p)
7099 TOJSON_IMPL(entitlement),
7101 TOJSON_IMPL(activationCode),
7102 TOJSON_IMPL(deviceId),
7103 TOJSON_IMPL(manufacturerId)
7106 static void from_json(
const nlohmann::json& j, Licensing& p)
7109 FROMJSON_IMPL(entitlement, std::string, EMPTY_STRING);
7110 FROMJSON_IMPL(key, std::string, EMPTY_STRING);
7111 FROMJSON_IMPL(activationCode, std::string, EMPTY_STRING);
7112 FROMJSON_IMPL(deviceId, std::string, EMPTY_STRING);
7113 FROMJSON_IMPL(manufacturerId, std::string, EMPTY_STRING);
7117 JSON_SERIALIZED_CLASS(DiscoveryMagellan)
7129 IMPLEMENT_JSON_SERIALIZATION()
7154 interfaceName.clear();
7160 static void to_json(nlohmann::json& j,
const DiscoveryMagellan& p)
7163 TOJSON_IMPL(enabled),
7164 TOJSON_IMPL(interfaceName),
7165 TOJSON_IMPL(security),
7169 static void from_json(
const nlohmann::json& j, DiscoveryMagellan& p)
7172 getOptional(
"enabled", p.enabled, j,
false);
7173 getOptional<Tls>(
"tls", p.tls, j);
7174 getOptional<SecurityCertificate>(
"security", p.security, j);
7175 FROMJSON_IMPL(interfaceName, std::string, EMPTY_STRING);
7179 JSON_SERIALIZED_CLASS(DiscoverySsdp)
7191 IMPLEMENT_JSON_SERIALIZATION()
7222 interfaceName.clear();
7224 searchTerms.clear();
7225 ageTimeoutMs = 30000;
7226 advertising.clear();
7230 static void to_json(nlohmann::json& j,
const DiscoverySsdp& p)
7233 TOJSON_IMPL(enabled),
7234 TOJSON_IMPL(interfaceName),
7235 TOJSON_IMPL(address),
7236 TOJSON_IMPL(searchTerms),
7237 TOJSON_IMPL(ageTimeoutMs),
7238 TOJSON_IMPL(advertising)
7241 static void from_json(
const nlohmann::json& j, DiscoverySsdp& p)
7244 getOptional(
"enabled", p.enabled, j,
false);
7245 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
7247 getOptional<NetworkAddress>(
"address", p.address, j);
7248 if(p.address.address.empty())
7250 p.address.address =
"255.255.255.255";
7252 if(p.address.port <= 0)
7254 p.address.port = 1900;
7257 getOptional<std::vector<std::string>>(
"searchTerms", p.searchTerms, j);
7258 getOptional<int>(
"ageTimeoutMs", p.ageTimeoutMs, j, 30000);
7259 getOptional<Advertising>(
"advertising", p.advertising, j);
7263 JSON_SERIALIZED_CLASS(DiscoverySap)
7275 IMPLEMENT_JSON_SERIALIZATION()
7302 interfaceName.clear();
7304 ageTimeoutMs = 30000;
7305 advertising.clear();
7309 static void to_json(nlohmann::json& j,
const DiscoverySap& p)
7312 TOJSON_IMPL(enabled),
7313 TOJSON_IMPL(interfaceName),
7314 TOJSON_IMPL(address),
7315 TOJSON_IMPL(ageTimeoutMs),
7316 TOJSON_IMPL(advertising)
7319 static void from_json(
const nlohmann::json& j, DiscoverySap& p)
7322 getOptional(
"enabled", p.enabled, j,
false);
7323 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
7324 getOptional<NetworkAddress>(
"address", p.address, j);
7325 if(p.address.address.empty())
7327 p.address.address =
"224.2.127.254";
7329 if(p.address.port <= 0)
7331 p.address.port = 9875;
7334 getOptional<int>(
"ageTimeoutMs", p.ageTimeoutMs, j, 30000);
7335 getOptional<Advertising>(
"advertising", p.advertising, j);
7339 JSON_SERIALIZED_CLASS(DiscoveryCistech)
7353 IMPLEMENT_JSON_SERIALIZATION()
7358 std::string interfaceName;
7370 interfaceName.clear();
7372 ageTimeoutMs = 30000;
7379 TOJSON_IMPL(enabled),
7380 TOJSON_IMPL(interfaceName),
7381 TOJSON_IMPL(address),
7382 TOJSON_IMPL(ageTimeoutMs)
7385 static void from_json(
const nlohmann::json& j, DiscoveryCistech& p)
7388 getOptional(
"enabled", p.enabled, j,
false);
7389 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
7390 getOptional<NetworkAddress>(
"address", p.address, j);
7391 getOptional<int>(
"ageTimeoutMs", p.ageTimeoutMs, j, 30000);
7396 JSON_SERIALIZED_CLASS(DiscoveryTrellisware)
7408 IMPLEMENT_JSON_SERIALIZATION()
7431 static void to_json(nlohmann::json& j,
const DiscoveryTrellisware& p)
7434 TOJSON_IMPL(enabled),
7435 TOJSON_IMPL(security)
7438 static void from_json(
const nlohmann::json& j, DiscoveryTrellisware& p)
7441 getOptional(
"enabled", p.enabled, j,
false);
7442 getOptional<SecurityCertificate>(
"security", p.security, j);
7446 JSON_SERIALIZED_CLASS(DiscoveryConfiguration)
7458 IMPLEMENT_JSON_SERIALIZATION()
7491 static void to_json(nlohmann::json& j,
const DiscoveryConfiguration& p)
7494 TOJSON_IMPL(magellan),
7497 TOJSON_IMPL(cistech),
7498 TOJSON_IMPL(trellisware)
7501 static void from_json(
const nlohmann::json& j, DiscoveryConfiguration& p)
7504 getOptional<DiscoveryMagellan>(
"magellan", p.magellan, j);
7505 getOptional<DiscoverySsdp>(
"ssdp", p.ssdp, j);
7506 getOptional<DiscoverySap>(
"sap", p.sap, j);
7507 getOptional<DiscoveryCistech>(
"cistech", p.cistech, j);
7508 getOptional<DiscoveryTrellisware>(
"trellisware", p.trellisware, j);
7513 JSON_SERIALIZED_CLASS(ApiCallPacingLaneSettings)
7523 IMPLEMENT_JSON_SERIALIZATION()
7541 maxQueueDepth = 512;
7544 virtual void initForDocumenting()
7550 static void to_json(nlohmann::json& j,
const ApiCallPacingLaneSettings& p)
7553 TOJSON_IMPL(intervalMs),
7554 TOJSON_IMPL(maxQueueDepth)
7557 static void from_json(
const nlohmann::json& j, ApiCallPacingLaneSettings& p)
7560 getOptional<int>(
"intervalMs", p.intervalMs, j, 0);
7561 getOptional<uint32_t>(
"maxQueueDepth", p.maxQueueDepth, j, 512);
7565 JSON_SERIALIZED_CLASS(ApiCallPacingSettings)
7578 IMPLEMENT_JSON_SERIALIZATION()
7599 transmission.clear();
7600 configuration.clear();
7603 virtual void initForDocumenting()
7609 static void to_json(nlohmann::json& j,
const ApiCallPacingSettings& p)
7612 TOJSON_IMPL(topology),
7613 TOJSON_IMPL(transmission),
7614 TOJSON_IMPL(configuration)
7617 static void from_json(
const nlohmann::json& j, ApiCallPacingSettings& p)
7620 getOptional<ApiCallPacingLaneSettings>(
"topology", p.topology, j);
7621 getOptional<ApiCallPacingLaneSettings>(
"transmission", p.transmission, j);
7622 getOptional<ApiCallPacingLaneSettings>(
"configuration", p.configuration, j);
7626 JSON_SERIALIZED_CLASS(EnginePolicyInternals)
7640 IMPLEMENT_JSON_SERIALIZATION()
7655 int logTaskQueueStatsIntervalMs;
7657 bool enableLazySpeakerClosure;
7697 housekeeperIntervalMs = 1000;
7698 logTaskQueueStatsIntervalMs = 0;
7701 enableLazySpeakerClosure =
false;
7702 rpClusterStrategy = RallypointCluster::ConnectionStrategy_t::csRoundRobin;
7703 rpClusterRolloverSecs = 10;
7704 rtpExpirationCheckIntervalMs = 250;
7705 rpConnectionTimeoutSecs = 0;
7706 rpTransactionTimeoutMs = 0;
7707 stickyTidHangSecs = 10;
7708 uriStreamingIntervalMs = 60;
7709 delayedMicrophoneClosureSecs = 15;
7711 apiCallPacing.clear();
7715 static void to_json(nlohmann::json& j,
const EnginePolicyInternals& p)
7718 TOJSON_IMPL(watchdog),
7719 TOJSON_IMPL(housekeeperIntervalMs),
7720 TOJSON_IMPL(logTaskQueueStatsIntervalMs),
7721 TOJSON_IMPL(maxTxSecs),
7722 TOJSON_IMPL(maxRxSecs),
7723 TOJSON_IMPL(enableLazySpeakerClosure),
7724 TOJSON_IMPL(rpClusterStrategy),
7725 TOJSON_IMPL(rpClusterRolloverSecs),
7726 TOJSON_IMPL(rtpExpirationCheckIntervalMs),
7727 TOJSON_IMPL(rpConnectionTimeoutSecs),
7728 TOJSON_IMPL(rpTransactionTimeoutMs),
7729 TOJSON_IMPL(stickyTidHangSecs),
7730 TOJSON_IMPL(uriStreamingIntervalMs),
7731 TOJSON_IMPL(delayedMicrophoneClosureSecs),
7732 TOJSON_IMPL(tuning),
7733 TOJSON_IMPL(apiCallPacing)
7736 static void from_json(
const nlohmann::json& j, EnginePolicyInternals& p)
7739 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
7740 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
7741 getOptional<int>(
"logTaskQueueStatsIntervalMs", p.logTaskQueueStatsIntervalMs, j, 0);
7742 getOptional<int>(
"maxTxSecs", p.maxTxSecs, j, 30);
7743 getOptional<int>(
"maxRxSecs", p.maxRxSecs, j, 0);
7744 getOptional<bool>(
"enableLazySpeakerClosure", p.enableLazySpeakerClosure, j,
false);
7745 getOptional<RallypointCluster::ConnectionStrategy_t>(
"rpClusterStrategy", p.rpClusterStrategy, j, RallypointCluster::ConnectionStrategy_t::csRoundRobin);
7746 getOptional<int>(
"rpClusterRolloverSecs", p.rpClusterRolloverSecs, j, 10);
7747 getOptional<int>(
"rtpExpirationCheckIntervalMs", p.rtpExpirationCheckIntervalMs, j, 250);
7748 getOptional<int>(
"rpConnectionTimeoutSecs", p.rpConnectionTimeoutSecs, j, 0);
7749 getOptional<int>(
"rpTransactionTimeoutMs", p.rpTransactionTimeoutMs, j, 0);
7750 getOptional<int>(
"stickyTidHangSecs", p.stickyTidHangSecs, j, 10);
7751 getOptional<int>(
"uriStreamingIntervalMs", p.uriStreamingIntervalMs, j, 60);
7752 getOptional<int>(
"delayedMicrophoneClosureSecs", p.delayedMicrophoneClosureSecs, j, 15);
7753 getOptional<TuningSettings>(
"tuning", p.tuning, j);
7754 getOptional<ApiCallPacingSettings>(
"apiCallPacing", p.apiCallPacing, j);
7758 JSON_SERIALIZED_CLASS(EnginePolicyTimelines)
7772 IMPLEMENT_JSON_SERIALIZATION()
7834 storageRoot.clear();
7835 maxStorageMb = 1024;
7836 maxMemMb = maxStorageMb;
7837 maxAudioEventMemMb = maxMemMb;
7838 maxDiskMb = maxStorageMb;
7839 maxEventAgeSecs = (86400 * 30);
7840 groomingIntervalSecs = (60 * 30);
7842 autosaveIntervalSecs = 5;
7844 disableSigningAndVerification =
false;
7849 static void to_json(nlohmann::json& j,
const EnginePolicyTimelines& p)
7852 TOJSON_IMPL(enabled),
7853 TOJSON_IMPL(storageRoot),
7854 TOJSON_IMPL(maxMemMb),
7855 TOJSON_IMPL(maxAudioEventMemMb),
7856 TOJSON_IMPL(maxDiskMb),
7857 TOJSON_IMPL(maxEventAgeSecs),
7858 TOJSON_IMPL(maxEvents),
7859 TOJSON_IMPL(groomingIntervalSecs),
7860 TOJSON_IMPL(autosaveIntervalSecs),
7861 TOJSON_IMPL(security),
7862 TOJSON_IMPL(disableSigningAndVerification),
7863 TOJSON_IMPL(ephemeral)
7866 static void from_json(
const nlohmann::json& j, EnginePolicyTimelines& p)
7869 getOptional<bool>(
"enabled", p.enabled, j,
true);
7870 getOptional<std::string>(
"storageRoot", p.storageRoot, j, EMPTY_STRING);
7872 getOptional<int>(
"maxStorageMb", p.maxStorageMb, j, 1024);
7873 getOptional<int>(
"maxMemMb", p.maxMemMb, j, p.maxStorageMb);
7874 getOptional<int>(
"maxAudioEventMemMb", p.maxAudioEventMemMb, j, p.maxMemMb);
7875 getOptional<int>(
"maxDiskMb", p.maxDiskMb, j, p.maxStorageMb);
7876 getOptional<long>(
"maxEventAgeSecs", p.maxEventAgeSecs, j, (86400 * 30));
7877 getOptional<long>(
"groomingIntervalSecs", p.groomingIntervalSecs, j, (60 * 30));
7878 getOptional<long>(
"autosaveIntervalSecs", p.autosaveIntervalSecs, j, 5);
7879 getOptional<int>(
"maxEvents", p.maxEvents, j, 1000);
7880 getOptional<SecurityCertificate>(
"security", p.security, j);
7881 getOptional<bool>(
"disableSigningAndVerification", p.disableSigningAndVerification, j,
false);
7882 getOptional<bool>(
"ephemeral", p.ephemeral, j,
false);
7887 JSON_SERIALIZED_CLASS(RtpMapEntry)
7899 IMPLEMENT_JSON_SERIALIZATION()
7921 rtpPayloadType = -1;
7925 static void to_json(nlohmann::json& j,
const RtpMapEntry& p)
7929 TOJSON_IMPL(engageType),
7930 TOJSON_IMPL(rtpPayloadType)
7933 static void from_json(
const nlohmann::json& j, RtpMapEntry& p)
7936 getOptional<std::string>(
"name", p.name, j, EMPTY_STRING);
7937 getOptional<int>(
"engageType", p.engageType, j, -1);
7938 getOptional<int>(
"rtpPayloadType", p.rtpPayloadType, j, -1);
7942 JSON_SERIALIZED_CLASS(ExternalModule)
7954 IMPLEMENT_JSON_SERIALIZATION()
7976 configuration.clear();
7980 static void to_json(nlohmann::json& j,
const ExternalModule& p)
7987 if(!p.configuration.empty())
7989 j[
"configuration"] = p.configuration;
7992 static void from_json(
const nlohmann::json& j, ExternalModule& p)
7995 getOptional<std::string>(
"name", p.name, j, EMPTY_STRING);
7996 getOptional<std::string>(
"file", p.file, j, EMPTY_STRING);
8000 p.configuration = j.at(
"configuration");
8004 p.configuration.clear();
8010 JSON_SERIALIZED_CLASS(ExternalCodecDescriptor)
8022 IMPLEMENT_JSON_SERIALIZATION()
8045 rtpPayloadType = -1;
8048 rtpTsMultiplier = 0;
8052 static void to_json(nlohmann::json& j,
const ExternalCodecDescriptor& p)
8055 TOJSON_IMPL(rtpPayloadType),
8056 TOJSON_IMPL(samplingRate),
8057 TOJSON_IMPL(channels),
8058 TOJSON_IMPL(rtpTsMultiplier)
8061 static void from_json(
const nlohmann::json& j, ExternalCodecDescriptor& p)
8065 getOptional<int>(
"rtpPayloadType", p.rtpPayloadType, j, -1);
8066 getOptional<int>(
"samplingRate", p.samplingRate, j, -1);
8067 getOptional<int>(
"channels", p.channels, j, -1);
8068 getOptional<int>(
"rtpTsMultiplier", p.rtpTsMultiplier, j, -1);
8072 JSON_SERIALIZED_CLASS(EngineStatusReportConfiguration)
8084 IMPLEMENT_JSON_SERIALIZATION()
8116 includeMemoryDetail =
false;
8117 includeTaskQueueDetail =
false;
8122 static void to_json(nlohmann::json& j,
const EngineStatusReportConfiguration& p)
8125 TOJSON_IMPL(fileName),
8126 TOJSON_IMPL(intervalSecs),
8127 TOJSON_IMPL(enabled),
8128 TOJSON_IMPL(includeMemoryDetail),
8129 TOJSON_IMPL(includeTaskQueueDetail),
8133 static void from_json(
const nlohmann::json& j, EngineStatusReportConfiguration& p)
8136 getOptional<std::string>(
"fileName", p.fileName, j);
8137 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
8138 getOptional<bool>(
"enabled", p.enabled, j,
false);
8139 getOptional<std::string>(
"runCmd", p.runCmd, j);
8140 getOptional<bool>(
"includeMemoryDetail", p.includeMemoryDetail, j,
false);
8141 getOptional<bool>(
"includeTaskQueueDetail", p.includeTaskQueueDetail, j,
false);
8145 JSON_SERIALIZED_CLASS(EnginePolicy)
8159 IMPLEMENT_JSON_SERIALIZATION()
8216 dataDirectory.clear();
8227 namedAudioDevices.clear();
8228 externalCodecs.clear();
8230 statusReport.clear();
8234 static void to_json(nlohmann::json& j,
const EnginePolicy& p)
8237 TOJSON_IMPL(dataDirectory),
8238 TOJSON_IMPL(licensing),
8239 TOJSON_IMPL(security),
8240 TOJSON_IMPL(networking),
8242 TOJSON_IMPL(discovery),
8243 TOJSON_IMPL(logging),
8244 TOJSON_IMPL(internals),
8245 TOJSON_IMPL(timelines),
8246 TOJSON_IMPL(database),
8247 TOJSON_IMPL(featureset),
8248 TOJSON_IMPL(namedAudioDevices),
8249 TOJSON_IMPL(externalCodecs),
8250 TOJSON_IMPL(rtpMap),
8251 TOJSON_IMPL(statusReport)
8254 static void from_json(
const nlohmann::json& j, EnginePolicy& p)
8257 FROMJSON_IMPL_SIMPLE(dataDirectory);
8258 FROMJSON_IMPL_SIMPLE(licensing);
8259 FROMJSON_IMPL_SIMPLE(security);
8260 FROMJSON_IMPL_SIMPLE(networking);
8261 FROMJSON_IMPL_SIMPLE(audio);
8262 FROMJSON_IMPL_SIMPLE(discovery);
8263 FROMJSON_IMPL_SIMPLE(logging);
8264 FROMJSON_IMPL_SIMPLE(internals);
8265 FROMJSON_IMPL_SIMPLE(timelines);
8266 FROMJSON_IMPL_SIMPLE(database);
8267 FROMJSON_IMPL_SIMPLE(featureset);
8268 FROMJSON_IMPL_SIMPLE(namedAudioDevices);
8269 FROMJSON_IMPL_SIMPLE(externalCodecs);
8270 FROMJSON_IMPL_SIMPLE(rtpMap);
8271 FROMJSON_IMPL_SIMPLE(statusReport);
8276 JSON_SERIALIZED_CLASS(TalkgroupAsset)
8288 IMPLEMENT_JSON_SERIALIZATION()
8311 static void to_json(nlohmann::json& j,
const TalkgroupAsset& p)
8314 TOJSON_IMPL(nodeId),
8318 static void from_json(
const nlohmann::json& j, TalkgroupAsset& p)
8321 getOptional<std::string>(
"nodeId", p.nodeId, j);
8322 getOptional<Group>(
"group", p.group, j);
8326 JSON_SERIALIZED_CLASS(EngageDiscoveredGroup)
8336 IMPLEMENT_JSON_SERIALIZATION()
8366 static void to_json(nlohmann::json& j,
const EngageDiscoveredGroup& p)
8375 static void from_json(
const nlohmann::json& j, EngageDiscoveredGroup& p)
8378 getOptional<std::string>(
"id", p.id, j);
8379 getOptional<int>(
"type", p.type, j, 0);
8380 getOptional<NetworkAddress>(
"rx", p.rx, j);
8381 getOptional<NetworkAddress>(
"tx", p.tx, j);
8385 JSON_SERIALIZED_CLASS(RallypointPeer)
8397 IMPLEMENT_JSON_SERIALIZATION()
8404 olpUseRpConfiguration = 0,
8411 } OutboundLeafPolicy_t;
8416 olpUseRpWebSocketTlsConfiguration = 0,
8419 olpUseTlsForWebSocket = 1,
8422 olpDoNotUseTlsForWebSocket = 2
8423 } OutboundWebSocketTlsPolicy_t;
8475 certificate.clear();
8476 connectionTimeoutSecs = 0;
8477 forceIsMeshLeaf =
false;
8478 outboundLeafPolicy = OutboundLeafPolicy_t::olpUseRpConfiguration;
8479 protocol = Rallypoint::RpProtocol_t::rppTlsTcp;
8481 additionalProtocols.clear();
8483 outboundWebSocketTlsPolicy = OutboundWebSocketTlsPolicy_t::olpUseRpWebSocketTlsConfiguration;
8487 static void to_json(nlohmann::json& j,
const RallypointPeer& p)
8491 TOJSON_IMPL(enabled),
8493 TOJSON_IMPL(certificate),
8494 TOJSON_IMPL(connectionTimeoutSecs),
8495 TOJSON_IMPL(forceIsMeshLeaf),
8496 TOJSON_IMPL(outboundLeafPolicy),
8497 TOJSON_IMPL(protocol),
8499 TOJSON_IMPL(additionalProtocols),
8501 TOJSON_IMPL(outboundWebSocketTlsPolicy)
8504 static void from_json(
const nlohmann::json& j, RallypointPeer& p)
8507 j.at(
"id").get_to(p.id);
8508 getOptional<bool>(
"enabled", p.enabled, j,
true);
8509 getOptional<NetworkAddress>(
"host", p.host, j);
8510 getOptional<SecurityCertificate>(
"certificate", p.certificate, j);
8511 getOptional<int>(
"connectionTimeoutSecs", p.connectionTimeoutSecs, j, 0);
8512 getOptional<bool>(
"forceIsMeshLeaf", p.forceIsMeshLeaf, j,
false);
8513 getOptional<RallypointPeer::OutboundLeafPolicy_t>(
"outboundLeafPolicy", p.outboundLeafPolicy, j, RallypointPeer::OutboundLeafPolicy_t::olpUseRpConfiguration);
8514 getOptional<Rallypoint::RpProtocol_t>(
"protocol", p.protocol, j, Rallypoint::RpProtocol_t::rppTlsTcp);
8515 getOptional<std::string>(
"path", p.path, j);
8516 getOptional<std::string>(
"additionalProtocols", p.additionalProtocols, j);
8517 getOptional<std::string>(
"sni", p.sni, j);
8518 getOptional<RallypointPeer::OutboundWebSocketTlsPolicy_t>(
"outboundWebSocketTlsPolicy", p.outboundWebSocketTlsPolicy, j, RallypointPeer::OutboundWebSocketTlsPolicy_t::olpUseRpWebSocketTlsConfiguration);
8522 JSON_SERIALIZED_CLASS(RallypointServerLimits)
8534 IMPLEMENT_JSON_SERIALIZATION()
8592 maxMulticastReflectors = 0;
8593 maxRegisteredStreams = 0;
8595 maxRxPacketsPerSec = 0;
8596 maxTxPacketsPerSec = 0;
8597 maxRxBytesPerSec = 0;
8598 maxTxBytesPerSec = 0;
8600 maxInboundBacklog = 64;
8601 lowPriorityQueueThreshold = 64;
8602 normalPriorityQueueThreshold = 256;
8603 denyNewConnectionCpuThreshold = 75;
8604 warnAtCpuThreshold = 65;
8608 static void to_json(nlohmann::json& j,
const RallypointServerLimits& p)
8611 TOJSON_IMPL(maxClients),
8612 TOJSON_IMPL(maxPeers),
8613 TOJSON_IMPL(maxMulticastReflectors),
8614 TOJSON_IMPL(maxRegisteredStreams),
8615 TOJSON_IMPL(maxStreamPaths),
8616 TOJSON_IMPL(maxRxPacketsPerSec),
8617 TOJSON_IMPL(maxTxPacketsPerSec),
8618 TOJSON_IMPL(maxRxBytesPerSec),
8619 TOJSON_IMPL(maxTxBytesPerSec),
8620 TOJSON_IMPL(maxQOpsPerSec),
8621 TOJSON_IMPL(maxInboundBacklog),
8622 TOJSON_IMPL(lowPriorityQueueThreshold),
8623 TOJSON_IMPL(normalPriorityQueueThreshold),
8624 TOJSON_IMPL(denyNewConnectionCpuThreshold),
8625 TOJSON_IMPL(warnAtCpuThreshold)
8628 static void from_json(
const nlohmann::json& j, RallypointServerLimits& p)
8631 getOptional<uint32_t>(
"maxClients", p.maxClients, j, 0);
8632 getOptional<uint32_t>(
"maxPeers", p.maxPeers, j, 0);
8633 getOptional<uint32_t>(
"maxMulticastReflectors", p.maxMulticastReflectors, j, 0);
8634 getOptional<uint32_t>(
"maxRegisteredStreams", p.maxRegisteredStreams, j, 0);
8635 getOptional<uint32_t>(
"maxStreamPaths", p.maxStreamPaths, j, 0);
8636 getOptional<uint32_t>(
"maxRxPacketsPerSec", p.maxRxPacketsPerSec, j, 0);
8637 getOptional<uint32_t>(
"maxTxPacketsPerSec", p.maxTxPacketsPerSec, j, 0);
8638 getOptional<uint32_t>(
"maxRxBytesPerSec", p.maxRxBytesPerSec, j, 0);
8639 getOptional<uint32_t>(
"maxTxBytesPerSec", p.maxTxBytesPerSec, j, 0);
8640 getOptional<uint32_t>(
"maxQOpsPerSec", p.maxQOpsPerSec, j, 0);
8641 getOptional<uint32_t>(
"maxInboundBacklog", p.maxInboundBacklog, j, 64);
8642 getOptional<uint32_t>(
"lowPriorityQueueThreshold", p.lowPriorityQueueThreshold, j, 64);
8643 getOptional<uint32_t>(
"normalPriorityQueueThreshold", p.normalPriorityQueueThreshold, j, 256);
8644 getOptional<uint32_t>(
"denyNewConnectionCpuThreshold", p.denyNewConnectionCpuThreshold, j, 75);
8645 getOptional<uint32_t>(
"warnAtCpuThreshold", p.warnAtCpuThreshold, j, 65);
8649 JSON_SERIALIZED_CLASS(RallypointServerStatusReportConfiguration)
8661 IMPLEMENT_JSON_SERIALIZATION()
8696 includeLinks =
false;
8697 includePeerLinkDetails =
false;
8698 includeClientLinkDetails =
false;
8703 static void to_json(nlohmann::json& j,
const RallypointServerStatusReportConfiguration& p)
8706 TOJSON_IMPL(fileName),
8707 TOJSON_IMPL(intervalSecs),
8708 TOJSON_IMPL(enabled),
8709 TOJSON_IMPL(includeLinks),
8710 TOJSON_IMPL(includePeerLinkDetails),
8711 TOJSON_IMPL(includeClientLinkDetails),
8715 static void from_json(
const nlohmann::json& j, RallypointServerStatusReportConfiguration& p)
8718 getOptional<std::string>(
"fileName", p.fileName, j);
8719 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
8720 getOptional<bool>(
"enabled", p.enabled, j,
false);
8721 getOptional<bool>(
"includeLinks", p.includeLinks, j,
false);
8722 getOptional<bool>(
"includePeerLinkDetails", p.includePeerLinkDetails, j,
false);
8723 getOptional<bool>(
"includeClientLinkDetails", p.includeClientLinkDetails, j,
false);
8724 getOptional<std::string>(
"runCmd", p.runCmd, j);
8728 JSON_SERIALIZED_CLASS(RallypointServerLinkGraph)
8731 IMPLEMENT_JSON_SERIALIZATION()
8774 includeDigraphEnclosure =
true;
8775 includeClients =
false;
8776 coreRpStyling =
"[shape=hexagon color=firebrick style=filled]";
8777 leafRpStyling =
"[shape=box color=gray style=filled]";
8778 clientStyling.clear();
8783 static void to_json(nlohmann::json& j,
const RallypointServerLinkGraph& p)
8786 TOJSON_IMPL(fileName),
8787 TOJSON_IMPL(minRefreshSecs),
8788 TOJSON_IMPL(enabled),
8789 TOJSON_IMPL(includeDigraphEnclosure),
8790 TOJSON_IMPL(includeClients),
8791 TOJSON_IMPL(coreRpStyling),
8792 TOJSON_IMPL(leafRpStyling),
8793 TOJSON_IMPL(clientStyling),
8797 static void from_json(
const nlohmann::json& j, RallypointServerLinkGraph& p)
8800 getOptional<std::string>(
"fileName", p.fileName, j);
8801 getOptional<int>(
"minRefreshSecs", p.minRefreshSecs, j, 5);
8802 getOptional<bool>(
"enabled", p.enabled, j,
false);
8803 getOptional<bool>(
"includeDigraphEnclosure", p.includeDigraphEnclosure, j,
true);
8804 getOptional<bool>(
"includeClients", p.includeClients, j,
false);
8805 getOptional<std::string>(
"coreRpStyling", p.coreRpStyling, j,
"[shape=hexagon color=firebrick style=filled]");
8806 getOptional<std::string>(
"leafRpStyling", p.leafRpStyling, j,
"[shape=box color=gray style=filled]");
8807 getOptional<std::string>(
"clientStyling", p.clientStyling, j);
8808 getOptional<std::string>(
"runCmd", p.runCmd, j);
8813 JSON_SERIALIZED_CLASS(RallypointServerStreamStatsExport)
8823 IMPLEMENT_JSON_SERIALIZATION()
8866 resetCountersAfterExport =
false;
8872 static void to_json(nlohmann::json& j,
const RallypointServerStreamStatsExport& p)
8875 TOJSON_IMPL(fileName),
8876 TOJSON_IMPL(intervalSecs),
8877 TOJSON_IMPL(enabled),
8878 TOJSON_IMPL(resetCountersAfterExport),
8879 TOJSON_IMPL(runCmd),
8883 static void from_json(
const nlohmann::json& j, RallypointServerStreamStatsExport& p)
8886 getOptional<std::string>(
"fileName", p.fileName, j);
8887 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
8888 getOptional<bool>(
"enabled", p.enabled, j,
false);
8889 getOptional<bool>(
"resetCountersAfterExport", p.resetCountersAfterExport, j,
false);
8890 getOptional<std::string>(
"runCmd", p.runCmd, j);
8891 getOptional<RallypointServerStreamStatsExport::ExportFormat_t>(
"format", p.format, j, RallypointServerStreamStatsExport::ExportFormat_t::fmtCsv);
8895 JSON_SERIALIZED_CLASS(RallypointServerRouteMap)
8898 IMPLEMENT_JSON_SERIALIZATION()
8927 static void to_json(nlohmann::json& j,
const RallypointServerRouteMap& p)
8930 TOJSON_IMPL(fileName),
8931 TOJSON_IMPL(minRefreshSecs),
8932 TOJSON_IMPL(enabled),
8936 static void from_json(
const nlohmann::json& j, RallypointServerRouteMap& p)
8939 getOptional<std::string>(
"fileName", p.fileName, j);
8940 getOptional<int>(
"minRefreshSecs", p.minRefreshSecs, j, 5);
8941 getOptional<bool>(
"enabled", p.enabled, j,
false);
8942 getOptional<std::string>(
"runCmd", p.runCmd, j);
8947 JSON_SERIALIZED_CLASS(ExternalHealthCheckResponder)
8959 IMPLEMENT_JSON_SERIALIZATION()
8978 immediateClose =
true;
8982 static void to_json(nlohmann::json& j,
const ExternalHealthCheckResponder& p)
8985 TOJSON_IMPL(listenPort),
8986 TOJSON_IMPL(immediateClose)
8989 static void from_json(
const nlohmann::json& j, ExternalHealthCheckResponder& p)
8992 getOptional<int>(
"listenPort", p.listenPort, j, 0);
8993 getOptional<bool>(
"immediateClose", p.immediateClose, j,
true);
8998 JSON_SERIALIZED_CLASS(PeeringConfiguration)
9008 IMPLEMENT_JSON_SERIALIZATION()
9038 static void to_json(nlohmann::json& j,
const PeeringConfiguration& p)
9042 TOJSON_IMPL(version),
9043 TOJSON_IMPL(comments),
9047 static void from_json(
const nlohmann::json& j, PeeringConfiguration& p)
9050 getOptional<std::string>(
"id", p.id, j);
9051 getOptional<int>(
"version", p.version, j, 0);
9052 getOptional<std::string>(
"comments", p.comments, j);
9053 getOptional<std::vector<RallypointPeer>>(
"peers", p.peers, j);
9057 JSON_SERIALIZED_CLASS(IgmpSnooping)
9067 IMPLEMENT_JSON_SERIALIZATION()
9090 queryIntervalMs = 125000;
9091 subscriptionTimeoutMs = 0;
9095 static void to_json(nlohmann::json& j,
const IgmpSnooping& p)
9098 TOJSON_IMPL(enabled),
9099 TOJSON_IMPL(queryIntervalMs),
9100 TOJSON_IMPL(subscriptionTimeoutMs)
9103 static void from_json(
const nlohmann::json& j, IgmpSnooping& p)
9106 getOptional<bool>(
"enabled", p.enabled, j);
9107 getOptional<int>(
"queryIntervalMs", p.queryIntervalMs, j, 125000);
9108 getOptional<int>(
"subscriptionTimeoutMs", p.subscriptionTimeoutMs, j, 0);
9113 JSON_SERIALIZED_CLASS(RallypointReflector)
9122 IMPLEMENT_JSON_SERIALIZATION()
9137 } DirectionRestriction_t;
9169 multicastInterfaceName.clear();
9170 additionalTx.clear();
9171 directionRestriction = drNone;
9175 static void to_json(nlohmann::json& j,
const RallypointReflector& p)
9181 TOJSON_IMPL(multicastInterfaceName),
9182 TOJSON_IMPL(additionalTx),
9183 TOJSON_IMPL(directionRestriction)
9186 static void from_json(
const nlohmann::json& j, RallypointReflector& p)
9189 j.at(
"id").get_to(p.id);
9190 j.at(
"rx").get_to(p.rx);
9191 j.at(
"tx").get_to(p.tx);
9192 getOptional<std::string>(
"multicastInterfaceName", p.multicastInterfaceName, j);
9193 getOptional<std::vector<NetworkAddress>>(
"additionalTx", p.additionalTx, j);
9194 getOptional<RallypointReflector::DirectionRestriction_t>(
"directionRestriction", p.directionRestriction, j, RallypointReflector::DirectionRestriction_t::drNone);
9199 JSON_SERIALIZED_CLASS(RallypointUdpStreamingIpvX)
9208 IMPLEMENT_JSON_SERIALIZATION()
9230 static void to_json(nlohmann::json& j,
const RallypointUdpStreamingIpvX& p)
9233 TOJSON_IMPL(enabled),
9234 TOJSON_IMPL(external)
9237 static void from_json(
const nlohmann::json& j, RallypointUdpStreamingIpvX& p)
9240 getOptional<bool>(
"enabled", p.enabled, j,
true);
9241 getOptional<NetworkAddress>(
"external", p.external, j);
9245 JSON_SERIALIZED_CLASS(RallypointUdpStreaming)
9254 IMPLEMENT_JSON_SERIALIZATION()
9265 ctSharedKeyAes256FullIv = 1,
9268 ctSharedKeyAes256IdxIv = 2,
9271 ctSharedKeyChaCha20FullIv = 3,
9274 ctSharedKeyChaCha20IdxIv = 4
9310 cryptoType = CryptoType_t::ctSharedKeyAes256FullIv;
9314 keepaliveIntervalSecs = 15;
9315 priority = TxPriority_t::priVoice;
9320 static void to_json(nlohmann::json& j,
const RallypointUdpStreaming& p)
9323 TOJSON_IMPL(enabled),
9324 TOJSON_IMPL(cryptoType),
9325 TOJSON_IMPL(listenPort),
9326 TOJSON_IMPL(keepaliveIntervalSecs),
9329 TOJSON_IMPL(priority),
9333 static void from_json(
const nlohmann::json& j, RallypointUdpStreaming& p)
9336 getOptional<bool>(
"enabled", p.enabled, j,
true);
9337 getOptional<RallypointUdpStreaming::CryptoType_t>(
"cryptoType", p.cryptoType, j, RallypointUdpStreaming::CryptoType_t::ctSharedKeyAes256FullIv);
9338 getOptional<int>(
"listenPort", p.listenPort, j, 7444);
9339 getOptional<int>(
"keepaliveIntervalSecs", p.keepaliveIntervalSecs, j, 15);
9340 getOptional<RallypointUdpStreamingIpvX>(
"ipv4", p.ipv4, j);
9341 getOptional<RallypointUdpStreamingIpvX>(
"ipv6", p.ipv6, j);
9342 getOptional<TxPriority_t>(
"priority", p.priority, j, TxPriority_t::priVoice);
9343 getOptional<int>(
"ttl", p.ttl, j, 64);
9347 JSON_SERIALIZED_CLASS(RallypointRpRtTimingBehavior)
9356 IMPLEMENT_JSON_SERIALIZATION()
9401 static void to_json(nlohmann::json& j,
const RallypointRpRtTimingBehavior& p)
9404 TOJSON_IMPL(behavior),
9405 TOJSON_IMPL(atOrAboveMs),
9409 static void from_json(
const nlohmann::json& j, RallypointRpRtTimingBehavior& p)
9412 getOptional<RallypointRpRtTimingBehavior::BehaviorType_t>(
"behavior", p.behavior, j, RallypointRpRtTimingBehavior::BehaviorType_t::btNone);
9413 getOptional<uint32_t>(
"atOrAboveMs", p.atOrAboveMs, j, 0);
9414 getOptional<std::string>(
"runCmd", p.runCmd, j);
9419 JSON_SERIALIZED_CLASS(RallypointWebsocketSettings)
9428 IMPLEMENT_JSON_SERIALIZATION()
9456 certificate.clear();
9457 requireClientCertificate =
false;
9462 static void to_json(nlohmann::json& j,
const RallypointWebsocketSettings& p)
9465 TOJSON_IMPL(enabled),
9466 TOJSON_IMPL(listenPort),
9467 TOJSON_IMPL(certificate),
9468 TOJSON_IMPL(requireClientCertificate),
9469 TOJSON_IMPL(requireTls)
9472 static void from_json(
const nlohmann::json& j, RallypointWebsocketSettings& p)
9475 getOptional<bool>(
"enabled", p.enabled, j,
false);
9476 getOptional<int>(
"listenPort", p.listenPort, j, 8443);
9477 getOptional<SecurityCertificate>(
"certificate", p.certificate, j);
9478 getOptional<bool>(
"requireClientCertificate", p.requireClientCertificate, j,
false);
9479 getOptional<bool>(
"requireTls", p.requireTls, j,
true);
9484 JSON_SERIALIZED_CLASS(RallypointQuicSettings)
9494 IMPLEMENT_JSON_SERIALIZATION()
9516 static void to_json(nlohmann::json& j,
const RallypointQuicSettings& p)
9519 TOJSON_IMPL(enabled),
9520 TOJSON_IMPL(listenPort)
9523 static void from_json(
const nlohmann::json& j, RallypointQuicSettings& p)
9526 getOptional<bool>(
"enabled", p.enabled, j,
false);
9527 getOptional<int>(
"listenPort", p.listenPort, j, 7443);
9533 JSON_SERIALIZED_CLASS(RallypointAdvertisingSettings)
9542 IMPLEMENT_JSON_SERIALIZATION()
9573 serviceName =
"_rallypoint._tcp.local.";
9574 interfaceName.clear();
9580 static void to_json(nlohmann::json& j,
const RallypointAdvertisingSettings& p)
9583 TOJSON_IMPL(enabled),
9584 TOJSON_IMPL(hostName),
9585 TOJSON_IMPL(serviceName),
9586 TOJSON_IMPL(interfaceName),
9591 static void from_json(
const nlohmann::json& j, RallypointAdvertisingSettings& p)
9594 getOptional<bool>(
"enabled", p.enabled, j,
false);
9595 getOptional<std::string>(
"hostName", p.hostName, j);
9596 getOptional<std::string>(
"serviceName", p.serviceName, j,
"_rallypoint._tcp.local.");
9597 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
9599 getOptional<int>(
"port", p.port, j, 0);
9600 getOptional<int>(
"ttl", p.ttl, j, 60);
9607 JSON_SERIALIZED_CLASS(NamedIdentity)
9616 IMPLEMENT_JSON_SERIALIZATION()
9634 certificate.clear();
9638 static void to_json(nlohmann::json& j,
const NamedIdentity& p)
9642 TOJSON_IMPL(certificate)
9645 static void from_json(
const nlohmann::json& j, NamedIdentity& p)
9648 getOptional<std::string>(
"name", p.name, j);
9649 getOptional<SecurityCertificate>(
"certificate", p.certificate, j);
9653 JSON_SERIALIZED_CLASS(RallypointExtendedGroupRestriction)
9662 IMPLEMENT_JSON_SERIALIZATION()
9680 restrictions.clear();
9684 static void to_json(nlohmann::json& j,
const RallypointExtendedGroupRestriction& p)
9688 TOJSON_IMPL(restrictions)
9691 static void from_json(
const nlohmann::json& j, RallypointExtendedGroupRestriction& p)
9694 getOptional<std::string>(
"id", p.id, j);
9695 getOptional<std::vector<StringRestrictionList>>(
"restrictions", p.restrictions, j);
9699 JSON_SERIALIZED_CLASS(RtiCloudSettings)
9707 IMPLEMENT_JSON_SERIALIZATION()
9728 enrollmentCode.clear();
9729 serviceBaseUrlPrefix =
"prod.com";
9733 static void to_json(nlohmann::json& j,
const RtiCloudSettings& p)
9736 TOJSON_IMPL(enabled),
9737 TOJSON_IMPL(enrollmentCode),
9738 TOJSON_IMPL(serviceBaseUrlPrefix)
9741 static void from_json(
const nlohmann::json& j, RtiCloudSettings& p)
9744 getOptional<bool>(
"enabled", p.enabled, j,
false);
9745 getOptional<std::string>(
"enrollmentCode", p.enrollmentCode, j);
9746 getOptional<std::string>(
"serviceBaseUrlPrefix", p.serviceBaseUrlPrefix, j,
"prod.com");
9750 JSON_SERIALIZED_CLASS(NsmNodeScripts)
9758 IMPLEMENT_JSON_SERIALIZATION()
9763 std::string beforeGoingActive;
9764 std::string onGoingActive;
9765 std::string beforeActive;
9766 std::string onActive;
9767 std::string inDashboard;
9768 std::string onStatusReport;
9778 beforeGoingActive.clear();
9779 onGoingActive.clear();
9780 beforeActive.clear();
9782 inDashboard.clear();
9783 onStatusReport.clear();
9790 TOJSON_IMPL(onIdle),
9791 TOJSON_IMPL(beforeGoingActive),
9792 TOJSON_IMPL(onGoingActive),
9793 TOJSON_IMPL(beforeActive),
9794 TOJSON_IMPL(onActive),
9795 TOJSON_IMPL(inDashboard),
9796 TOJSON_IMPL(onStatusReport)
9799 static void from_json(
const nlohmann::json& j, NsmNodeScripts& p)
9802 getOptional<std::string>(
"onIdle", p.onIdle, j);
9803 getOptional<std::string>(
"beforeGoingActive", p.beforeGoingActive, j);
9804 getOptional<std::string>(
"onGoingActive", p.onGoingActive, j);
9805 getOptional<std::string>(
"beforeActive", p.beforeActive, j);
9806 getOptional<std::string>(
"onActive", p.onActive, j);
9807 getOptional<std::string>(
"inDashboard", p.inDashboard, j);
9808 getOptional<std::string>(
"onStatusReport", p.onStatusReport, j);
9812 JSON_SERIALIZED_CLASS(NsmNodeLogging)
9820 IMPLEMENT_JSON_SERIALIZATION()
9828 bool logCommandOutput;
9829 bool logResourceStates;
9840 logCommandOutput =
false;
9841 logResourceStates =
false;
9845 static void to_json(nlohmann::json& j,
const NsmNodeLogging& p)
9849 TOJSON_IMPL(dashboard),
9850 TOJSON_IMPL(logCommandOutput),
9851 TOJSON_IMPL(logResourceStates)
9854 static void from_json(
const nlohmann::json& j, NsmNodeLogging& p)
9857 getOptional<int>(
"level", p.level, j, 3);
9858 getOptional<bool>(
"dashboard", p.dashboard, j,
false);
9859 getOptional<bool>(
"logCommandOutput", p.logCommandOutput, j,
false);
9860 getOptional<bool>(
"logResourceStates", p.logResourceStates, j,
false);
9864 JSON_SERIALIZED_CLASS(NsmNodePeriodic)
9872 IMPLEMENT_JSON_SERIALIZATION()
9878 std::string command;
9897 TOJSON_IMPL(intervalSecs),
9898 TOJSON_IMPL(command)
9901 static void from_json(
const nlohmann::json& j, NsmNodePeriodic& p)
9904 getOptional<std::string>(
"id", p.id, j);
9905 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 1);
9906 getOptional<std::string>(
"command", p.command, j);
9910 JSON_SERIALIZED_CLASS(NsmNodeCotLocationPollSettings)
9921 IMPLEMENT_JSON_SERIALIZATION()
9948 static void to_json(nlohmann::json& j,
const NsmNodeCotLocationPollSettings& p)
9951 TOJSON_IMPL(enabled),
9952 TOJSON_IMPL(runCmd),
9953 TOJSON_IMPL(intervalSecs),
9954 TOJSON_IMPL(failClosed)
9957 static void from_json(
const nlohmann::json& j, NsmNodeCotLocationPollSettings& p)
9960 getOptional<bool>(
"enabled", p.enabled, j,
false);
9961 getOptional<std::string>(
"runCmd", p.runCmd, j);
9962 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 10);
9963 getOptional<bool>(
"failClosed", p.failClosed, j,
true);
9967 JSON_SERIALIZED_CLASS(NsmNodeCotSettings)
9975 IMPLEMENT_JSON_SERIALIZATION()
10016 detailJson.clear();
10017 announceWhenIdle =
false;
10018 idleIntervalSecs = 30;
10019 locationPoll.clear();
10023 static void to_json(nlohmann::json& j,
const NsmNodeCotSettings& p)
10025 j = nlohmann::json{
10026 TOJSON_IMPL(useCot),
10035 TOJSON_IMPL(callsign),
10036 TOJSON_IMPL(detailJson),
10037 TOJSON_IMPL(announceWhenIdle),
10038 TOJSON_IMPL(idleIntervalSecs),
10039 TOJSON_IMPL(locationPoll)
10042 static void from_json(
const nlohmann::json& j, NsmNodeCotSettings& p)
10045 getOptional<bool>(
"useCot", p.useCot, j,
false);
10046 getOptional<std::string>(
"uid", p.uid, j);
10047 getOptional<std::string>(
"type", p.type, j);
10048 getOptional<std::string>(
"how", p.how, j);
10049 getOptional<std::string>(
"lat", p.lat, j);
10050 getOptional<std::string>(
"lon", p.lon, j);
10051 getOptional<std::string>(
"ce", p.ce, j);
10052 getOptional<std::string>(
"hae", p.hae, j);
10053 getOptional<std::string>(
"le", p.le, j);
10054 getOptional<std::string>(
"callsign", p.callsign, j);
10055 getOptional<std::string>(
"detailJson", p.detailJson, j);
10056 getOptional<bool>(
"announceWhenIdle", p.announceWhenIdle, j,
false);
10057 getOptional<int>(
"idleIntervalSecs", p.idleIntervalSecs, j, 30);
10058 getOptional<NsmNodeCotLocationPollSettings>(
"locationPoll", p.locationPoll, j);
10062 JSON_SERIALIZED_CLASS(StatusUploadConfiguration)
10076 IMPLEMENT_JSON_SERIALIZATION()
10113 static void to_json(nlohmann::json& j,
const StatusUploadConfiguration& p)
10115 j = nlohmann::json{
10116 TOJSON_IMPL(baseUrl),
10117 TOJSON_IMPL(timeoutSecs),
10118 TOJSON_IMPL(apiKey),
10122 static void from_json(
const nlohmann::json& j, StatusUploadConfiguration& p)
10125 getOptional<std::string>(
"baseUrl", p.baseUrl, j);
10126 getOptional<int>(
"timeoutSecs", p.timeoutSecs, j, 3);
10127 getOptional<std::string>(
"apiKey", p.apiKey, j);
10128 getOptional<Tls>(
"tls", p.tls, j);
10132 JSON_SERIALIZED_CLASS(NsmNodeStatusReportImmediateConfiguration)
10145 IMPLEMENT_JSON_SERIALIZATION()
10166 minIntervalSecs = 3;
10167 onStateChange =
true;
10168 onOwnerChange =
true;
10172 static void to_json(nlohmann::json& j,
const NsmNodeStatusReportImmediateConfiguration& p)
10174 j = nlohmann::json{
10175 TOJSON_IMPL(enabled),
10176 TOJSON_IMPL(minIntervalSecs),
10177 TOJSON_IMPL(onStateChange),
10178 TOJSON_IMPL(onOwnerChange)
10181 static void from_json(
const nlohmann::json& j, NsmNodeStatusReportImmediateConfiguration& p)
10184 getOptional<bool>(
"enabled", p.enabled, j,
false);
10185 getOptional<int>(
"minIntervalSecs", p.minIntervalSecs, j, 3);
10186 getOptional<bool>(
"onStateChange", p.onStateChange, j,
true);
10187 getOptional<bool>(
"onOwnerChange", p.onOwnerChange, j,
true);
10191 JSON_SERIALIZED_CLASS(NsmNodeStatusReportConfiguration)
10203 IMPLEMENT_JSON_SERIALIZATION()
10235 includeResourceDetail =
false;
10241 static void to_json(nlohmann::json& j,
const NsmNodeStatusReportConfiguration& p)
10243 j = nlohmann::json{
10244 TOJSON_IMPL(fileName),
10245 TOJSON_IMPL(intervalSecs),
10246 TOJSON_IMPL(enabled),
10247 TOJSON_IMPL(includeResourceDetail),
10248 TOJSON_IMPL(runCmd),
10249 TOJSON_IMPL(immediate)
10252 static void from_json(
const nlohmann::json& j, NsmNodeStatusReportConfiguration& p)
10255 getOptional<std::string>(
"fileName", p.fileName, j);
10256 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
10257 getOptional<bool>(
"enabled", p.enabled, j,
false);
10258 getOptional<std::string>(
"runCmd", p.runCmd, j);
10259 getOptional<bool>(
"includeResourceDetail", p.includeResourceDetail, j,
false);
10260 getOptional<NsmNodeStatusReportImmediateConfiguration>(
"immediate", p.immediate, j);
10264 JSON_SERIALIZED_CLASS(NsmNodeElectionGateSettings)
10276 IMPLEMENT_JSON_SERIALIZATION()
10303 static void to_json(nlohmann::json& j,
const NsmNodeElectionGateSettings& p)
10305 j = nlohmann::json{
10306 TOJSON_IMPL(enabled),
10307 TOJSON_IMPL(runCmd),
10308 TOJSON_IMPL(intervalSecs),
10309 TOJSON_IMPL(failClosed)
10312 static void from_json(
const nlohmann::json& j, NsmNodeElectionGateSettings& p)
10315 getOptional<bool>(
"enabled", p.enabled, j,
false);
10316 getOptional<std::string>(
"runCmd", p.runCmd, j);
10317 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 2);
10318 getOptional<bool>(
"failClosed", p.failClosed, j,
true);
10322 JSON_SERIALIZED_CLASS(NsmNodeActiveHealthCheckSettings)
10336 IMPLEMENT_JSON_SERIALIZATION()
10363 unhealthyGraceMs = 5000;
10364 releaseCooldownSecs = 30;
10369 static void to_json(nlohmann::json& j,
const NsmNodeActiveHealthCheckSettings& p)
10371 j = nlohmann::json{
10372 TOJSON_IMPL(enabled),
10373 TOJSON_IMPL(runCmd),
10374 TOJSON_IMPL(intervalSecs),
10375 TOJSON_IMPL(unhealthyGraceMs),
10376 TOJSON_IMPL(releaseCooldownSecs),
10377 TOJSON_IMPL(failClosed)
10380 static void from_json(
const nlohmann::json& j, NsmNodeActiveHealthCheckSettings& p)
10383 getOptional<bool>(
"enabled", p.enabled, j,
false);
10384 getOptional<std::string>(
"runCmd", p.runCmd, j);
10385 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 5);
10386 getOptional<int>(
"unhealthyGraceMs", p.unhealthyGraceMs, j, 5000);
10387 getOptional<int>(
"releaseCooldownSecs", p.releaseCooldownSecs, j, 30);
10388 getOptional<bool>(
"failClosed", p.failClosed, j,
true);
10392 JSON_SERIALIZED_CLASS(NsmNode)
10403 IMPLEMENT_JSON_SERIALIZATION()
10404 IMPLEMENT_JSON_DOCUMENTATION(
NsmNode)
10490 fipsCrypto.clear();
10495 multicastInterfaceName.clear();
10496 stateMachine.clear();
10497 defaultPriority = 0;
10499 dashboardToken =
false;
10504 electionGate.clear();
10505 activeHealthCheck.clear();
10506 statusReport.clear();
10507 statusUpload.clear();
10508 configurationCheckSignalName =
"rts.7b392d1.${id}";
10510 featureset.clear();
10514 ipFamily = IpFamilyType_t::ifIp4;
10518 static void to_json(nlohmann::json& j,
const NsmNode& p)
10520 j = nlohmann::json{
10521 TOJSON_IMPL(fipsCrypto),
10522 TOJSON_IMPL(watchdog),
10525 TOJSON_IMPL(domainId),
10526 TOJSON_IMPL(multicastInterfaceName),
10527 TOJSON_IMPL(stateMachine),
10528 TOJSON_IMPL(defaultPriority),
10529 TOJSON_IMPL(fixedToken),
10530 TOJSON_IMPL(dashboardToken),
10531 TOJSON_IMPL(scripts),
10532 TOJSON_IMPL(logging),
10534 TOJSON_IMPL(periodics),
10535 TOJSON_IMPL(electionGate),
10536 TOJSON_IMPL(activeHealthCheck),
10537 TOJSON_IMPL(statusReport),
10538 TOJSON_IMPL(statusUpload),
10539 TOJSON_IMPL(configurationCheckSignalName),
10540 TOJSON_IMPL(featureset),
10541 TOJSON_IMPL(licensing),
10542 TOJSON_IMPL(ipFamily),
10543 TOJSON_IMPL(rxCapture),
10544 TOJSON_IMPL(txCapture),
10545 TOJSON_IMPL(tuning)
10548 static void from_json(
const nlohmann::json& j, NsmNode& p)
10551 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
10552 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
10553 getOptional<std::string>(
"id", p.id, j);
10554 getOptional<std::string>(
"name", p.name, j);
10555 getOptional<std::string>(
"domainId", p.domainId, j);
10557 if(p.domainId.empty())
10559 getOptional<std::string>(
"domainName", p.domainId, j);
10561 getOptional<std::string>(
"multicastInterfaceName", p.multicastInterfaceName, j);
10562 getOptional<NsmConfiguration>(
"stateMachine", p.stateMachine, j);
10563 getOptional<int>(
"defaultPriority", p.defaultPriority, j, 0);
10564 getOptional<int>(
"fixedToken", p.fixedToken, j, -1);
10565 getOptional<bool>(
"dashboardToken", p.dashboardToken, j,
false);
10566 getOptional<NsmNodeScripts>(
"scripts", p.scripts, j);
10567 getOptional<NsmNodeLogging>(
"logging", p.logging, j);
10568 getOptional<NsmNodeCotSettings>(
"cot", p.cot, j);
10569 getOptional<std::vector<NsmNodePeriodic>>(
"periodics", p.periodics, j);
10570 getOptional<NsmNodeElectionGateSettings>(
"electionGate", p.electionGate, j);
10571 getOptional<NsmNodeActiveHealthCheckSettings>(
"activeHealthCheck", p.activeHealthCheck, j);
10572 getOptional<NsmNodeStatusReportConfiguration>(
"statusReport", p.statusReport, j);
10573 getOptional<StatusUploadConfiguration>(
"statusUpload", p.statusUpload, j);
10574 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.7b392d1.${id}");
10575 getOptional<Licensing>(
"licensing", p.licensing, j);
10576 getOptional<Featureset>(
"featureset", p.featureset, j);
10577 getOptional<PacketCapturer>(
"rxCapture", p.rxCapture, j);
10578 getOptional<PacketCapturer>(
"txCapture", p.txCapture, j);
10579 getOptional<TuningSettings>(
"tuning", p.tuning, j);
10580 getOptional<IpFamilyType_t>(
"ipFamily", p.ipFamily, j, IpFamilyType_t::ifIp4);
10587 if (!j.contains(key))
10592 const nlohmann::json &nj = j.at(key);
10593 if (!nj.is_object())
10598 if (nj.contains(
"stateMachine") || nj.contains(
"cot") || nj.contains(
"scripts")
10599 || nj.contains(
"periodics") || nj.contains(
"electionGate") || nj.contains(
"activeHealthCheck")
10600 || nj.contains(
"statusReport") || nj.contains(
"multicastInterfaceName"))
10610 JSON_SERIALIZED_CLASS(NsmSettings)
10629 IMPLEMENT_JSON_SERIALIZATION()
10646 statusReport.clear();
10651 static void to_json(nlohmann::json& j,
const NsmSettings& p)
10653 j = nlohmann::json{
10654 TOJSON_IMPL(statusReport),
10658 static void from_json(
const nlohmann::json& j, NsmSettings& p)
10661 getOptional<NsmNodeStatusReportConfiguration>(
"statusReport", p.statusReport, j);
10662 getOptional<std::vector<NsmNode>>(
"nodes", p.nodes, j);
10669 if(j.contains(
"nsm") && j.at(
"nsm").is_object())
10671 j.at(
"nsm").get_to(nsm);
10676 if(j.contains(
"nsmNodes") && j.at(
"nsmNodes").is_array())
10678 getOptional<std::vector<NsmNode>>(
"nsmNodes", nsm.
nodes, j);
10683 if(j.contains(
"nsmNode") && j.at(
"nsmNode").is_object())
10687 if(!node.
id.empty() || !node.
stateMachine.networking.address.empty())
10689 nsm.
nodes.push_back(node);
10694 JSON_SERIALIZED_CLASS(RallypointServer)
10705 IMPLEMENT_JSON_SERIALIZATION()
10712 sptCertificate = 1,
10713 sptCertPublicKey = 2,
10714 sptCertSubject = 3,
10716 sptCertFingerprint = 5,
10730 } StreamIdPrivacyType_t;
10934 fipsCrypto.clear();
10939 interfaceName.clear();
10940 certificate.clear();
10941 allowMulticastForwarding =
false;
10942 peeringConfiguration.clear();
10943 peeringConfigurationFileName.clear();
10944 peeringConfigurationFileCommand.clear();
10945 peeringConfigurationFileCheckSecs = 60;
10947 statusReport.clear();
10948 statusUpload.clear();
10951 externalHealthCheckResponder.clear();
10952 allowPeerForwarding =
false;
10953 multicastInterfaceName.clear();
10956 forwardDiscoveredGroups =
false;
10957 forwardMulticastAddressing =
false;
10958 isMeshLeaf =
false;
10959 disableMessageSigning =
false;
10960 multicastRestrictions.clear();
10961 igmpSnooping.clear();
10962 staticReflectors.clear();
10963 tcpTxOptions.clear();
10964 multicastTxOptions.clear();
10965 certStoreFileName.clear();
10966 certStorePasswordHex.clear();
10967 groupRestrictions.clear();
10968 configurationCheckSignalName =
"rts.7b392d1.${id}";
10970 featureset.clear();
10971 udpStreaming.clear();
10973 normalTaskQueueBias = 0;
10974 enableLeafReflectionReverseSubscription =
false;
10975 disableLoopDetection =
false;
10976 maxSecurityLevel = 0;
10978 streamStatsExport.clear();
10979 maxOutboundPeerConnectionIntervalDeltaSecs = 15;
10980 peerRtTestIntervalMs = 60000;
10981 peerRtBehaviors.clear();
10985 advertising.clear();
10987 extendedGroupRestrictions.clear();
10988 groupRestrictionAccessPolicyType = GroupRestrictionAccessPolicyType_t::graptPermissive;
10989 ipFamily = IpFamilyType_t::ifIp4;
10992 domainName.clear();
10993 allowedDomains.clear();
10994 blockedDomains.clear();
10995 extraDomains.clear();
10997 additionalIdentities.clear();
10998 streamIdPrivacyType = StreamIdPrivacyType_t::sptDefault;
11002 static void to_json(nlohmann::json& j,
const RallypointServer& p)
11004 j = nlohmann::json{
11005 TOJSON_IMPL(fipsCrypto),
11006 TOJSON_IMPL(watchdog),
11009 TOJSON_IMPL(listenPort),
11010 TOJSON_IMPL(interfaceName),
11011 TOJSON_IMPL(certificate),
11012 TOJSON_IMPL(allowMulticastForwarding),
11014 TOJSON_IMPL(peeringConfigurationFileName),
11015 TOJSON_IMPL(peeringConfigurationFileCommand),
11016 TOJSON_IMPL(peeringConfigurationFileCheckSecs),
11017 TOJSON_IMPL(ioPools),
11018 TOJSON_IMPL(statusReport),
11019 TOJSON_IMPL(statusUpload),
11020 TOJSON_IMPL(limits),
11021 TOJSON_IMPL(linkGraph),
11022 TOJSON_IMPL(externalHealthCheckResponder),
11023 TOJSON_IMPL(allowPeerForwarding),
11024 TOJSON_IMPL(multicastInterfaceName),
11026 TOJSON_IMPL(discovery),
11027 TOJSON_IMPL(forwardDiscoveredGroups),
11028 TOJSON_IMPL(forwardMulticastAddressing),
11029 TOJSON_IMPL(isMeshLeaf),
11030 TOJSON_IMPL(disableMessageSigning),
11031 TOJSON_IMPL(multicastRestrictions),
11032 TOJSON_IMPL(igmpSnooping),
11033 TOJSON_IMPL(staticReflectors),
11034 TOJSON_IMPL(tcpTxOptions),
11035 TOJSON_IMPL(multicastTxOptions),
11036 TOJSON_IMPL(certStoreFileName),
11037 TOJSON_IMPL(certStorePasswordHex),
11038 TOJSON_IMPL(groupRestrictions),
11039 TOJSON_IMPL(configurationCheckSignalName),
11040 TOJSON_IMPL(featureset),
11041 TOJSON_IMPL(licensing),
11042 TOJSON_IMPL(udpStreaming),
11043 TOJSON_IMPL(sysFlags),
11044 TOJSON_IMPL(normalTaskQueueBias),
11045 TOJSON_IMPL(enableLeafReflectionReverseSubscription),
11046 TOJSON_IMPL(disableLoopDetection),
11047 TOJSON_IMPL(maxSecurityLevel),
11048 TOJSON_IMPL(routeMap),
11049 TOJSON_IMPL(streamStatsExport),
11050 TOJSON_IMPL(maxOutboundPeerConnectionIntervalDeltaSecs),
11051 TOJSON_IMPL(peerRtTestIntervalMs),
11052 TOJSON_IMPL(peerRtBehaviors),
11053 TOJSON_IMPL(websocket),
11056 TOJSON_IMPL(advertising),
11057 TOJSON_IMPL(rtiCloud),
11058 TOJSON_IMPL(extendedGroupRestrictions),
11059 TOJSON_IMPL(groupRestrictionAccessPolicyType),
11060 TOJSON_IMPL(ipFamily),
11061 TOJSON_IMPL(rxCapture),
11062 TOJSON_IMPL(txCapture),
11063 TOJSON_IMPL(domainName),
11064 TOJSON_IMPL(allowedDomains),
11065 TOJSON_IMPL(blockedDomains),
11066 TOJSON_IMPL(extraDomains),
11067 TOJSON_IMPL(tuning),
11068 TOJSON_IMPL(additionalIdentities),
11069 TOJSON_IMPL(streamIdPrivacyType)
11072 static void from_json(
const nlohmann::json& j, RallypointServer& p)
11075 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
11076 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
11077 getOptional<std::string>(
"id", p.id, j);
11078 getOptional<std::string>(
"name", p.name, j);
11079 getOptional<SecurityCertificate>(
"certificate", p.certificate, j);
11080 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
11081 getOptional<int>(
"listenPort", p.listenPort, j, 7443);
11082 getOptional<bool>(
"allowMulticastForwarding", p.allowMulticastForwarding, j,
false);
11084 getOptional<std::string>(
"peeringConfigurationFileName", p.peeringConfigurationFileName, j);
11085 getOptional<std::string>(
"peeringConfigurationFileCommand", p.peeringConfigurationFileCommand, j);
11086 getOptional<int>(
"peeringConfigurationFileCheckSecs", p.peeringConfigurationFileCheckSecs, j, 60);
11087 getOptional<int>(
"ioPools", p.ioPools, j, -1);
11088 getOptional<RallypointServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
11089 getOptional<StatusUploadConfiguration>(
"statusUpload", p.statusUpload, j);
11090 getOptional<RallypointServerLimits>(
"limits", p.limits, j);
11091 getOptional<RallypointServerLinkGraph>(
"linkGraph", p.linkGraph, j);
11092 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
11093 getOptional<bool>(
"allowPeerForwarding", p.allowPeerForwarding, j,
false);
11094 getOptional<std::string>(
"multicastInterfaceName", p.multicastInterfaceName, j);
11095 getOptional<Tls>(
"tls", p.tls, j);
11096 getOptional<DiscoveryConfiguration>(
"discovery", p.discovery, j);
11097 getOptional<bool>(
"forwardDiscoveredGroups", p.forwardDiscoveredGroups, j,
false);
11098 getOptional<bool>(
"forwardMulticastAddressing", p.forwardMulticastAddressing, j,
false);
11099 getOptional<bool>(
"isMeshLeaf", p.isMeshLeaf, j,
false);
11100 getOptional<bool>(
"disableMessageSigning", p.disableMessageSigning, j,
false);
11101 getOptional<NetworkAddressRestrictionList>(
"multicastRestrictions", p.multicastRestrictions, j);
11102 getOptional<IgmpSnooping>(
"igmpSnooping", p.igmpSnooping, j);
11103 getOptional<std::vector<RallypointReflector>>(
"staticReflectors", p.staticReflectors, j);
11104 getOptional<TcpNetworkTxOptions>(
"tcpTxOptions", p.tcpTxOptions, j);
11105 getOptional<NetworkTxOptions>(
"multicastTxOptions", p.multicastTxOptions, j);
11106 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
11107 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
11108 getOptional<StringRestrictionList>(
"groupRestrictions", p.groupRestrictions, j);
11109 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.7b392d1.${id}");
11110 getOptional<Licensing>(
"licensing", p.licensing, j);
11111 getOptional<Featureset>(
"featureset", p.featureset, j);
11112 getOptional<RallypointUdpStreaming>(
"udpStreaming", p.udpStreaming, j);
11113 getOptional<uint32_t>(
"sysFlags", p.sysFlags, j, 0);
11114 getOptional<uint32_t>(
"normalTaskQueueBias", p.normalTaskQueueBias, j, 0);
11115 getOptional<bool>(
"enableLeafReflectionReverseSubscription", p.enableLeafReflectionReverseSubscription, j,
false);
11116 getOptional<bool>(
"disableLoopDetection", p.disableLoopDetection, j,
false);
11117 getOptional<uint32_t>(
"maxSecurityLevel", p.maxSecurityLevel, j, 0);
11118 getOptional<RallypointServerRouteMap>(
"routeMap", p.routeMap, j);
11119 getOptional<RallypointServerStreamStatsExport>(
"streamStatsExport", p.streamStatsExport, j);
11120 getOptional<uint32_t>(
"maxOutboundPeerConnectionIntervalDeltaSecs", p.maxOutboundPeerConnectionIntervalDeltaSecs, j, 15);
11121 getOptional<int>(
"peerRtTestIntervalMs", p.peerRtTestIntervalMs, j, 60000);
11122 getOptional<std::vector<RallypointRpRtTimingBehavior>>(
"peerRtBehaviors", p.peerRtBehaviors, j);
11123 getOptional<RallypointWebsocketSettings>(
"websocket", p.websocket, j);
11124 getOptional<RallypointQuicSettings>(
"quic", p.quic, j);
11126 getOptional<RallypointAdvertisingSettings>(
"advertising", p.advertising, j);
11127 getOptional<RtiCloudSettings>(
"rtiCloud", p.rtiCloud, j);
11128 getOptional<std::vector<RallypointExtendedGroupRestriction>>(
"extendedGroupRestrictions", p.extendedGroupRestrictions, j);
11129 getOptional<GroupRestrictionAccessPolicyType_t>(
"groupRestrictionAccessPolicyType", p.groupRestrictionAccessPolicyType, j, GroupRestrictionAccessPolicyType_t::graptPermissive);
11130 getOptional<IpFamilyType_t>(
"ipFamily", p.ipFamily, j, IpFamilyType_t::ifIp4);
11131 getOptional<PacketCapturer>(
"rxCapture", p.rxCapture, j);
11132 getOptional<PacketCapturer>(
"txCapture", p.txCapture, j);
11133 getOptional<std::string>(
"domainName", p.domainName, j);
11134 getOptional<std::vector<std::string>>(
"allowedDomains", p.allowedDomains, j);
11135 getOptional<std::vector<std::string>>(
"blockedDomains", p.blockedDomains, j);
11136 getOptional<std::vector<std::string>>(
"extraDomains", p.extraDomains, j);
11137 getOptional<TuningSettings>(
"tuning", p.tuning, j);
11138 getOptional<std::vector<NamedIdentity>>(
"additionalIdentities", p.additionalIdentities, j);
11139 getOptional<RallypointServer::StreamIdPrivacyType_t>(
"streamIdPrivacyType", p.streamIdPrivacyType, j, RallypointServer::StreamIdPrivacyType_t::sptDefault);
11144 JSON_SERIALIZED_CLASS(PlatformDiscoveredService)
11156 IMPLEMENT_JSON_SERIALIZATION()
11191 configurationVersion = 0;
11195 static void to_json(nlohmann::json& j,
const PlatformDiscoveredService& p)
11197 j = nlohmann::json{
11201 TOJSON_IMPL(address),
11203 TOJSON_IMPL(configurationVersion)
11206 static void from_json(
const nlohmann::json& j, PlatformDiscoveredService& p)
11209 getOptional<std::string>(
"id", p.id, j);
11210 getOptional<std::string>(
"type", p.type, j);
11211 getOptional<std::string>(
"name", p.name, j);
11212 getOptional<NetworkAddress>(
"address", p.address, j);
11213 getOptional<std::string>(
"uri", p.uri, j);
11214 getOptional<uint32_t>(
"configurationVersion", p.configurationVersion, j, 0);
11254 IMPLEMENT_JSON_SERIALIZATION()
11300 mostRecentFirst =
true;
11301 startedOnOrAfter = 0;
11302 endedOnOrBefore = 0;
11305 onlyCommitted =
true;
11307 onlyNodeId.clear();
11313 static void to_json(nlohmann::json& j,
const TimelineQueryParameters& p)
11315 j = nlohmann::json{
11316 TOJSON_IMPL(maxCount),
11317 TOJSON_IMPL(mostRecentFirst),
11318 TOJSON_IMPL(startedOnOrAfter),
11319 TOJSON_IMPL(endedOnOrBefore),
11320 TOJSON_IMPL(onlyDirection),
11321 TOJSON_IMPL(onlyType),
11322 TOJSON_IMPL(onlyCommitted),
11323 TOJSON_IMPL(onlyAlias),
11324 TOJSON_IMPL(onlyNodeId),
11325 TOJSON_IMPL(onlyTxId),
11329 static void from_json(
const nlohmann::json& j, TimelineQueryParameters& p)
11332 getOptional<long>(
"maxCount", p.maxCount, j, 50);
11333 getOptional<bool>(
"mostRecentFirst", p.mostRecentFirst, j,
false);
11334 getOptional<uint64_t>(
"startedOnOrAfter", p.startedOnOrAfter, j, 0);
11335 getOptional<uint64_t>(
"endedOnOrBefore", p.endedOnOrBefore, j, 0);
11336 getOptional<int>(
"onlyDirection", p.onlyDirection, j, 0);
11337 getOptional<int>(
"onlyType", p.onlyType, j, 0);
11338 getOptional<bool>(
"onlyCommitted", p.onlyCommitted, j,
true);
11339 getOptional<std::string>(
"onlyAlias", p.onlyAlias, j, EMPTY_STRING);
11340 getOptional<std::string>(
"onlyNodeId", p.onlyNodeId, j, EMPTY_STRING);
11341 getOptional<int>(
"onlyTxId", p.onlyTxId, j, 0);
11342 getOptional<std::string>(
"sql", p.sql, j, EMPTY_STRING);
11346 JSON_SERIALIZED_CLASS(CertStoreCertificate)
11355 IMPLEMENT_JSON_SERIALIZATION()
11382 certificatePem.clear();
11383 privateKeyPem.clear();
11384 internalData =
nullptr;
11389 static void to_json(nlohmann::json& j,
const CertStoreCertificate& p)
11391 j = nlohmann::json{
11393 TOJSON_IMPL(certificatePem),
11394 TOJSON_IMPL(privateKeyPem),
11398 static void from_json(
const nlohmann::json& j, CertStoreCertificate& p)
11401 j.at(
"id").get_to(p.id);
11402 j.at(
"certificatePem").get_to(p.certificatePem);
11403 getOptional<std::string>(
"privateKeyPem", p.privateKeyPem, j, EMPTY_STRING);
11404 getOptional<std::string>(
"tags", p.tags, j, EMPTY_STRING);
11408 JSON_SERIALIZED_CLASS(CertStore)
11417 IMPLEMENT_JSON_SERIALIZATION()
11418 IMPLEMENT_JSON_DOCUMENTATION(
CertStore)
11438 certificates.clear();
11443 static void to_json(nlohmann::json& j,
const CertStore& p)
11445 j = nlohmann::json{
11447 TOJSON_IMPL(certificates),
11451 static void from_json(
const nlohmann::json& j, CertStore& p)
11454 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
11455 getOptional<std::vector<CertStoreCertificate>>(
"certificates", p.certificates, j);
11456 getOptional<std::vector<KvPair>>(
"kvp", p.kvp, j);
11460 JSON_SERIALIZED_CLASS(CertStoreCertificateElement)
11469 IMPLEMENT_JSON_SERIALIZATION()
11493 hasPrivateKey =
false;
11498 static void to_json(nlohmann::json& j,
const CertStoreCertificateElement& p)
11500 j = nlohmann::json{
11502 TOJSON_IMPL(hasPrivateKey),
11506 if(!p.certificatePem.empty())
11508 j[
"certificatePem"] = p.certificatePem;
11511 static void from_json(
const nlohmann::json& j, CertStoreCertificateElement& p)
11514 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
11515 getOptional<bool>(
"hasPrivateKey", p.hasPrivateKey, j,
false);
11516 getOptional<std::string>(
"certificatePem", p.certificatePem, j, EMPTY_STRING);
11517 getOptional<std::string>(
"tags", p.tags, j, EMPTY_STRING);
11521 JSON_SERIALIZED_CLASS(CertStoreDescriptor)
11530 IMPLEMENT_JSON_SERIALIZATION()
11563 certificates.clear();
11568 static void to_json(nlohmann::json& j,
const CertStoreDescriptor& p)
11570 j = nlohmann::json{
11572 TOJSON_IMPL(fileName),
11573 TOJSON_IMPL(version),
11574 TOJSON_IMPL(flags),
11575 TOJSON_IMPL(certificates),
11579 static void from_json(
const nlohmann::json& j, CertStoreDescriptor& p)
11582 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
11583 getOptional<std::string>(
"fileName", p.fileName, j, EMPTY_STRING);
11584 getOptional<int>(
"version", p.version, j, 0);
11585 getOptional<int>(
"flags", p.flags, j, 0);
11586 getOptional<std::vector<CertStoreCertificateElement>>(
"certificates", p.certificates, j);
11587 getOptional<std::vector<KvPair>>(
"kvp", p.kvp, j);
11591 JSON_SERIALIZED_CLASS(CertificateSubjectElement)
11600 IMPLEMENT_JSON_SERIALIZATION()
11622 static void to_json(nlohmann::json& j,
const CertificateSubjectElement& p)
11624 j = nlohmann::json{
11629 static void from_json(
const nlohmann::json& j, CertificateSubjectElement& p)
11632 getOptional<std::string>(
"name", p.name, j, EMPTY_STRING);
11633 getOptional<std::string>(
"value", p.value, j, EMPTY_STRING);
11638 JSON_SERIALIZED_CLASS(CertificateDescriptor)
11647 IMPLEMENT_JSON_SERIALIZATION()
11696 selfSigned =
false;
11701 fingerprint.clear();
11702 subjectElements.clear();
11703 issuerElements.clear();
11704 certificatePem.clear();
11705 publicKeyPem.clear();
11709 static void to_json(nlohmann::json& j,
const CertificateDescriptor& p)
11711 j = nlohmann::json{
11712 TOJSON_IMPL(subject),
11713 TOJSON_IMPL(issuer),
11714 TOJSON_IMPL(selfSigned),
11715 TOJSON_IMPL(version),
11716 TOJSON_IMPL(notBefore),
11717 TOJSON_IMPL(notAfter),
11718 TOJSON_IMPL(serial),
11719 TOJSON_IMPL(fingerprint),
11720 TOJSON_IMPL(subjectElements),
11721 TOJSON_IMPL(issuerElements),
11722 TOJSON_IMPL(certificatePem),
11723 TOJSON_IMPL(publicKeyPem)
11726 static void from_json(
const nlohmann::json& j, CertificateDescriptor& p)
11729 getOptional<std::string>(
"subject", p.subject, j, EMPTY_STRING);
11730 getOptional<std::string>(
"issuer", p.issuer, j, EMPTY_STRING);
11731 getOptional<bool>(
"selfSigned", p.selfSigned, j,
false);
11732 getOptional<int>(
"version", p.version, j, 0);
11733 getOptional<std::string>(
"notBefore", p.notBefore, j, EMPTY_STRING);
11734 getOptional<std::string>(
"notAfter", p.notAfter, j, EMPTY_STRING);
11735 getOptional<std::string>(
"serial", p.serial, j, EMPTY_STRING);
11736 getOptional<std::string>(
"fingerprint", p.fingerprint, j, EMPTY_STRING);
11737 getOptional<std::string>(
"certificatePem", p.certificatePem, j, EMPTY_STRING);
11738 getOptional<std::string>(
"publicKeyPem", p.publicKeyPem, j, EMPTY_STRING);
11739 getOptional<std::vector<CertificateSubjectElement>>(
"subjectElements", p.subjectElements, j);
11740 getOptional<std::vector<CertificateSubjectElement>>(
"issuerElements", p.issuerElements, j);
11745 JSON_SERIALIZED_CLASS(RiffDescriptor)
11757 IMPLEMENT_JSON_SERIALIZATION()
11798 certDescriptor.clear();
11803 static void to_json(nlohmann::json& j,
const RiffDescriptor& p)
11805 j = nlohmann::json{
11807 TOJSON_IMPL(verified),
11808 TOJSON_IMPL(channels),
11809 TOJSON_IMPL(sampleCount),
11811 TOJSON_IMPL(certPem),
11812 TOJSON_IMPL(certDescriptor),
11813 TOJSON_IMPL(signature)
11817 static void from_json(
const nlohmann::json& j, RiffDescriptor& p)
11820 FROMJSON_IMPL(file, std::string, EMPTY_STRING);
11821 FROMJSON_IMPL(verified,
bool,
false);
11822 FROMJSON_IMPL(channels,
int, 0);
11823 FROMJSON_IMPL(sampleCount,
int, 0);
11824 FROMJSON_IMPL(meta, std::string, EMPTY_STRING);
11825 FROMJSON_IMPL(certPem, std::string, EMPTY_STRING);
11826 getOptional<CertificateDescriptor>(
"certDescriptor", p.certDescriptor, j);
11827 FROMJSON_IMPL(signature, std::string, EMPTY_STRING);
11832 JSON_SERIALIZED_CLASS(BridgeCreationDetail)
11841 IMPLEMENT_JSON_SERIALIZATION()
11859 csAlreadyExists = -3,
11862 csInvalidConfiguration = -4,
11865 csInvalidJson = -5,
11868 csInsufficientGroups = -6,
11871 csTooManyGroups = -7,
11874 csDuplicateGroup = -8,
11877 csLocalLoopDetected = -9,
11878 } CreationStatus_t;
11894 status = csUndefined;
11898 static void to_json(nlohmann::json& j,
const BridgeCreationDetail& p)
11900 j = nlohmann::json{
11902 TOJSON_IMPL(status)
11905 static void from_json(
const nlohmann::json& j, BridgeCreationDetail& p)
11908 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
11909 getOptional<BridgeCreationDetail::CreationStatus_t>(
"status", p.status, j, BridgeCreationDetail::CreationStatus_t::csUndefined);
11912 JSON_SERIALIZED_CLASS(GroupConnectionDetail)
11921 IMPLEMENT_JSON_SERIALIZATION()
11933 ctDirectDatagram = 1,
11937 } ConnectionType_t;
11962 connectionType = ctUndefined;
11964 asFailover =
false;
11969 static void to_json(nlohmann::json& j,
const GroupConnectionDetail& p)
11971 j = nlohmann::json{
11973 TOJSON_IMPL(connectionType),
11975 TOJSON_IMPL(asFailover),
11976 TOJSON_IMPL(reason)
11981 j[
"asFailover"] = p.asFailover;
11984 static void from_json(
const nlohmann::json& j, GroupConnectionDetail& p)
11987 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
11988 getOptional<GroupConnectionDetail::ConnectionType_t>(
"connectionType", p.connectionType, j, GroupConnectionDetail::ConnectionType_t::ctUndefined);
11989 getOptional<std::string>(
"peer", p.peer, j, EMPTY_STRING);
11990 getOptional<bool>(
"asFailover", p.asFailover, j,
false);
11991 getOptional<std::string>(
"reason", p.reason, j, EMPTY_STRING);
11995 JSON_SERIALIZED_CLASS(GroupTxDetail)
12004 IMPLEMENT_JSON_SERIALIZATION()
12022 txsNotAnAudioGroup = -1,
12028 txsNotConnected = -3,
12031 txsAlreadyTransmitting = -4,
12034 txsInvalidParams = -5,
12037 txsPriorityTooLow = -6,
12040 txsRxActiveOnNonFdx = -7,
12043 txsCannotSubscribeToInput = -8,
12049 txsTxEndedWithFailure = -10,
12052 txsBridgedButNotMultistream = -11,
12055 txsAutoEndedDueToNonMultistreamBridge = -12,
12058 txsReBeginWithoutPriorBegin = -13
12087 status = txsUndefined;
12089 remotePriority = 0;
12090 nonFdxMsHangRemaining = 0;
12095 static void to_json(nlohmann::json& j,
const GroupTxDetail& p)
12097 j = nlohmann::json{
12099 TOJSON_IMPL(status),
12100 TOJSON_IMPL(localPriority),
12105 if(p.status == GroupTxDetail::TxStatus_t::txsPriorityTooLow)
12107 j[
"remotePriority"] = p.remotePriority;
12109 else if(p.status == GroupTxDetail::TxStatus_t::txsRxActiveOnNonFdx)
12111 j[
"nonFdxMsHangRemaining"] = p.nonFdxMsHangRemaining;
12114 static void from_json(
const nlohmann::json& j, GroupTxDetail& p)
12117 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
12118 getOptional<GroupTxDetail::TxStatus_t>(
"status", p.status, j, GroupTxDetail::TxStatus_t::txsUndefined);
12119 getOptional<int>(
"localPriority", p.localPriority, j, 0);
12120 getOptional<int>(
"remotePriority", p.remotePriority, j, 0);
12121 getOptional<long>(
"nonFdxMsHangRemaining", p.nonFdxMsHangRemaining, j, 0);
12122 getOptional<uint32_t>(
"txId", p.txId, j, 0);
12126 JSON_SERIALIZED_CLASS(GroupCreationDetail)
12135 IMPLEMENT_JSON_SERIALIZATION()
12153 csConflictingRpListAndCluster = -2,
12156 csAlreadyExists = -3,
12159 csInvalidConfiguration = -4,
12162 csInvalidJson = -5,
12165 csCryptoFailure = -6,
12168 csAudioInputFailure = -7,
12171 csAudioOutputFailure = -8,
12174 csUnsupportedAudioEncoder = -9,
12180 csInvalidTransport = -11,
12183 csAudioInputDeviceNotFound = -12,
12186 csAudioOutputDeviceNotFound = -13
12187 } CreationStatus_t;
12203 status = csUndefined;
12207 static void to_json(nlohmann::json& j,
const GroupCreationDetail& p)
12209 j = nlohmann::json{
12211 TOJSON_IMPL(status)
12214 static void from_json(
const nlohmann::json& j, GroupCreationDetail& p)
12217 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
12218 getOptional<GroupCreationDetail::CreationStatus_t>(
"status", p.status, j, GroupCreationDetail::CreationStatus_t::csUndefined);
12223 JSON_SERIALIZED_CLASS(GroupReconfigurationDetail)
12232 IMPLEMENT_JSON_SERIALIZATION()
12250 rsInvalidConfiguration = -2,
12253 rsInvalidJson = -3,
12256 rsAudioInputFailure = -4,
12259 rsAudioOutputFailure = -5,
12262 rsDoesNotExist = -6,
12265 rsAudioInputInUse = -7,
12268 rsAudioDisabledForGroup = -8,
12271 rsGroupIsNotAudio = -9
12272 } ReconfigurationStatus_t;
12288 status = rsUndefined;
12292 static void to_json(nlohmann::json& j,
const GroupReconfigurationDetail& p)
12294 j = nlohmann::json{
12296 TOJSON_IMPL(status)
12299 static void from_json(
const nlohmann::json& j, GroupReconfigurationDetail& p)
12302 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
12303 getOptional<GroupReconfigurationDetail::ReconfigurationStatus_t>(
"status", p.status, j, GroupReconfigurationDetail::ReconfigurationStatus_t::rsUndefined);
12308 JSON_SERIALIZED_CLASS(GroupHealthReport)
12317 IMPLEMENT_JSON_SERIALIZATION()
12323 uint64_t lastErrorTs;
12324 uint64_t decryptionErrors;
12325 uint64_t encryptionErrors;
12326 uint64_t unsupportDecoderErrors;
12327 uint64_t decoderFailures;
12328 uint64_t decoderStartFailures;
12329 uint64_t inboundRtpPacketAllocationFailures;
12330 uint64_t inboundRtpPacketLoadFailures;
12331 uint64_t latePacketsDiscarded;
12332 uint64_t jitterBufferInsertionFailures;
12333 uint64_t presenceDeserializationFailures;
12334 uint64_t notRtpErrors;
12335 uint64_t generalErrors;
12336 uint64_t inboundRtpProcessorAllocationFailures;
12347 decryptionErrors = 0;
12348 encryptionErrors = 0;
12349 unsupportDecoderErrors = 0;
12350 decoderFailures = 0;
12351 decoderStartFailures = 0;
12352 inboundRtpPacketAllocationFailures = 0;
12353 inboundRtpPacketLoadFailures = 0;
12354 latePacketsDiscarded = 0;
12355 jitterBufferInsertionFailures = 0;
12356 presenceDeserializationFailures = 0;
12359 inboundRtpProcessorAllocationFailures = 0;
12365 j = nlohmann::json{
12367 TOJSON_IMPL(lastErrorTs),
12368 TOJSON_IMPL(decryptionErrors),
12369 TOJSON_IMPL(encryptionErrors),
12370 TOJSON_IMPL(unsupportDecoderErrors),
12371 TOJSON_IMPL(decoderFailures),
12372 TOJSON_IMPL(decoderStartFailures),
12373 TOJSON_IMPL(inboundRtpPacketAllocationFailures),
12374 TOJSON_IMPL(inboundRtpPacketLoadFailures),
12375 TOJSON_IMPL(latePacketsDiscarded),
12376 TOJSON_IMPL(jitterBufferInsertionFailures),
12377 TOJSON_IMPL(presenceDeserializationFailures),
12378 TOJSON_IMPL(notRtpErrors),
12379 TOJSON_IMPL(generalErrors),
12380 TOJSON_IMPL(inboundRtpProcessorAllocationFailures)
12383 static void from_json(
const nlohmann::json& j, GroupHealthReport& p)
12386 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
12387 getOptional<uint64_t>(
"lastErrorTs", p.lastErrorTs, j, 0);
12388 getOptional<uint64_t>(
"decryptionErrors", p.decryptionErrors, j, 0);
12389 getOptional<uint64_t>(
"encryptionErrors", p.encryptionErrors, j, 0);
12390 getOptional<uint64_t>(
"unsupportDecoderErrors", p.unsupportDecoderErrors, j, 0);
12391 getOptional<uint64_t>(
"decoderFailures", p.decoderFailures, j, 0);
12392 getOptional<uint64_t>(
"decoderStartFailures", p.decoderStartFailures, j, 0);
12393 getOptional<uint64_t>(
"inboundRtpPacketAllocationFailures", p.inboundRtpPacketAllocationFailures, j, 0);
12394 getOptional<uint64_t>(
"inboundRtpPacketLoadFailures", p.inboundRtpPacketLoadFailures, j, 0);
12395 getOptional<uint64_t>(
"latePacketsDiscarded", p.latePacketsDiscarded, j, 0);
12396 getOptional<uint64_t>(
"jitterBufferInsertionFailures", p.jitterBufferInsertionFailures, j, 0);
12397 getOptional<uint64_t>(
"presenceDeserializationFailures", p.presenceDeserializationFailures, j, 0);
12398 getOptional<uint64_t>(
"notRtpErrors", p.notRtpErrors, j, 0);
12399 getOptional<uint64_t>(
"generalErrors", p.generalErrors, j, 0);
12400 getOptional<uint64_t>(
"inboundRtpProcessorAllocationFailures", p.inboundRtpProcessorAllocationFailures, j, 0);
12404 JSON_SERIALIZED_CLASS(InboundProcessorStats)
12413 IMPLEMENT_JSON_SERIALIZATION()
12420 uint64_t minRtpSamplesInQueue;
12421 uint64_t maxRtpSamplesInQueue;
12422 uint64_t totalSamplesTrimmed;
12423 uint64_t underruns;
12425 uint64_t samplesInQueue;
12426 uint64_t totalPacketsReceived;
12427 uint64_t totalPacketsLost;
12428 uint64_t totalPacketsDiscarded;
12439 minRtpSamplesInQueue = 0;
12440 maxRtpSamplesInQueue = 0;
12441 totalSamplesTrimmed = 0;
12444 samplesInQueue = 0;
12445 totalPacketsReceived = 0;
12446 totalPacketsLost = 0;
12447 totalPacketsDiscarded = 0;
12453 j = nlohmann::json{
12455 TOJSON_IMPL(jitter),
12456 TOJSON_IMPL(minRtpSamplesInQueue),
12457 TOJSON_IMPL(maxRtpSamplesInQueue),
12458 TOJSON_IMPL(totalSamplesTrimmed),
12459 TOJSON_IMPL(underruns),
12460 TOJSON_IMPL(overruns),
12461 TOJSON_IMPL(samplesInQueue),
12462 TOJSON_IMPL(totalPacketsReceived),
12463 TOJSON_IMPL(totalPacketsLost),
12464 TOJSON_IMPL(totalPacketsDiscarded)
12467 static void from_json(
const nlohmann::json& j, InboundProcessorStats& p)
12470 getOptional<uint32_t>(
"ssrc", p.ssrc, j, 0);
12471 getOptional<double>(
"jitter", p.jitter, j, 0.0);
12472 getOptional<uint64_t>(
"minRtpSamplesInQueue", p.minRtpSamplesInQueue, j, 0);
12473 getOptional<uint64_t>(
"maxRtpSamplesInQueue", p.maxRtpSamplesInQueue, j, 0);
12474 getOptional<uint64_t>(
"totalSamplesTrimmed", p.totalSamplesTrimmed, j, 0);
12475 getOptional<uint64_t>(
"underruns", p.underruns, j, 0);
12476 getOptional<uint64_t>(
"overruns", p.overruns, j, 0);
12477 getOptional<uint64_t>(
"samplesInQueue", p.samplesInQueue, j, 0);
12478 getOptional<uint64_t>(
"totalPacketsReceived", p.totalPacketsReceived, j, 0);
12479 getOptional<uint64_t>(
"totalPacketsLost", p.totalPacketsLost, j, 0);
12480 getOptional<uint64_t>(
"totalPacketsDiscarded", p.totalPacketsDiscarded, j, 0);
12484 JSON_SERIALIZED_CLASS(TrafficCounter)
12493 IMPLEMENT_JSON_SERIALIZATION()
12517 j = nlohmann::json{
12518 TOJSON_IMPL(packets),
12519 TOJSON_IMPL(bytes),
12520 TOJSON_IMPL(errors)
12523 static void from_json(
const nlohmann::json& j, TrafficCounter& p)
12526 getOptional<uint64_t>(
"packets", p.packets, j, 0);
12527 getOptional<uint64_t>(
"bytes", p.bytes, j, 0);
12528 getOptional<uint64_t>(
"errors", p.errors, j, 0);
12532 JSON_SERIALIZED_CLASS(GroupStats)
12541 IMPLEMENT_JSON_SERIALIZATION()
12542 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(
GroupStats)
12565 static void to_json(nlohmann::json& j,
const GroupStats& p)
12567 j = nlohmann::json{
12570 TOJSON_IMPL(rxTraffic),
12571 TOJSON_IMPL(txTraffic)
12574 static void from_json(
const nlohmann::json& j, GroupStats& p)
12577 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
12579 getOptional<TrafficCounter>(
"rxTraffic", p.rxTraffic, j);
12580 getOptional<TrafficCounter>(
"txTraffic", p.txTraffic, j);
12584 JSON_SERIALIZED_CLASS(RallypointConnectionDetail)
12593 IMPLEMENT_JSON_SERIALIZATION()
12620 internalId.clear();
12623 msToNextConnectionAttempt = 0;
12624 serverProcessingMs = -1.0f;
12628 static void to_json(nlohmann::json& j,
const RallypointConnectionDetail& p)
12630 j = nlohmann::json{
12631 TOJSON_IMPL(internalId),
12636 if(p.msToNextConnectionAttempt > 0)
12638 j[
"msToNextConnectionAttempt"] = p.msToNextConnectionAttempt;
12641 if(p.serverProcessingMs >= 0.0)
12643 j[
"serverProcessingMs"] = p.serverProcessingMs;
12646 static void from_json(
const nlohmann::json& j, RallypointConnectionDetail& p)
12649 getOptional<std::string>(
"internalId", p.internalId, j, EMPTY_STRING);
12650 getOptional<std::string>(
"host", p.host, j, EMPTY_STRING);
12651 getOptional<int>(
"port", p.port, j, 0);
12652 getOptional<uint64_t>(
"msToNextConnectionAttempt", p.msToNextConnectionAttempt, j, 0);
12653 getOptional<float>(
"serverProcessingMs", p.serverProcessingMs, j, -1.0);
12657 JSON_SERIALIZED_CLASS(TranslationSession)
12669 IMPLEMENT_JSON_SERIALIZATION()
12699 static void to_json(nlohmann::json& j,
const TranslationSession& p)
12701 j = nlohmann::json{
12704 TOJSON_IMPL(groups),
12705 TOJSON_IMPL(enabled)
12708 static void from_json(
const nlohmann::json& j, TranslationSession& p)
12711 FROMJSON_IMPL(
id, std::string, EMPTY_STRING);
12712 FROMJSON_IMPL(name, std::string, EMPTY_STRING);
12713 getOptional<std::vector<std::string>>(
"groups", p.groups, j);
12714 FROMJSON_IMPL(enabled,
bool,
true);
12718 JSON_SERIALIZED_CLASS(TranslationConfiguration)
12730 IMPLEMENT_JSON_SERIALIZATION()
12752 static void to_json(nlohmann::json& j,
const TranslationConfiguration& p)
12754 j = nlohmann::json{
12755 TOJSON_IMPL(sessions),
12756 TOJSON_IMPL(groups)
12759 static void from_json(
const nlohmann::json& j, TranslationConfiguration& p)
12762 getOptional<std::vector<TranslationSession>>(
"sessions", p.sessions, j);
12763 getOptional<std::vector<Group>>(
"groups", p.groups, j);
12767 JSON_SERIALIZED_CLASS(LingoServerStatusReportConfiguration)
12779 IMPLEMENT_JSON_SERIALIZATION()
12814 includeGroupDetail =
false;
12815 includeSessionDetail =
false;
12816 includeSessionGroupDetail =
false;
12821 static void to_json(nlohmann::json& j,
const LingoServerStatusReportConfiguration& p)
12823 j = nlohmann::json{
12824 TOJSON_IMPL(fileName),
12825 TOJSON_IMPL(intervalSecs),
12826 TOJSON_IMPL(enabled),
12827 TOJSON_IMPL(includeGroupDetail),
12828 TOJSON_IMPL(includeSessionDetail),
12829 TOJSON_IMPL(includeSessionGroupDetail),
12830 TOJSON_IMPL(runCmd)
12833 static void from_json(
const nlohmann::json& j, LingoServerStatusReportConfiguration& p)
12836 getOptional<std::string>(
"fileName", p.fileName, j);
12837 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
12838 getOptional<bool>(
"enabled", p.enabled, j,
false);
12839 getOptional<std::string>(
"runCmd", p.runCmd, j);
12840 getOptional<bool>(
"includeGroupDetail", p.includeGroupDetail, j,
false);
12841 getOptional<bool>(
"includeSessionDetail", p.includeSessionDetail, j,
false);
12842 getOptional<bool>(
"includeSessionGroupDetail", p.includeSessionGroupDetail, j,
false);
12846 JSON_SERIALIZED_CLASS(LingoServerInternals)
12860 IMPLEMENT_JSON_SERIALIZATION()
12882 housekeeperIntervalMs = 1000;
12886 static void to_json(nlohmann::json& j,
const LingoServerInternals& p)
12888 j = nlohmann::json{
12889 TOJSON_IMPL(watchdog),
12890 TOJSON_IMPL(housekeeperIntervalMs),
12891 TOJSON_IMPL(tuning)
12894 static void from_json(
const nlohmann::json& j, LingoServerInternals& p)
12897 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
12898 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
12899 getOptional<TuningSettings>(
"tuning", p.tuning, j);
12903 JSON_SERIALIZED_CLASS(LingoServerConfiguration)
12914 IMPLEMENT_JSON_SERIALIZATION()
12971 serviceConfigurationFileCheckSecs = 60;
12972 lingoConfigurationFileName.clear();
12973 lingoConfigurationFileCommand.clear();
12974 lingoConfigurationFileCheckSecs = 60;
12975 statusReport.clear();
12976 externalHealthCheckResponder.clear();
12978 certStoreFileName.clear();
12979 certStorePasswordHex.clear();
12980 enginePolicy.clear();
12981 configurationCheckSignalName =
"rts.22f4ec3.${id}";
12982 fipsCrypto.clear();
12988 static void to_json(nlohmann::json& j,
const LingoServerConfiguration& p)
12990 j = nlohmann::json{
12992 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
12993 TOJSON_IMPL(lingoConfigurationFileName),
12994 TOJSON_IMPL(lingoConfigurationFileCommand),
12995 TOJSON_IMPL(lingoConfigurationFileCheckSecs),
12996 TOJSON_IMPL(statusReport),
12997 TOJSON_IMPL(externalHealthCheckResponder),
12998 TOJSON_IMPL(internals),
12999 TOJSON_IMPL(certStoreFileName),
13000 TOJSON_IMPL(certStorePasswordHex),
13001 TOJSON_IMPL(enginePolicy),
13002 TOJSON_IMPL(configurationCheckSignalName),
13003 TOJSON_IMPL(fipsCrypto),
13004 TOJSON_IMPL(proxy),
13008 static void from_json(
const nlohmann::json& j, LingoServerConfiguration& p)
13011 getOptional<std::string>(
"id", p.id, j);
13012 getOptional<int>(
"serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
13013 getOptional<std::string>(
"lingoConfigurationFileName", p.lingoConfigurationFileName, j);
13014 getOptional<std::string>(
"lingoConfigurationFileCommand", p.lingoConfigurationFileCommand, j);
13015 getOptional<int>(
"lingoConfigurationFileCheckSecs", p.lingoConfigurationFileCheckSecs, j, 60);
13016 getOptional<LingoServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
13017 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
13018 getOptional<LingoServerInternals>(
"internals", p.internals, j);
13019 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
13020 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
13021 j.at(
"enginePolicy").get_to(p.enginePolicy);
13022 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.22f4ec3.${id}");
13023 getOptional<FipsCryptoSettings>(
"fipsCrypo", p.fipsCrypto, j);
13024 getOptional<NetworkAddress>(
"proxy", p.proxy, j);
13030 JSON_SERIALIZED_CLASS(VoiceToVoiceSession)
13042 IMPLEMENT_JSON_SERIALIZATION()
13072 static void to_json(nlohmann::json& j,
const VoiceToVoiceSession& p)
13074 j = nlohmann::json{
13077 TOJSON_IMPL(groups),
13078 TOJSON_IMPL(enabled)
13081 static void from_json(
const nlohmann::json& j, VoiceToVoiceSession& p)
13084 FROMJSON_IMPL(
id, std::string, EMPTY_STRING);
13085 FROMJSON_IMPL(name, std::string, EMPTY_STRING);
13086 getOptional<std::vector<std::string>>(
"groups", p.groups, j);
13087 FROMJSON_IMPL(enabled,
bool,
true);
13091 JSON_SERIALIZED_CLASS(LingoConfiguration)
13103 IMPLEMENT_JSON_SERIALIZATION()
13120 voiceToVoiceSessions.clear();
13125 static void to_json(nlohmann::json& j,
const LingoConfiguration& p)
13127 j = nlohmann::json{
13128 TOJSON_IMPL(voiceToVoiceSessions),
13129 TOJSON_IMPL(groups)
13132 static void from_json(
const nlohmann::json& j, LingoConfiguration& p)
13135 getOptional<std::vector<VoiceToVoiceSession>>(
"voiceToVoiceSessions", p.voiceToVoiceSessions, j);
13136 getOptional<std::vector<Group>>(
"groups", p.groups, j);
13140 JSON_SERIALIZED_CLASS(BridgingConfiguration)
13152 IMPLEMENT_JSON_SERIALIZATION()
13174 static void to_json(nlohmann::json& j,
const BridgingConfiguration& p)
13176 j = nlohmann::json{
13177 TOJSON_IMPL(bridges),
13178 TOJSON_IMPL(groups)
13181 static void from_json(
const nlohmann::json& j, BridgingConfiguration& p)
13184 getOptional<std::vector<Bridge>>(
"bridges", p.bridges, j);
13185 getOptional<std::vector<Group>>(
"groups", p.groups, j);
13189 JSON_SERIALIZED_CLASS(BridgingServerStatusReportConfiguration)
13201 IMPLEMENT_JSON_SERIALIZATION()
13236 includeGroupDetail =
false;
13237 includeBridgeDetail =
false;
13238 includeBridgeGroupDetail =
false;
13243 static void to_json(nlohmann::json& j,
const BridgingServerStatusReportConfiguration& p)
13245 j = nlohmann::json{
13246 TOJSON_IMPL(fileName),
13247 TOJSON_IMPL(intervalSecs),
13248 TOJSON_IMPL(enabled),
13249 TOJSON_IMPL(includeGroupDetail),
13250 TOJSON_IMPL(includeBridgeDetail),
13251 TOJSON_IMPL(includeBridgeGroupDetail),
13252 TOJSON_IMPL(runCmd)
13255 static void from_json(
const nlohmann::json& j, BridgingServerStatusReportConfiguration& p)
13258 getOptional<std::string>(
"fileName", p.fileName, j);
13259 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
13260 getOptional<bool>(
"enabled", p.enabled, j,
false);
13261 getOptional<std::string>(
"runCmd", p.runCmd, j);
13262 getOptional<bool>(
"includeGroupDetail", p.includeGroupDetail, j,
false);
13263 getOptional<bool>(
"includeBridgeDetail", p.includeBridgeDetail, j,
false);
13264 getOptional<bool>(
"includeBridgeGroupDetail", p.includeBridgeGroupDetail, j,
false);
13268 JSON_SERIALIZED_CLASS(BridgingServerInternals)
13282 IMPLEMENT_JSON_SERIALIZATION()
13312 housekeeperIntervalMs = 1000;
13313 nsmUnhealthyBridgeGraceMs = 5000;
13314 nsmResourceReleaseCooldownMs = 30000;
13318 static void to_json(nlohmann::json& j,
const BridgingServerInternals& p)
13320 j = nlohmann::json{
13321 TOJSON_IMPL(watchdog),
13322 TOJSON_IMPL(housekeeperIntervalMs),
13323 TOJSON_IMPL(nsmUnhealthyBridgeGraceMs),
13324 TOJSON_IMPL(nsmResourceReleaseCooldownMs),
13325 TOJSON_IMPL(tuning)
13328 static void from_json(
const nlohmann::json& j, BridgingServerInternals& p)
13331 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
13332 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
13333 getOptional<int>(
"nsmUnhealthyBridgeGraceMs", p.nsmUnhealthyBridgeGraceMs, j, 5000);
13334 getOptional<int>(
"nsmResourceReleaseCooldownMs", p.nsmResourceReleaseCooldownMs, j, 30000);
13335 getOptional<TuningSettings>(
"tuning", p.tuning, j);
13339 JSON_SERIALIZED_CLASS(BridgingServerConfiguration)
13350 IMPLEMENT_JSON_SERIALIZATION()
13374 omADictatedByGroup = 3,
13438 serviceConfigurationFileCheckSecs = 60;
13439 bridgingConfigurationFileName.clear();
13440 bridgingConfigurationFileCommand.clear();
13441 bridgingConfigurationFileCheckSecs = 60;
13442 statusReport.clear();
13443 externalHealthCheckResponder.clear();
13445 certStoreFileName.clear();
13446 certStorePasswordHex.clear();
13447 enginePolicy.clear();
13448 configurationCheckSignalName =
"rts.6cc0651.${id}";
13449 fipsCrypto.clear();
13450 statusUpload.clear();
13456 static void to_json(nlohmann::json& j,
const BridgingServerConfiguration& p)
13458 j = nlohmann::json{
13461 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
13462 TOJSON_IMPL(bridgingConfigurationFileName),
13463 TOJSON_IMPL(bridgingConfigurationFileCommand),
13464 TOJSON_IMPL(bridgingConfigurationFileCheckSecs),
13465 TOJSON_IMPL(statusReport),
13466 TOJSON_IMPL(externalHealthCheckResponder),
13467 TOJSON_IMPL(internals),
13468 TOJSON_IMPL(certStoreFileName),
13469 TOJSON_IMPL(certStorePasswordHex),
13470 TOJSON_IMPL(enginePolicy),
13471 TOJSON_IMPL(configurationCheckSignalName),
13472 TOJSON_IMPL(fipsCrypto),
13473 TOJSON_IMPL(statusUpload),
13475 TOJSON_IMPL(rtiCloud)
13478 static void from_json(
const nlohmann::json& j, BridgingServerConfiguration& p)
13481 getOptional<std::string>(
"id", p.id, j);
13482 getOptional<BridgingServerConfiguration::OpMode_t>(
"mode", p.mode, j, BridgingServerConfiguration::OpMode_t::omRaw);
13483 getOptional<int>(
"serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
13484 getOptional<std::string>(
"bridgingConfigurationFileName", p.bridgingConfigurationFileName, j);
13485 getOptional<std::string>(
"bridgingConfigurationFileCommand", p.bridgingConfigurationFileCommand, j);
13486 getOptional<int>(
"bridgingConfigurationFileCheckSecs", p.bridgingConfigurationFileCheckSecs, j, 60);
13487 getOptional<BridgingServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
13488 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
13489 getOptional<BridgingServerInternals>(
"internals", p.internals, j);
13490 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
13491 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
13492 j.at(
"enginePolicy").get_to(p.enginePolicy);
13493 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.6cc0651.${id}");
13494 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
13495 getOptional<StatusUploadConfiguration>(
"statusUpload", p.statusUpload, j);
13497 getOptional<RtiCloudSettings>(
"rtiCloud", p.rtiCloud, j);
13502 JSON_SERIALIZED_CLASS(EarGroupsConfiguration)
13514 IMPLEMENT_JSON_SERIALIZATION()
13532 static void to_json(nlohmann::json& j,
const EarGroupsConfiguration& p)
13534 j = nlohmann::json{
13535 TOJSON_IMPL(groups)
13538 static void from_json(
const nlohmann::json& j, EarGroupsConfiguration& p)
13541 getOptional<std::vector<Group>>(
"groups", p.groups, j);
13545 JSON_SERIALIZED_CLASS(EarServerStatusReportConfiguration)
13557 IMPLEMENT_JSON_SERIALIZATION()
13586 includeGroupDetail =
false;
13591 static void to_json(nlohmann::json& j,
const EarServerStatusReportConfiguration& p)
13593 j = nlohmann::json{
13594 TOJSON_IMPL(fileName),
13595 TOJSON_IMPL(intervalSecs),
13596 TOJSON_IMPL(enabled),
13597 TOJSON_IMPL(includeGroupDetail),
13598 TOJSON_IMPL(runCmd)
13601 static void from_json(
const nlohmann::json& j, EarServerStatusReportConfiguration& p)
13604 getOptional<std::string>(
"fileName", p.fileName, j);
13605 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
13606 getOptional<bool>(
"enabled", p.enabled, j,
false);
13607 getOptional<std::string>(
"runCmd", p.runCmd, j);
13608 getOptional<bool>(
"includeGroupDetail", p.includeGroupDetail, j,
false);
13612 JSON_SERIALIZED_CLASS(EarServerInternals)
13626 IMPLEMENT_JSON_SERIALIZATION()
13648 housekeeperIntervalMs = 1000;
13652 static void to_json(nlohmann::json& j,
const EarServerInternals& p)
13654 j = nlohmann::json{
13655 TOJSON_IMPL(watchdog),
13656 TOJSON_IMPL(housekeeperIntervalMs),
13657 TOJSON_IMPL(tuning)
13660 static void from_json(
const nlohmann::json& j, EarServerInternals& p)
13663 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
13664 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
13665 getOptional<TuningSettings>(
"tuning", p.tuning, j);
13669 JSON_SERIALIZED_CLASS(EarServerConfiguration)
13680 IMPLEMENT_JSON_SERIALIZATION()
13735 serviceConfigurationFileCheckSecs = 60;
13736 groupsConfigurationFileName.clear();
13737 groupsConfigurationFileCommand.clear();
13738 groupsConfigurationFileCheckSecs = 60;
13739 statusReport.clear();
13740 externalHealthCheckResponder.clear();
13742 certStoreFileName.clear();
13743 certStorePasswordHex.clear();
13744 enginePolicy.clear();
13745 configurationCheckSignalName =
"rts.9a164fa.${id}";
13746 fipsCrypto.clear();
13751 static void to_json(nlohmann::json& j,
const EarServerConfiguration& p)
13753 j = nlohmann::json{
13755 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
13756 TOJSON_IMPL(groupsConfigurationFileName),
13757 TOJSON_IMPL(groupsConfigurationFileCommand),
13758 TOJSON_IMPL(groupsConfigurationFileCheckSecs),
13759 TOJSON_IMPL(statusReport),
13760 TOJSON_IMPL(externalHealthCheckResponder),
13761 TOJSON_IMPL(internals),
13762 TOJSON_IMPL(certStoreFileName),
13763 TOJSON_IMPL(certStorePasswordHex),
13764 TOJSON_IMPL(enginePolicy),
13765 TOJSON_IMPL(configurationCheckSignalName),
13766 TOJSON_IMPL(fipsCrypto),
13770 static void from_json(
const nlohmann::json& j, EarServerConfiguration& p)
13773 getOptional<std::string>(
"id", p.id, j);
13774 getOptional<int>(
"serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
13775 getOptional<std::string>(
"groupsConfigurationFileName", p.groupsConfigurationFileName, j);
13776 getOptional<std::string>(
"groupsConfigurationFileCommand", p.groupsConfigurationFileCommand, j);
13777 getOptional<int>(
"groupsConfigurationFileCheckSecs", p.groupsConfigurationFileCheckSecs, j, 60);
13778 getOptional<EarServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
13779 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
13780 getOptional<EarServerInternals>(
"internals", p.internals, j);
13781 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
13782 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
13783 j.at(
"enginePolicy").get_to(p.enginePolicy);
13784 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.9a164fa.${id}");
13785 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
13790 JSON_SERIALIZED_CLASS(EngageSemGroupsConfiguration)
13802 IMPLEMENT_JSON_SERIALIZATION()
13820 static void to_json(nlohmann::json& j,
const EngageSemGroupsConfiguration& p)
13822 j = nlohmann::json{
13823 TOJSON_IMPL(groups)
13826 static void from_json(
const nlohmann::json& j, EngageSemGroupsConfiguration& p)
13829 getOptional<std::vector<Group>>(
"groups", p.groups, j);
13833 JSON_SERIALIZED_CLASS(EngageSemServerStatusReportConfiguration)
13845 IMPLEMENT_JSON_SERIALIZATION()
13874 includeGroupDetail =
false;
13879 static void to_json(nlohmann::json& j,
const EngageSemServerStatusReportConfiguration& p)
13881 j = nlohmann::json{
13882 TOJSON_IMPL(fileName),
13883 TOJSON_IMPL(intervalSecs),
13884 TOJSON_IMPL(enabled),
13885 TOJSON_IMPL(includeGroupDetail),
13886 TOJSON_IMPL(runCmd)
13889 static void from_json(
const nlohmann::json& j, EngageSemServerStatusReportConfiguration& p)
13892 getOptional<std::string>(
"fileName", p.fileName, j);
13893 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
13894 getOptional<bool>(
"enabled", p.enabled, j,
false);
13895 getOptional<std::string>(
"runCmd", p.runCmd, j);
13896 getOptional<bool>(
"includeGroupDetail", p.includeGroupDetail, j,
false);
13900 JSON_SERIALIZED_CLASS(EngageSemServerInternals)
13914 IMPLEMENT_JSON_SERIALIZATION()
13936 housekeeperIntervalMs = 1000;
13940 static void to_json(nlohmann::json& j,
const EngageSemServerInternals& p)
13942 j = nlohmann::json{
13943 TOJSON_IMPL(watchdog),
13944 TOJSON_IMPL(housekeeperIntervalMs),
13945 TOJSON_IMPL(tuning)
13948 static void from_json(
const nlohmann::json& j, EngageSemServerInternals& p)
13951 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
13952 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
13953 getOptional<TuningSettings>(
"tuning", p.tuning, j);
13957 JSON_SERIALIZED_CLASS(EngageSemServerConfiguration)
13968 IMPLEMENT_JSON_SERIALIZATION()
14029 serviceConfigurationFileCheckSecs = 60;
14030 groupsConfigurationFileName.clear();
14031 groupsConfigurationFileCommand.clear();
14032 groupsConfigurationFileCheckSecs = 60;
14033 statusReport.clear();
14034 externalHealthCheckResponder.clear();
14036 certStoreFileName.clear();
14037 certStorePasswordHex.clear();
14038 enginePolicy.clear();
14039 configurationCheckSignalName =
"rts.9a164fa.${id}";
14040 fipsCrypto.clear();
14045 maxQueuingMs = 15000;
14051 static void to_json(nlohmann::json& j,
const EngageSemServerConfiguration& p)
14053 j = nlohmann::json{
14055 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
14056 TOJSON_IMPL(groupsConfigurationFileName),
14057 TOJSON_IMPL(groupsConfigurationFileCommand),
14058 TOJSON_IMPL(groupsConfigurationFileCheckSecs),
14059 TOJSON_IMPL(statusReport),
14060 TOJSON_IMPL(externalHealthCheckResponder),
14061 TOJSON_IMPL(internals),
14062 TOJSON_IMPL(certStoreFileName),
14063 TOJSON_IMPL(certStorePasswordHex),
14064 TOJSON_IMPL(enginePolicy),
14065 TOJSON_IMPL(configurationCheckSignalName),
14066 TOJSON_IMPL(fipsCrypto),
14068 TOJSON_IMPL(maxQueueLen),
14069 TOJSON_IMPL(minQueuingMs),
14070 TOJSON_IMPL(maxQueuingMs),
14071 TOJSON_IMPL(minPriority),
14072 TOJSON_IMPL(maxPriority)
14075 static void from_json(
const nlohmann::json& j, EngageSemServerConfiguration& p)
14078 getOptional<std::string>(
"id", p.id, j);
14079 getOptional<int>(
"serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
14080 getOptional<std::string>(
"groupsConfigurationFileName", p.groupsConfigurationFileName, j);
14081 getOptional<std::string>(
"groupsConfigurationFileCommand", p.groupsConfigurationFileCommand, j);
14082 getOptional<int>(
"groupsConfigurationFileCheckSecs", p.groupsConfigurationFileCheckSecs, j, 60);
14083 getOptional<EngageSemServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
14084 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
14085 getOptional<EngageSemServerInternals>(
"internals", p.internals, j);
14086 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
14087 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
14088 j.at(
"enginePolicy").get_to(p.enginePolicy);
14089 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.9a164fa.${id}");
14090 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
14092 getOptional<int>(
"maxQueueLen", p.maxQueueLen, j, 64);
14093 getOptional<int>(
"minQueuingMs", p.minQueuingMs, j, 0);
14094 getOptional<int>(
"maxQueuingMs", p.maxQueuingMs, j, 15000);
14095 getOptional<int>(
"minPriority", p.minPriority, j, 0);
14096 getOptional<int>(
"maxPriority", p.maxPriority, j, 255);
14100 JSON_SERIALIZED_CLASS(EngateGroup)
14112 IMPLEMENT_JSON_SERIALIZATION()
14117 uint32_t inputHangMs;
14118 uint32_t inputActivationPowerThreshold;
14119 uint32_t inputDeactivationPowerThreshold;
14131 inputActivationPowerThreshold = 700;
14132 inputDeactivationPowerThreshold = 125;
14136 static void to_json(nlohmann::json& j,
const EngateGroup& p)
14139 to_json(g,
static_cast<const Group&
>(p));
14141 j = nlohmann::json{
14142 TOJSON_IMPL(useVad),
14143 TOJSON_IMPL(inputHangMs),
14144 TOJSON_IMPL(inputActivationPowerThreshold),
14145 TOJSON_IMPL(inputDeactivationPowerThreshold)
14148 static void from_json(
const nlohmann::json& j, EngateGroup& p)
14151 from_json(j,
static_cast<Group&
>(p));
14152 getOptional<uint32_t>(
"inputHangMs", p.inputHangMs, j, 750);
14153 getOptional<uint32_t>(
"inputActivationPowerThreshold", p.inputActivationPowerThreshold, j, 700);
14154 getOptional<uint32_t>(
"inputDeactivationPowerThreshold", p.inputDeactivationPowerThreshold, j, 125);
14158 JSON_SERIALIZED_CLASS(EngateGroupsConfiguration)
14170 IMPLEMENT_JSON_SERIALIZATION()
14188 static void to_json(nlohmann::json& j,
const EngateGroupsConfiguration& p)
14190 j = nlohmann::json{
14191 TOJSON_IMPL(groups)
14194 static void from_json(
const nlohmann::json& j, EngateGroupsConfiguration& p)
14197 getOptional<std::vector<EngateGroup>>(
"groups", p.groups, j);
14201 JSON_SERIALIZED_CLASS(EngateServerStatusReportConfiguration)
14213 IMPLEMENT_JSON_SERIALIZATION()
14242 includeGroupDetail =
false;
14247 static void to_json(nlohmann::json& j,
const EngateServerStatusReportConfiguration& p)
14249 j = nlohmann::json{
14250 TOJSON_IMPL(fileName),
14251 TOJSON_IMPL(intervalSecs),
14252 TOJSON_IMPL(enabled),
14253 TOJSON_IMPL(includeGroupDetail),
14254 TOJSON_IMPL(runCmd)
14257 static void from_json(
const nlohmann::json& j, EngateServerStatusReportConfiguration& p)
14260 getOptional<std::string>(
"fileName", p.fileName, j);
14261 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
14262 getOptional<bool>(
"enabled", p.enabled, j,
false);
14263 getOptional<std::string>(
"runCmd", p.runCmd, j);
14264 getOptional<bool>(
"includeGroupDetail", p.includeGroupDetail, j,
false);
14268 JSON_SERIALIZED_CLASS(EngateServerInternals)
14282 IMPLEMENT_JSON_SERIALIZATION()
14304 housekeeperIntervalMs = 1000;
14308 static void to_json(nlohmann::json& j,
const EngateServerInternals& p)
14310 j = nlohmann::json{
14311 TOJSON_IMPL(watchdog),
14312 TOJSON_IMPL(housekeeperIntervalMs),
14313 TOJSON_IMPL(tuning)
14316 static void from_json(
const nlohmann::json& j, EngateServerInternals& p)
14319 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
14320 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
14321 getOptional<TuningSettings>(
"tuning", p.tuning, j);
14325 JSON_SERIALIZED_CLASS(EngateServerConfiguration)
14336 IMPLEMENT_JSON_SERIALIZATION()
14391 serviceConfigurationFileCheckSecs = 60;
14392 groupsConfigurationFileName.clear();
14393 groupsConfigurationFileCommand.clear();
14394 groupsConfigurationFileCheckSecs = 60;
14395 statusReport.clear();
14396 externalHealthCheckResponder.clear();
14398 certStoreFileName.clear();
14399 certStorePasswordHex.clear();
14400 enginePolicy.clear();
14401 configurationCheckSignalName =
"rts.9a164fa.${id}";
14402 fipsCrypto.clear();
14407 static void to_json(nlohmann::json& j,
const EngateServerConfiguration& p)
14409 j = nlohmann::json{
14411 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
14412 TOJSON_IMPL(groupsConfigurationFileName),
14413 TOJSON_IMPL(groupsConfigurationFileCommand),
14414 TOJSON_IMPL(groupsConfigurationFileCheckSecs),
14415 TOJSON_IMPL(statusReport),
14416 TOJSON_IMPL(externalHealthCheckResponder),
14417 TOJSON_IMPL(internals),
14418 TOJSON_IMPL(certStoreFileName),
14419 TOJSON_IMPL(certStorePasswordHex),
14420 TOJSON_IMPL(enginePolicy),
14421 TOJSON_IMPL(configurationCheckSignalName),
14422 TOJSON_IMPL(fipsCrypto),
14426 static void from_json(
const nlohmann::json& j, EngateServerConfiguration& p)
14429 getOptional<std::string>(
"id", p.id, j);
14430 getOptional<int>(
"serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
14431 getOptional<std::string>(
"groupsConfigurationFileName", p.groupsConfigurationFileName, j);
14432 getOptional<std::string>(
"groupsConfigurationFileCommand", p.groupsConfigurationFileCommand, j);
14433 getOptional<int>(
"groupsConfigurationFileCheckSecs", p.groupsConfigurationFileCheckSecs, j, 60);
14434 getOptional<EngateServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
14435 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
14436 getOptional<EngateServerInternals>(
"internals", p.internals, j);
14437 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
14438 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
14439 j.at(
"enginePolicy").get_to(p.enginePolicy);
14440 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.9a164fa.${id}");
14441 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
14446 static inline void dumpExampleConfigurations(
const char *path)
14448 WatchdogSettings::document();
14449 FileRecordingRequest::document();
14450 Feature::document();
14451 Featureset::document();
14453 RtpPayloadTypeTranslation::document();
14454 NetworkInterfaceDevice::document();
14455 ListOfNetworkInterfaceDevice::document();
14456 RtpHeader::document();
14457 BlobInfo::document();
14458 TxAudioUri::document();
14459 AdvancedTxParams::document();
14460 Identity::document();
14461 Location::document();
14463 Connectivity::document();
14464 PresenceDescriptorGroupItem::document();
14465 PresenceDescriptor::document();
14466 NetworkTxOptions::document();
14467 TcpNetworkTxOptions::document();
14468 NetworkAddress::document();
14469 NetworkAddressRxTx::document();
14470 NetworkAddressRestrictionList::document();
14471 StringRestrictionList::document();
14472 Rallypoint::document();
14473 RallypointCluster::document();
14474 NetworkDeviceDescriptor::document();
14475 TxAudio::document();
14476 AudioDeviceDescriptor::document();
14477 ListOfAudioDeviceDescriptor::document();
14479 TalkerInformation::document();
14480 GroupTalkers::document();
14481 Presence::document();
14482 Advertising::document();
14483 GroupPriorityTranslation::document();
14484 GroupTimeline::document();
14485 GroupAppTransport::document();
14486 RtpProfile::document();
14488 Mission::document();
14489 LicenseDescriptor::document();
14490 EngineNetworkingRpUdpStreaming::document();
14491 EnginePolicyNetworking::document();
14494 Bridge::document();
14495 AndroidAudio::document();
14496 EnginePolicyAudio::document();
14497 SecurityCertificate::document();
14498 EnginePolicySecurity::document();
14499 EnginePolicyLogging::document();
14500 EnginePolicyDatabase::document();
14501 NamedAudioDevice::document();
14502 EnginePolicyNamedAudioDevices::document();
14503 Licensing::document();
14504 DiscoveryMagellan::document();
14505 DiscoverySsdp::document();
14506 DiscoverySap::document();
14507 DiscoveryCistech::document();
14508 DiscoveryTrellisware::document();
14509 DiscoveryConfiguration::document();
14510 ApiCallPacingLaneSettings::document();
14511 ApiCallPacingSettings::document();
14512 EnginePolicyInternals::document();
14513 EnginePolicyTimelines::document();
14514 RtpMapEntry::document();
14515 ExternalModule::document();
14516 ExternalCodecDescriptor::document();
14517 EnginePolicy::document();
14518 TalkgroupAsset::document();
14519 EngageDiscoveredGroup::document();
14520 RallypointPeer::document();
14521 RallypointServerLimits::document();
14522 RallypointServerStatusReportConfiguration::document();
14523 RallypointServerLinkGraph::document();
14524 ExternalHealthCheckResponder::document();
14526 PeeringConfiguration::document();
14527 IgmpSnooping::document();
14528 RallypointReflector::document();
14529 RallypointUdpStreaming::document();
14530 RallypointWebsocketSettings::document();
14531 RallypointQuicSettings::document();
14532 RallypointServer::document();
14533 PlatformDiscoveredService::document();
14534 TimelineQueryParameters::document();
14535 CertStoreCertificate::document();
14536 CertStore::document();
14537 CertStoreCertificateElement::document();
14538 CertStoreDescriptor::document();
14539 CertificateDescriptor::document();
14540 BridgeCreationDetail::document();
14541 GroupConnectionDetail::document();
14542 GroupTxDetail::document();
14543 GroupCreationDetail::document();
14544 GroupReconfigurationDetail::document();
14545 GroupHealthReport::document();
14546 InboundProcessorStats::document();
14547 TrafficCounter::document();
14548 GroupStats::document();
14549 RallypointConnectionDetail::document();
14550 BridgingConfiguration::document();
14551 BridgingServerStatusReportConfiguration::document();
14552 StatusUploadConfiguration::document();
14553 BridgingServerInternals::document();
14554 RtiCloudSettings::document();
14555 BridgingServerConfiguration::document();
14556 EarGroupsConfiguration::document();
14557 EarServerStatusReportConfiguration::document();
14558 EarServerInternals::document();
14559 EarServerConfiguration::document();
14560 RangerPackets::document();
14561 TransportImpairment::document();
14563 EngageSemGroupsConfiguration::document();
14564 EngageSemServerStatusReportConfiguration::document();
14565 EngageSemServerInternals::document();
14566 EngageSemServerConfiguration::document();
14571 #pragma GCC diagnostic pop
static void nsmNodeFromEmbeddedServerJson(const nlohmann::json &j, const char *key, NsmNode &node)
TxPriority_t
Network Transmission Priority.
@ priBestEffort
best effort
AddressResolutionPolicy_t
Address family resolution policy.
@ arpIpv6ThenIpv4
IPv6 then IPv4.
@ arpIpv4ThenIpv6
IPv4 then IPv6.
#define ENGAGE_IGNORE_COMPILER_UNUSED_WARNING
RestrictionElementType_t
Enum describing restriction element types.
@ retGenericAccessTagPattern
Elements are generic access tags regex patterns.
@ retGroupIdPattern
Elements are group ID regex patterns.
@ retGroupId
A literal group ID.
@ retCertificateIssuerPattern
Elements are X.509 certificate issuer regex patterns.
@ retCertificateSubjectPattern
Elements are X.509 certificate subject regex patterns.
@ retCertificateFingerprintPattern
Elements are X.509 certificate fingerprint regex patterns.
@ retCertificateSerialNumberPattern
Elements are X.509 certificate serial number regex patterns.
static void nsmConfigurationResourcesFromJson(const nlohmann::json &j, std::vector< NsmNodeResource > &out)
Parse stateMachine.resources: array of objects {"id","priority"}.
GroupRestrictionAccessPolicyType_t
Enum describing restriction types.
@ graptStrict
Registration for groups is NOT allowed by default - requires definitive access through something like...
@ graptPermissive
Registration for groups is allowed by default.
static void bridgingServerNsmFromJson(const nlohmann::json &j, NsmSettings &nsm)
RestrictionType_t
Enum describing restriction types.
@ rtWhitelist
Elements are whitelisted.
@ rtBlacklist
Elements are blacklisted.
Configuration when using the engageBeginGroupTxAdvanced API.
TxAudioUri audioUri
[Optional] A URI to stream from instead of the audio input device
uint8_t priority
[Optional, Default: 0] Transmit priority between 0 (lowest) and 255 (highest).
bool receiverRxMuteForAliasSpecializer
[Optional, Default: false] Indicates that the aliasSpecializer must cause receivers to mute this tran...
uint16_t subchannelTag
[Optional, Default: 0] Defines a sub channel within a group. Audio will be opaque to all other client...
bool reBegin
[Optional, Default: false] Indicates that the transmission should be restarted.
uint16_t aliasSpecializer
[Optional, Default: 0] Defines a numeric affinity value to be included in the transmission....
uint16_t flags
[Optional, Default: 0] Combination of the ENGAGE_TXFLAG_xxx flags
std::string alias
[Optional, Default: empty string] The Engage Engine should transmit the user's alias as part of the h...
bool includeNodeId
[Optional, Default: false] The Engage Engine should transmit the NodeId as part of the header extensi...
uint32_t txId
[Optional, Default: 0] Transmission ID
bool muted
[Optional, Default: false] While the microphone should be opened, captured audio should be ignored un...
Defines parameters for advertising of an entity such as a known, public, group.
int intervalMs
[Optional, Default: 20000] Interval at which the advertisement should be sent in milliseconds.
bool enabled
[Optional, Default: false] Enabled advertising
bool alwaysAdvertise
[Optional, Default: false] If true, the node will advertise the item even if it detects other nodes m...
Acoustic Echo Cancellation settings.
int speakerTailMs
[Optional, Default: 60] Milliseconds of speaker tail
bool cng
[Optional, Default: true] Enable comfort noise generation
bool enabled
[Optional, Default: false] Enable acoustic echo cancellation
Mode_t
Acoustic echo cancellation mode enum.
Mode_t mode
[Optional, Default: aecmDefault] Specifies AEC mode. See Mode_t for all modes
bool enabled
[Optional, Default: false] Enables automatic gain control.
int compressionGainDb
[Optional, Default: 25, Minimum = 0, Maximum = 125] Gain in db.
bool enableLimiter
[Optional, Default: false] Enables limiter to prevent overdrive.
int maxLevel
[Optional, Default: 255] Maximum level.
int minLevel
[Optional, Default: 0] Minimum level.
int targetLevelDb
[Optional, Default: 9] Target gain level if there is no compression gain.
Default audio settings for AndroidAudio.
int api
[Optional, Default 0] Android audio API version: 0=Unspecified, 1=AAudio, 2=OpenGLES
int sessionId
[Optional, Default INVALID_SESSION_ID] A session ID from the Android AudioManager
int contentType
[Optional, Default 1] Usage type: 1=Speech 2=Music 3=Movie 4=Sonification
int sharingMode
[Optional, Default 0] Sharing mode: 0=Exclusive, 1=Shared
int performanceMode
[Optional, Default 12] Performance mode: 10=None/Default, 11=PowerSaving, 12=LowLatency
int inputPreset
[Optional, Default 7] Input preset: 1=Generic 5=Camcorder 6=VoiceRecognition 7=VoiceCommunication 9=U...
int usage
[Optional, Default 2] Usage type: 1=Media 2=VoiceCommunication 3=VoiceCommunicationSignalling 4=Alarm...
int engineMode
[Optional, Default 0] 0=use legacy low-level APIs, 1=use high-level Android APIs
Pacing settings for a single Engage API call lane.
int intervalMs
[Optional, Default: 0] Minimum milliseconds between API calls on this lane. 0 disables pacing.
uint32_t maxQueueDepth
[Optional, Default: 512] Maximum number of pending paced calls on this lane. 0 uses the default.
Optional pacing for asynchronous Engage API calls.
ApiCallPacingLaneSettings configuration
[Optional] Pacing for configuration-related API calls.
ApiCallPacingLaneSettings transmission
[Optional] Pacing for transmission-related API calls.
ApiCallPacingLaneSettings topology
[Optional] Pacing for topology mutations (e.g. engageCreateGroup).
Custom Audio Device Configuration.
std::string type
Device type (if any)
int samplingRate
This is the rate that the device will process the PCM audio data at.
std::string name
Name of the device assigned by the platform.
bool isDefault
True if this is the default device for the direction above.
std::string serialNumber
Device serial number (if any)
int channels
Indicates the number of audio channels to process.
std::string hardwareId
Device hardware ID (if any)
std::string manufacturer
Device manufacturer (if any)
Direction_t
Audio Device Direction Enum.
@ dirOutput
This is an output only device.
@ dirInput
This is an input only device.
std::string model
Device mode (if any)
Direction_t direction
Audio direction the device supports.
std::string extra
Extra data provided by the platform (if any)
bool isPresent
True if the device is currently present on the system.
int boostPercentage
A percentage at which to gain/attenuate the audio.
bool isAdad
True if the device is an Application-Defined Audio Device.
int deviceId
[Read Only] Unique device identifier assigned by Engage Engine at time of device creation.
Description of an audio gate.
double coefficient
[Optional. Default: 1.75] Coefficient by which to multiply the current history average to determine t...
uint32_t hangMs
[Optional. Default: 1500] Hang timer in milliseconds
bool enabled
[Optional. Default: false] Enables the audio gate if true
uint32_t windowMin
[Optional. Default: 25] Number of 10ms history samples to gather before calculating the noise floor -...
bool useVad
[Optional. Default: false] Use voice activity detection rather than audio energy
uint32_t windowMax
[Optional. Default: 125] Maximum number of 10ms history samples - ignored if useVad is true
Used to configure the Audio properties for a group.
int outputLevelRight
[Optional, Default: 100] The percentage at which to set the right audio at.
std::string outputHardwareId
[Optional] Hardware ID of the output audio device to use for this group. If empty,...
bool outputMuted
[Optional, Default: false] Mutes output audio.
std::string inputHardwareId
[Optional] Hardware ID of the input audio device to use for this group. If empty, inputId is used.
bool enabled
[Optional, Default: true] Audio is enabled
int inputId
[Optional, Default: first audio device] Id for the input audio device to use for this group.
int outputGain
[Optional, Default: 0] The percentage at which to gain the output audio.
int outputId
[Optional, Default: first audio device] Id for the output audio device to use for this group.
int inputGain
[Optional, Default: 0] The percentage at which to gain the input audio.
int outputLevelLeft
[Optional, Default: 100] The percentage at which to set the left audio at.
Describes an audio device that is available on the system.
std::string model
[Optional] Model
std::string extra
[Optional] Extra
std::string name
Name of the device.
std::string manufacturer
[Optional] Manufacturer
std::string type
[Optional] Type
std::string hardwareId
The string identifier used to identify the hardware.
bool isDefault
True if this is the default device.
std::string serialNumber
[Optional] Serial number
Describes an audio registry.
std::vector< AudioRegistryDevice > inputs
[Optional] List of input devices to use for the registry.
std::vector< AudioRegistryDevice > outputs
[Optional] List of output devices to use for the registry.
Describes the Blob data being sent used in the engageSendGroupBlob API.
size_t size
[Optional, Default : 0] Size of the payload
RtpHeader rtpHeader
Custom RTP header.
PayloadType_t payloadType
[Optional, Default: bptUndefined] The payload type to send in the blob
std::string target
[Optional, Default: empty string] The nodeId to which this message is targeted. If this is empty,...
std::string source
[Optional, Default: empty string] The nodeId of Engage Engine that sent the message....
int txnTimeoutSecs
[Optional, Default: 0] Number of seconds after which to time out delivery to the target node
PayloadType_t
Payload type. BlobInfo RTP supported Payload types.
std::string txnId
[Optional but required if txnTimeoutSecs is > 0]
Detailed information for a bridge creation.
CreationStatus_t
Creation status.
CreationStatus_t status
The creation status.
std::string id
ID of the bridge.
Bridging session settings.
bool active
[Optional, Default: true] Runtime activity flag resolved by EBS.
std::vector< std::string > groups
List of group IDs to be included in the session.
bool enabled
[Optional, Default: true] Enable the bridge NOTE: this is only used bt EBS and is ignored when callin...
std::vector< Group > groups
Array of bridges in the configuration.
std::vector< Bridge > bridges
Array of bridges in the configuration.
Configuration for the bridging server.
std::string certStoreFileName
Path to the certificate store.
NsmSettings nsm
[Optional] Embedded NSM settings (shared statusReport + nodes[]). JSON key nsm. Legacy top-level nsmN...
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the server's interaction with an external health-checker such as a load-balancer.
RtiCloudSettings rtiCloud
[Optional] Rally Tactical cloud (RTI) integration.
OpMode_t mode
Specifies the default operation mode (see OpMode_t).
EnginePolicy enginePolicy
The policy to be used for the underlying Engage Engine.
BridgingServerStatusReportConfiguration statusReport
Details for producing a status report.
std::string bridgingConfigurationFileCommand
Command-line to execute that returns a bridging configuration.
std::string bridgingConfigurationFileName
Name of a file containing the bridging configuration.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
OpMode_t
Enum describing the default mode the bridging service runs in. Values of omRaw, omMultistream,...
BridgingServerInternals internals
Internal settings.
int bridgingConfigurationFileCheckSecs
Number of seconds between checks to see if the bridging configuration has been updated....
int serviceConfigurationFileCheckSecs
Number of seconds between checks to see if the service configuration has been updated....
std::string id
A unqiue identifier for the bridge server.
StatusUploadConfiguration statusUpload
[Optional] Process-level HTTP upload for status reports (EBS and embedded NSM).
Internal bridging server settings.
int nsmResourceReleaseCooldownMs
[Optional, Default: 30000] Time to keep an unhealthy NSM resource out of election before rejoining.
int housekeeperIntervalMs
[Optional, Default: 1000] Interval at which to run the housekeeper thread.
int nsmUnhealthyBridgeGraceMs
[Optional, Default: 5000] Base time to wait before declaring an owned bridge unhealthy for NSM releas...
TuningSettings tuning
[Optional] Low-level tuning
WatchdogSettings watchdog
[Optional] Settings for the watchdog.
TODO: Configuration for the bridging server status report file.
bool includeBridgeGroupDetail
Description of a certstore certificate element.
std::string tags
Additional attributes.
bool hasPrivateKey
True if the certificate has a private key associated with it.
std::string certificatePem
PEM of the certificate.
Holds a certificate and (optionally) a private key in a certstore.
std::string tags
Additional tags.
std::string id
Id of the certificate.
std::string certificatePem
Certificate in PEM format.
void * internalData
Unserialized internal data.
std::string privateKeyPem
Private key in PEM format.
Description of a certstore.
std::string id
Certstore ID.
std::vector< CertStoreCertificateElement > certificates
Array of certificate elements.
std::string fileName
Name of the file the certstore resides in.
int flags
Flags set for the certstore.
int version
Version of the certstore.
std::vector< KvPair > kvp
Array of kv pairs.
std::vector< KvPair > kvp
[Optional] Array of KV pairs
std::vector< CertStoreCertificate > certificates
Array of certificates in this store.
std::string id
The ID of the certstore.
Description of a certificate.
std::vector< CertificateSubjectElement > subjectElements
Array of subject elements.
std::string serial
Serial #.
std::string publicKeyPem
PEM version of the public key.
std::vector< CertificateSubjectElement > issuerElements
Array of issuer elements.
bool selfSigned
Indicates whether the certificqte is self-signed.
std::string fingerprint
Fingerprint.
std::string notAfter
Validity date notAfter.
std::string subject
Subject.
std::string notBefore
Validity date notBefore.
std::string issuer
Issuer.
std::string certificatePem
PEM version of the certificate.
Description of a certificate subject element.
Connectivity Information used as part of the PresenceDescriptor.
int type
Is the type of connectivity the device has to the network.
int strength
Is the strength of the connection connection as reported by the OS - usually in dbm.
int rating
Is the quality of the network connection as reported by the OS - OS dependent.
Noise suppression (RNNoise) tuning settings.
float vadGate
[Optional, Default: 0.0] Min speech probability for full NS; 0 = always apply mix
std::string model
[Optional, Default: ""] Path to RNNoise weights blob; empty = built-in little model
float mix
[Optional, Default: 1.0] Wet/dry mix; 1.0 = fully denoised, 0.0 = original
Cistech Discovery settings.
Configuration for the Discovery features.
DiscoveryMagellan magellan
DiscoveryTrellisware trellisware
DiscoveryMagellan Discovery settings.
SecurityCertificate security
Tls tls
[Optional] Details concerning Transport Layer Security.
std::string interfaceName
[Optional, Default: default system interface] The network interface to bind to for discovery packets.
Session Announcement Discovery settings settings.
int ageTimeoutMs
[Optional, Default 30000] Number of milliseconds of no SAP announcment before the advertised entity i...
Advertising advertising
Parameters for advertising.
NetworkAddress address
[Optional, Default 224.2.127.254:9875] IP address and port.
bool enabled
[Optional, Default: false] Enables the Engage Engine to use SAP for asset discovery.
std::string interfaceName
[Optional, Default: default system interface] The network interface to bind to for discovery packets.
Simple Service Discovery Protocol settings.
bool enabled
[Optional, Default: false] Enables the Engage Engine to use SSDP for asset discovery.
std::vector< std::string > searchTerms
[Optional] An array of regex strings to be used to filter SSDP requests and responses.
int ageTimeoutMs
[Optional, Default 30000] Number of milliseconds of no SSDP announcment before the advertised entity ...
Advertising advertising
Parameters for advertising.
std::string interfaceName
[Optional, Default: default system interface] The network interface to bind to for discovery packets.
NetworkAddress address
[Optional, Default 255.255.255.255:1900] IP address and port.
Trellisware Discovery settings.
SecurityCertificate security
std::vector< Group > groups
Array of groups in the configuration.
Configuration for the ear server.
std::string id
A unqiue identifier for the EAR server.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the server's interaction with an external health-checker such as a load-balancer.
NsmNode nsm
[Optional] Embedded NSM node settings (JSON key nsm; legacy flat NsmConfiguration accepted).
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
EarServerInternals internals
Internal settings.
int groupsConfigurationFileCheckSecs
Number of seconds between checks to see if the configuration has been updated. Default is 60.
EarServerStatusReportConfiguration statusReport
Details for producing a status report.
std::string certStoreFileName
Path to the certificate store.
std::string groupsConfigurationFileName
Name of a file containing the ear configuration.
int serviceConfigurationFileCheckSecs
Number of seconds between checks to see if the service configuration has been updated....
std::string groupsConfigurationFileCommand
Command-line to execute that returns a configuration.
EnginePolicy enginePolicy
The policy to be used for the underlying Engage Engine.
Internal ear server settings.
int housekeeperIntervalMs
[Optional, Default: 1000] Interval at which to run the housekeeper thread.
WatchdogSettings watchdog
[Optional] Settings for the EAR's watchdog.
TuningSettings tuning
[Optional] Low-level tuning
TODO: Configuration for the ear server status report file.
NetworkAddress rx
Internal RX detail.
NetworkAddress tx
Internal TX detail.
std::string id
Internal ID.
Engage Semaphore configuration.
std::vector< Group > groups
Array of groups in the configuration.
Configuration for the EFC server.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
EnginePolicy enginePolicy
The policy to be used for the underlying Engage Engine.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
EngageSemServerStatusReportConfiguration statusReport
Details for producing a status report.
std::string id
A unqiue identifier for the EFC server.
std::string certStoreFileName
Path to the certificate store.
std::string groupsConfigurationFileName
Name of a file containing the EFC configuration.
int serviceConfigurationFileCheckSecs
Number of seconds between checks to see if the service configuration has been updated....
std::string groupsConfigurationFileCommand
Command-line to execute that returns a configuration.
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the server's interaction with an external health-checker such as a load-balancer.
NsmNode nsm
[Optional] Embedded NSM node settings (JSON key nsm; legacy flat NsmConfiguration accepted).
EngageSemServerInternals internals
Internal settings.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
int groupsConfigurationFileCheckSecs
Number of seconds between checks to see if the configuration has been updated. Default is 60.
Internal EFC server settings.
WatchdogSettings watchdog
[Optional] Settings for the EFC's watchdog.
TuningSettings tuning
[Optional] Low-level tuning
int housekeeperIntervalMs
[Optional, Default: 1000] Interval at which to run the housekeeper thread.
TODO: Configuration for the EFC server status report file.
std::vector< EngateGroup > groups
Array of groups in the configuration.
Configuration for the engate server.
EngateServerStatusReportConfiguration statusReport
Details for producing a status report.
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the server's interaction with an external health-checker such as a load-balancer.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
std::string groupsConfigurationFileName
Name of a file containing the ear configuration.
NsmNode nsm
[Optional] Embedded NSM node settings (JSON key nsm; legacy flat NsmConfiguration accepted).
EngateServerInternals internals
Internal settings.
int groupsConfigurationFileCheckSecs
Number of seconds between checks to see if the configuration has been updated. Default is 60.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
std::string certStoreFileName
Path to the certificate store.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
EnginePolicy enginePolicy
The policy to be used for the underlying Engage Engine.
int serviceConfigurationFileCheckSecs
Number of seconds between checks to see if the service configuration has been updated....
std::string id
A unqiue identifier for the EAR server.
std::string groupsConfigurationFileCommand
Command-line to execute that returns a configuration.
Internal engate server settings.
TuningSettings tuning
[Optional] Low-level tuning
int housekeeperIntervalMs
[Optional, Default: 1000] Interval at which to run the housekeeper thread.
WatchdogSettings watchdog
[Optional] Settings for the EAR's watchdog.
TODO: Configuration for the engate server status report file.
Configuration for RP UDP streaming.
TxPriority_t priority
[Optional, Default: priVoice] Transmission priority. This has meaning on some operating systems based...
int keepaliveIntervalSecs
Optional, Default: 15] Seconds interval at which to send UDP keepalives to Rallypoints....
int ttl
[Optional, Default: 64] Time to live or hop limit is a mechanism that limits the lifespan or lifetime...
int port
[Optional, 0] The port to be used for Rallypoint UDP streaming. A value of 0 will result in an epheme...
bool enabled
[Optional, false] Enables UDP streaming if the RP supports it
Default audio settings for Engage Engine policy.
AudioRegistry registry
[Optional] If specified, this registry will be used to discover the input and output devices
Vad vad
[Optional] Voice activity detection settings
Agc outputAgc
[Optional] Automatic Gain Control for audio outputs
bool saveOutputPcm
[Optional, Default: false] If true, input audio is written to a PCM file in the data directory
bool enabled
[Optional, Default: true] Enables audio processing
AndroidAudio android
[Optional] Android-specific audio settings
int internalRate
[Optional, Default: 16000] Internal sampling rate - 8000 or 16000
bool muteTxOnTx
[Optional, Default: false] Automatically mute TX when TX begins
Denoiser denoiser
[Optional] Noise suppression tuning (mix / model / vadGate)
Agc inputAgc
[Optional] Automatic Gain Control for audio inputs
bool hardwareEnabled
[Optional, Default: true] Enables local machine hardware audio
Aec aec
[Optional] Acoustic echo cancellation settings
bool denoiseInput
[Optional, Default: false] Denoise input
bool saveInputPcm
[Optional, Default: false] If true, input audio is written to a PCM file in the data directory
bool denoiseOutput
[Optional, Default: false] Denoise output
int internalChannels
[Optional, Default: 2] Internal audio channel count rate - 1 or 2
Provides Engage Engine policy configuration.
std::vector< ExternalModule > externalCodecs
Optional external codecs.
EnginePolicyNamedAudioDevices namedAudioDevices
Optional named audio devices (Linux only)
Featureset featureset
Optional feature set.
EnginePolicyDatabase database
Database settings.
EnginePolicyAudio audio
Audio settings.
std::string dataDirectory
Specifies the root of the physical path to store data.
Licensing licensing
Licensing settings.
EnginePolicyLogging logging
Logging settings.
DiscoveryConfiguration discovery
Discovery settings.
std::vector< RtpMapEntry > rtpMap
Optional RTP - overrides the default.
EngineStatusReportConfiguration statusReport
Optional statusReport - details for the status report.
EnginePolicyInternals internals
Internal settings.
EnginePolicySecurity security
Security settings.
EnginePolicyTimelines timelines
Timelines settings.
EnginePolicyNetworking networking
Security settings.
Internal Engage Engine settings.
TuningSettings tuning
[Optional] Low-level tuning
int stickyTidHangSecs
[Optional, Default: 10] The number of seconds after which "sticky" transmission IDs expire.
int maxTxSecs
[Optional, Default: 30] The default duration the engageBeginGroupTx and engageBeginGroupTxAdvanced fu...
int rpConnectionTimeoutSecs
[Optional, Default: 5] Connection timeout in seconds to RP
ApiCallPacingSettings apiCallPacing
[Optional] Pacing for selected asynchronous Engage API calls.
WatchdogSettings watchdog
[Optional] Settings for the Engine's watchdog.
RallypointCluster::ConnectionStrategy_t rpClusterStrategy
[Optional, Default: csRoundRobin] Specifies the default RP cluster connection strategy to be followed...
int delayedMicrophoneClosureSecs
[Optional, Default: 15] The number of seconds to cache an open microphone before actually closing it.
int rpTransactionTimeoutMs
[Optional, Default: 5] Transaction timeout with RP
int rtpExpirationCheckIntervalMs
[Optional, Default: 250] Interval at which to check for RTP expiration.
int rpClusterRolloverSecs
[Optional, Default: 10] Seconds between switching to a new target in a RP cluster
int housekeeperIntervalMs
[Optional, Default: 1000] Interval at which to run the housekeeper thread.
int uriStreamingIntervalMs
[Optional, Default: 60] The packet framing interval for audio streaming from a URI.
int maxLevel
[Optional, Default: 4, Range: 0-4] This is the maximum logging level to display in other words,...
EngineNetworkingRpUdpStreaming rpUdpStreaming
[Optional] Configuration for UDP streaming
std::string defaultNic
The default network interface card the Engage Engine should bind to.
RtpProfile rtpProfile
[Optional] Configuration for RTP profile
AddressResolutionPolicy_t addressResolutionPolicy
[Optional, Default 64] Address resolution policy
int multicastRejoinSecs
[Optional, Default: 8] Number of seconds elapsed between RX of multicast packets before an IGMP rejoi...
bool logRtpJitterBufferStats
[Optional, Default: false] If true, logs RTP jitter buffer statistics periodically
int rallypointRtTestIntervalMs
[Optional, Default: 60000] Milliseconds between sending Rallypoint round-trip test requests
bool requireMulticast
[Optional, Default true] Require multicast support
bool preventMulticastFailover
[Optional, Default: false] Overrides/cancels group-level multicast failover if set to true
Default certificate to use for security operation in the Engage Engine.
SecurityCertificate certificate
The default certificate and private key for the Engine instance.
std::vector< std::string > caCertificates
[Optional] An array of CA certificates to be used for validation of far-end X.509 certificates
Engine Policy Timeline configuration.
long autosaveIntervalSecs
[Default 5] Interval at which events are to be saved from memory to disk (a slow operation)
int maxStorageMb
Specifies the maximum storage space to use.
bool enabled
[Optional, Default: true] Specifies if Time Lines are enabled by default.
int maxDiskMb
Specifies the maximum disk space to use - defaults to maxStorageMb.
SecurityCertificate security
The certificate to use for signing the recording.
int maxAudioEventMemMb
Specifies the maximum number of megabytes to allow for a single audio event's memory block - defaults...
long maxEventAgeSecs
Maximum age of an event after which it is to be erased.
int maxMemMb
Specifies the maximum memory to use - defaults to maxStorageMb.
std::string storageRoot
Specifies where the timeline recordings will be stored physically.
bool ephemeral
[Default false] If true, recordings are automatically purged when the Engine is shut down and/or rein...
bool disableSigningAndVerification
[Default false] If true, prevents signing of events - i.e. no anti-tanpering features will be availab...
int maxEvents
Maximum number of events to be retained.
long groomingIntervalSecs
Interval at which events are to be checked for age-based grooming.
TODO: Configuration for the translation server status report file.
bool includeTaskQueueDetail
Describes an external codec.
int samplingRate
Sampling rate.
int rtpPayloadType
RTP payload type.
int rtpTsMultiplier
RTP timestamp multiplier.
TODO: Configuration to enable external systems to use to check if the service is still running.
Base for a description of an external module.
std::string file
File spec.
nlohmann::json configuration
Optional free-form JSON configuration to be passed to the module.
bool debug
[Optional, Default false] If true, requests the crypto engine module to run in debugging mode.
bool enabled
[Optional, Default false] If true, requires FIPS 140-3 crypto operation via the OpenSSL 3....
std::string curves
[Optional] Specifies the NIST-approved curves to be used for FIPS
std::string path
Path where the crypto engine module is located
std::string ciphers
[Optional] Specifies the NIST-approved ciphers to be used for FIPS
Configuration for the optional custom transport functionality for Group.
bool enabled
[Optional, Default: false] Enables custom feature.
std::string id
The id/name of the transport. This must match the id/name supplied when registering the app transport...
BridgingOpMode_t
Enum describing bridging operation mode types where applicable.
AdvancedTxParams mixedStreamTxParams
[Optional] Parameters to be applied when output is mixed (bomMixedStream)
BridgingOpMode_t mode
[Optional] The output mode
Detailed information for a group connection.
std::string id
ID of the group.
std::string peer
Peer information.
ConnectionType_t
Connection type.
bool asFailover
Indicates whether the connection is for purposes of failover.
ConnectionType_t connectionType
The connection type.
std::string reason
[Optional] Additional reason information
Detailed information for a group creation.
std::string id
ID of the group.
CreationStatus_t status
The creation status.
CreationStatus_t
Creation status.
uint8_t tx
[Optional] The default audio priority
uint8_t rx
[Optional] The default audio RX priority
Detailed information regarding a group's health.
GroupAppTransport appTransport
[Optional] Settings necessary if the group is transported via an application-supplied custom transpor...
std::string source
[Optional, Default: null] Indicates the source of this configuration - e.g. from the application or d...
Presence presence
Presence configuration (see Presence).
std::vector< uint16_t > specializerAffinities
List of specializer IDs that the local node has an affinity for/member of.
std::vector< Source > ignoreSources
[Optional] List of sources to ignore for this group
NetworkAddress rtcpPresenceRx
The network address for receiving RTCP presencing packets.
bool allowLoopback
[Optional, Default: false] Allows for processing of looped back packets - primarily meant for debuggi...
Type_t
Enum describing the group types.
NetworkAddress tx
The network address for transmitting network traffic to.
std::string alias
User alias to transmit as part of the realtime audio stream when using the engageBeginGroupTx API.
int stickyTidHangSecs
[Optional, Default: 10] The number of seconds after which "sticky" transmission IDs expire.
TxAudio txAudio
Audio transmit options such as codec, framing size etc (see TxAudio).
int maxRxSecs
[Optional, Default: 0] Maximum number of seconds the Engine will receive for on this group.
PacketCapturer txCapture
Details for capture of transmitted packets
NetworkTxOptions txOptions
Transmit options for the group (see NetworkTxOptions).
std::string synVoice
Name of the synthesis voice to use for the group
TransportImpairment rxImpairment
[Optional] The RX impairment to apply
std::string languageCode
ISO 639-2 language code for the group
std::string cryptoPassword
Password to be used for encryption. Note that this is not the encryption key but, rather,...
std::vector< std::string > presenceGroupAffinities
List of presence group IDs with which this group has an affinity.
GroupTimeline timeline
Audio timeline is configuration.
GroupPriorityTranslation priorityTranslation
[Optional] Describe how traffic for this group on a different addressing scheme translates to priorit...
bool disablePacketEvents
[Optional, Default: false] Disable packet events.
bool blockAdvertising
[Optional, Default: false] Set this to true if you do not want the Engine to advertise this Group on ...
bool ignoreAudioTraffic
[Optional, Default: false] Indicates that the group should ignore traffic that is audio-related
std::string interfaceName
The name of the network interface to use for multicasting for this group. If not provided,...
bool _wasDeserialized_rtpProfile
[Internal - not serialized
bool enableMulticastFailover
[Optional, Default: false] Set this to true to enable failover to multicast operation if a Rallypoint...
std::string name
The human readable name for the group.
NetworkAddress rx
The network address for receiving network traffic on.
Type_t type
Specifies the group type (see Type_t).
GroupDefaultAudioPriority defaultAudioPriority
Default audio priority for the group (see GroupDefaultAudioPriority).
uint16_t blobRtpPayloadType
[Optional, Default: ENGAGE_DEFAULT_BLOB_RTP_PAYLOAD_TYPE] The RTP payload type to be used for blobs s...
std::vector< Rallypoint > rallypoints
[DEPRECATED] List of Rallypoint (s) the Group should use to connect to a Rallypoint router....
RtpProfile rtpProfile
[Optional] RTP profile the group
std::vector< RtpPayloadTypeTranslation > inboundRtpPayloadTypeTranslations
[Optional] A vector of translations from external entity RTP payload types to those used by Engage
int multicastFailoverSecs
[Optional, Default: 10] Specifies the number fo seconds to wait after Rallypoint connection failure t...
InboundAliasGenerationPolicy_t
Enum describing the alias generation policy.
RangerPackets rangerPackets
[Optional] Ranger packet options
int rfc4733RtpPayloadId
[Optional, Default: 0] The RTP payload ID by which to identify (RX and TX) payloads encoded according...
uint32_t securityLevel
[Optional, Default: 0] The security classification level of the group.
PacketCapturer rxCapture
Details for capture of received packets
GroupBridgeTargetOutputDetail bridgeTargetOutputDetail
Output details for when the group is a target in a bridge (see GroupBridgeTargetOutputDetail).
std::string id
Unique identity for the group.
AudioGate gateIn
[Optional] Inbound gating of audio - only audio allowed through by the gate will be processed
RallypointCluster rallypointCluster
Cluster of one or more Rallypoints the group may use.
TransportImpairment txImpairment
[Optional] The TX impairment to apply
Audio audio
Sets audio properties like which audio device to use, audio gain etc (see Audio).
bool lbCrypto
[Optional, Default: false] Use low-bandwidth crypto
std::string spokenName
The group name as spoken - typically by a text-to-speech system
InboundAliasGenerationPolicy_t inboundAliasGenerationPolicy
[Optional, Default: iagpAnonymousAlias]
std::string anonymousAlias
[Optional] Alias to use for inbound streams that do not have an alias component
Details for priority transmission based on unique network addressing.
NetworkAddress tx
TX addressing.
int priority
Engage priority for RX & TX.
NetworkAddress rx
RX addressing.
Detailed information for a group reconfiguration.
ReconfigurationStatus_t status
The creation status.
std::string id
ID of the group.
ReconfigurationStatus_t
Reconfiguration status.
Detailed statistics for group.
List of TalkerInformation objects.
std::vector< TalkerInformation > list
List of TalkerInformation objects.
Configuration for Timeline functionality for Group.
bool enabled
[Optional, Default: true] Enables timeline feature.
int maxAudioTimeMs
[Optional, Default: 30000] Maximum audio block size to record in milliseconds.
Detailed information for a group transmit.
std::string id
ID of the group.
int remotePriority
Remote TX priority (optional)
long nonFdxMsHangRemaining
Milliseconds of hang time remaining on a non-FDX group (optional)
int localPriority
Local TX priority (optional)
uint32_t txId
Transmission ID (optional)
TxStatus_t status
The TX status.
std::string displayName
[Optional, Default: empty string] The display name to be used for the user.
std::string userId
[Optional, Default: empty string] The user ID to be used to represent the user.
std::string nodeId
[Optional, Default: Auto Generated] This is the Node ID to use to represent instance on the network.
std::string avatar
[Optional, Default: empty string] This is a application defined field used to indicate a users avatar...
Configuration for IGMP snooping.
int queryIntervalMs
[Optional, Default 125000] Interval between sending IGMP membership queries. If 0,...
int subscriptionTimeoutMs
[Optional, Default 0] Typically calculated according to RFC specifications. Set a value here to manua...
bool enabled
Enables IGMP. Default is false.
Detailed statistics for an inbound processor.
Helper class for serializing and deserializing the LicenseDescriptor JSON.
std::string activationHmac
The HMAC to be used for activation purposes.
std::string entitlement
Entitlement key to use for the product.
std::string cargo
Reserved for internal use.
std::string manufacturerId
[Read only] Manufacturer ID.
std::string key
License Key to be used for the application.
uint8_t cargoFlags
Reserved for internal use.
int type
[Read only] 0 = unknown, 1 = perpetual, 2 = expires
std::string deviceId
[Read only] Unique device identifier generated by the Engine.
int status
The current licensing status.
time_t expires
[Read only] The time that the license key or activation code expires in Unix timestamp - Zulu/UTC.
std::string activationCode
If the key required activation, this is the activation code generated using the entitlement,...
std::string expiresFormatted
[Read only] The time that the license key or activation code expires formatted in ISO 8601 format,...
std::string deviceId
Device Identifier. See LicenseDescriptor::deviceId for details.
std::string manufacturerId
Manufacturer ID to use for the product. See LicenseDescriptor::manufacturerId for details.
std::string activationCode
Activation Code issued for the license key. See LicenseDescriptor::activationCode for details.
std::string key
License key. See LicenseDescriptor::key for details.
std::string entitlement
Entitlement key to use for the product. See LicenseDescriptor::entitlement for details.
std::vector< Group > groups
Array of groups in the configuration.
std::vector< VoiceToVoiceSession > voiceToVoiceSessions
Array of voiceToVoice sessions in the configuration.
Configuration for the linguistics server.
LingoServerStatusReportConfiguration statusReport
Details for producing a status report.
std::string lingoConfigurationFileName
Name of a file containing the linguistics configuration.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
std::string id
A unqiue identifier for the linguistics server.
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the server's interaction with an external health-checker such as a load-balancer.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
std::string lingoConfigurationFileCommand
Command-line to execute that returns a linguistics configuration.
LingoServerInternals internals
Internal settings.
EnginePolicy enginePolicy
The policy to be used for the underlying Engage Engine.
NsmNode nsm
[Optional] Embedded NSM node settings (JSON key nsm; legacy flat NsmConfiguration accepted).
int lingoConfigurationFileCheckSecs
Number of seconds between checks to see if the linguistics configuration has been updated....
std::string certStoreFileName
Path to the certificate store.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
NetworkAddress proxy
Address and port of the proxy.
int serviceConfigurationFileCheckSecs
Number of seconds between checks to see if the service configuration has been updated....
Internal translator server settings.
int housekeeperIntervalMs
[Optional, Default: 1000] Interval at which to run the housekeeper thread.
WatchdogSettings watchdog
[Optional] Settings for the watchdog.
TuningSettings tuning
[Optional] Low-level tuning
TODO: Configuration for the translation server status report file.
bool includeSessionGroupDetail
bool includeSessionDetail
Location information used as part of the PresenceDescriptor.
double longitude
Its the longitudinal position using the Signed degrees format (DDD.dddd) format. Valid range is -180 ...
double altitude
[Optional, Default: INVALID_LOCATION_VALUE] The altitude above sea level in meters.
uint32_t ts
[Read Only: Unix timestamp - Zulu/UTC] Indicates the timestamp that the location was recorded.
double latitude
Its the latitude position using the using the Signed degrees format (DDD.dddd). Valid range is -90 to...
double direction
[Optional, Default: INVALID_LOCATION_VALUE] Direction the endpoint is traveling in degrees....
double speed
[Optional, Default: INVALID_LOCATION_VALUE] The speed the endpoint is traveling at in meters per seco...
Defines settings for a named identity.
SecurityCertificate certificate
The identity certificate.
std::string name
The identity name.
std::string address
IP address.
NetworkAddressRestrictionList.
RestrictionType_t type
Type indicating how the elements are to be treated.
std::vector< NetworkAddressRxTx > elements
List of elements.
Custom Network Device Configuration.
std::string manufacturer
Device manufacturer (if any)
std::string model
Device mode (if any)
int deviceId
[Read Only] Unique device identifier assigned by Engage Engine at time of device creation.
std::string extra
Extra data provided by the platform (if any)
std::string type
Device type (if any)
std::string hardwareId
Device hardware ID (if any)
std::string serialNumber
Device serial number (if any)
std::string name
Name of the device assigned by the platform.
Network Transmit Options.
int ttl
[Optional, Default: 1] Time to live or hop limit is a mechanism that limits the lifespan or lifetime ...
TxPriority_t priority
[Optional, Default: priVoice] Transmission priority. This has meaning on some operating systems based...
int goingActiveRandomDelayMs
[Optional, Default: 500] Random delay in ms before entering GOING_ACTIVE (spread elections).
int internalMultiplier
[Optional, Default: 1] Scales TX interval and transition wait (testing / timing).
Optional per-resource health gate while ACTIVE.
int unhealthyGraceMs
[Optional, Default: 5000] Ms unhealthy before voluntary release.
int releaseCooldownSecs
[Optional, Default: 30] Seconds to suppress re-election after release.
bool enabled
[Optional, Default: false] When true, poll runCmd while resources are ACTIVE.
bool failClosed
[Optional, Default: true] When true, runCmd failure/timeout is treated as unhealthy.
std::string runCmd
Shell command; trimmed stdout must be 1 (healthy) or 0 (unhealthy).
int intervalSecs
[Optional, Default: 5] Seconds between health polls per ACTIVE resource.
Periodic external command to refresh CoT point location.
std::string runCmd
Shell command returning JSON: {"lat":"…","lon":"…"[, "ce","hae","le"]}.
int intervalSecs
[Optional, Default: 10] Seconds between polls.
bool failClosed
[Optional, Default: true] When true, poll failure retains the last fix.
bool enabled
[Optional, Default: false] When true, runCmd is polled for location.
Cursor-on-Target envelope for NSM wire payloads (optional).
std::string callsign
Optional CoT contact callsign (emitted as detail/contact/@callsign ).
int idleIntervalSecs
CoT presence interval for fully idle nodes when announceWhenIdle is true (default 30).
NsmNodeCotLocationPollSettings locationPoll
Optional periodic command to refresh CoT point location.
std::string detailJson
Optional JSON object serialized as string for extra CoT detail elements.
bool announceWhenIdle
When useCot is true, fully idle nodes TX full resource state at idleIntervalSecs (default false).
Optional external gate for NSM election wire participation.
std::string runCmd
Shell command; trimmed stdout must be 1 (participate) or 0 (idle).
int intervalSecs
[Optional, Default: 2] Seconds between runCmd polls.
bool failClosed
[Optional, Default: true] When true, runCmd failure/timeout is treated as 0.
bool enabled
[Optional, Default: false] When true, election participation follows runCmd.
Configuration for a Nsm node.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
NsmNodeStatusReportConfiguration statusReport
Details for producing a status report.
NsmNodeElectionGateSettings electionGate
Optional external gate for election wire participation (Seeker active/standby, etc....
NsmNodeActiveHealthCheckSettings activeHealthCheck
Optional per-resource health monitoring while ACTIVE.
WatchdogSettings watchdog
[Optional] Settings for the node's watchdog.
StatusUploadConfiguration statusUpload
[Optional] Process-level status report HTTP upload (standalone nsmd). Ignored when embedded; host pas...
NsmNodeLogging logging
Console / syslog logging.
Licensing licensing
Licensing settings.
Featureset featureset
Optional feature set.
std::string id
Unique identifier for this process instance (also used as default state machine id when stateMachine....
int defaultPriority
[Optional, Default: 0] Election priority byte when a resource omits priority or uses -1 (see NsmNodeR...
bool dashboardToken
[Optional, Default: false] When true with dashboard logging, show resource token in the UI.
std::vector< NsmNodePeriodic > periodics
Periodic commands (JSON output, external token range, etc.).
PacketCapturer txCapture
Details for capture of transmitted packets
NsmNodeScripts scripts
Lifecycle hook scripts.
std::string multicastInterfaceName
Multicast bind / subscription NIC (SO_BINDTODEVICE / IP_ADD_MEMBERSHIP).
std::string name
Human-readable label for operators.
IpFamilyType_t ipFamily
[Optional, Default IpFamilyType_t::ifIp4] Address family for interface validation and logging.
int fixedToken
[Optional, Default: -1] Fixed global token for testing; >= 0 forces that token, -1 uses random per el...
TuningSettings tuning
[Optional] Low-level tuning
PacketCapturer rxCapture
Details for capture of received packets
std::string domainId
Logical domain id for this election channel. Required and unique when more than one NSM node is confi...
NsmNodeCotSettings cot
Optional CoT wrapping for wire payloads.
NsmConfiguration stateMachine
Core NSM protocol and networking configuration (UDP, tokens, timing).
Console / syslog logging behaviour for nsmd.
bool dashboard
[Optional, Default: false] Full-screen dashboard instead of line logs.
int level
[Optional, Default: 3] ILogger level (fatal=0 ... debug=5).
Scheduled command (e.g. external token range discovery).
One logical resource in the NSM state machine with its election priority (high byte of token).
int priority
[Optional, Default: -1] Priority byte for token MSB; -1 means use NsmNode.defaultPriority when loaded...
External hook scripts for state transitions and reporting.
Configuration for the Nsm status report file.
bool includeResourceDetail
NsmNodeStatusReportImmediateConfiguration immediate
Embedded NSM settings for multi-node hosts (e.g. EBS).
NsmNodeStatusReportConfiguration statusReport
Shared status-report settings applied to each node (fileName may use ${id} = node id).
std::vector< NsmNode > nodes
Embedded NSM election fabrics (one per MANET / multicast domain).
Description of a packet capturer.
Configuration for Rallypoint peers.
int version
TODO: A version number for the domain configuration. Change this whenever you update your configurati...
std::string comments
Comments.
std::string id
An identifier useful for organizations that track different domain configurations by ID.
std::vector< RallypointPeer > peers
List of Rallypoint peers to connect to.
Device Power Information used as part of the PresenceDescriptor.
int state
[Optional, Default: 0] Is the current state that the power system is in.
int source
[Optional, Default: 0] Is the source the power is being delivered from
int level
[Optional, Default: 0] Is the current level of the battery or power system as a percentage....
Group Alias used as part of the PresenceDescriptor.
uint16_t status
Status flags for the user's participation on the group.
std::string alias
User's alias for the group.
std::string groupId
Group Id the alias is associated with.
Represents an endpoints presence properties. Used in engageUpdatePresenceDescriptor API and PFN_ENGAG...
Power power
[Optional, Default: see Power] Device power information like charging state, battery level,...
std::string custom
[Optional, Default: empty string] Custom string application can use of presence descriptor....
bool self
[Read Only] Indicates that this presence declaration was generated by the Engage Engine the applicati...
uint32_t nextUpdate
[Read Only, Unix timestamp - Zulu/UTC] Indicates the next time the presence descriptor will be sent.
std::vector< PresenceDescriptorGroupItem > groupAliases
[Read Only] List of group items associated with this presence descriptor.
Identity identity
[Optional, Default see Identity] Endpoint's identity information.
bool announceOnReceive
[Read Only] Indicates that the Engine will announce its PresenceDescriptor in response to this messag...
uint32_t ts
[Read Only, Unix timestamp - Zulu/UTC] Indicates the timestamp that the message was originally sent.
std::string comment
[Optional] No defined limit on size but the total size of the serialized JSON object must fit inside ...
Connectivity connectivity
[Optional, Default: see Connectivity] Device connectivity information like wifi/cellular,...
uint32_t disposition
[Optional] Indicates the users disposition
Location location
[Optional, Default: see Location] Location information
Describes how the Presence is configured for a group of type Group::gtPresence in Group::Type_t.
Format_t format
Format to be used to represent presence information.
Format_t
Presence format types enum.
bool reduceImmediacy
[Optional, Default: false] Instructs the Engage Engine reduce the immediacy of presence announcements...
bool listenOnly
Instructs the Engage Engine to not transmit presence descriptor.
int minIntervalSecs
[Optional, Default: 5] The minimum interval to send at to prevent network flooding
int intervalSecs
[Optional, Default: 30] The interval in seconds at which to send the presence descriptor on the prese...
Defines settings for Rallypoint advertising.
std::string interfaceName
The multicast network interface for mDNS.
std::string serviceName
[Optional, Default "_rallypoint._tcp.local."] The service name
std::string hostName
[Optional] This Rallypoint's DNS-SD host name
int port
[Default: RP port] The multicast network interface for mDNS
bool enabled
[Default: false] Advertising is enabled
int ttl
[Default: 60] TTL for service TTL
int rolloverSecs
Seconds between switching to a new target.
ConnectionStrategy_t
Connection strategy enum.
int transactionTimeoutMs
[Optional, Default: 10000] Default transaction time in milliseconds to any RP in the cluster
int connectionTimeoutSecs
[Optional, Default: 5] Default connection timeout in seconds to any RP in the cluster
std::vector< Rallypoint > rallypoints
List of Rallypoints.
ConnectionStrategy_t connectionStrategy
[Optional, Default: csRoundRobin] Specifies the connection strategy to be followed....
Detailed information for a rallypoint connection.
std::string internalId
Id.
float serverProcessingMs
Server processing time in milliseconds - used for roundtrip reports.
uint64_t msToNextConnectionAttempt
Milliseconds until next connection attempt.
Defines settings for Rallypoint extended group restrictions.
std::vector< StringRestrictionList > restrictions
Restrictions.
int transactionTimeoutMs
[Optional, Default 10000] Number of milliseconds that a transaction may take before the link is consi...
bool allowSelfSignedCertificate
[Optional, Default false] Allows the Rallypoint to accept self-signed certificates from the far-end
std::string sni
[Optional] A user-defined string sent as the Server Name Indication (SNI) field in the TLS setup....
std::vector< std::string > caCertificates
[Optional] A vector of certificates (raw content, file names, or certificate store elements) used to ...
std::string certificate
This is the X509 certificate to use for mutual authentication.
bool verifyPeer
[Optional, Default true] Indicates whether the connection peer is to be verified by checking the vali...
bool disableMessageSigning
[Optional, Default false] Indicates whether to forego ECSDA signing of control-plane messages.
NetworkAddress host
This is the host address for the Engine to connect to the RallyPoint service.
std::string additionalProtocols
[Optional, Default: ""] Additional protocols to use for the Rallypoint connection (only used for WebS...
RpProtocol_t protocol
[Optional, Default: rppTlsTcp] Specifies the protocol to be used for the Rallypoint connection....
std::string certificateKey
This is the private key used to generate the X509 certificate.
int connectionTimeoutSecs
[Optional, Default: 5] Connection timeout in seconds to the RP
TcpNetworkTxOptions tcpTxOptions
[Optional] Tx options for the TCP link
std::string path
[Optional, Default: ""] Path to use for the RP connection (only used for WebSocket)
RpProtocol_t
RP protocol enum.
SecurityCertificate certificate
Internal certificate detail.
OutboundWebSocketTlsPolicy_t
std::string id
Internal ID.
std::string additionalProtocols
[Optional, Default: ""] Additional protocols to use for the peer (only used for WebSocket)
bool forceIsMeshLeaf
Internal enablement setting.
int connectionTimeoutSecs
[Optional, Default: 0 - OS platform default] Connection timeout in seconds to the peer
NetworkAddress host
Internal host detail.
std::string sni
[Optional] A user-defined string sent as the Server Name Indication (SNI) field in the TLS setup when...
std::string path
[Optional, Default: ""] Path to use for the peer (only used for WebSocket)
bool enabled
Internal enablement setting.
OutboundWebSocketTlsPolicy_t outboundWebSocketTlsPolicy
Internal enablement setting.
Rallypoint::RpProtocol_t protocol
[Optional, Default: Rallypoint::RpProtocol_t::rppTlsTcp] Protocol to use for the peer
Defines settings for Rallypoint QUIC listener (UDP). Control framing is the same length-prefixed RP p...
int listenPort
Listen port (UDP). Default is 7443 (same number as TCP listenPort; different IP protocol)
bool enabled
[Default: false] QUIC listener is enabled
Definition of a static group for Rallypoints.
NetworkAddress rx
The network address for receiving network traffic on.
std::string id
Unique identity for the group.
std::vector< NetworkAddress > additionalTx
[Optional] Vector of additional TX addresses .
NetworkAddress tx
The network address for transmitting network traffic to.
DirectionRestriction_t directionRestriction
[Optional] Restriction of direction of traffic flow
DirectionRestriction_t
Enum describing direction(s) for the reflector.
std::string multicastInterfaceName
[Optional] The name of the NIC on which to send and receive multicast traffic.
Defines a behavior for a Rallypoint peer roundtrip time.
BehaviorType_t
Enum describing behavior types.
@ btReportWarn
Report at level warning.
@ btReportError
Report at level error.
@ btReportInfo
Report at level info.
BehaviorType_t behavior
Specifies the streaming mode type (see BehaviorType_t).
uint32_t atOrAboveMs
Network address for listening.
Configuration for the Rallypoint server.
uint32_t maxSecurityLevel
[Optional, Default 0] Sets the maximum item security level that can be registered with the RP
bool forwardDiscoveredGroups
Enables automatic forwarding of discovered multicast traffic to peer Rallypoints.
std::string interfaceName
Name of the NIC to bind to for listening for incoming TCP connections.
NetworkTxOptions multicastTxOptions
Tx options for multicast.
bool disableMessageSigning
Set to true to forgo DSA signing of messages. Doing so is is a security risk but can be useful on CPU...
SecurityCertificate certificate
X.509 certificate and private key that identifies the Rallypoint.
std::string multicastInterfaceName
The name of the NIC on which to send and receive multicast traffic.
StringRestrictionList groupRestrictions
Group IDs to be restricted (inclusive or exclusive)
std::string peeringConfigurationFileName
Name of a file containing a JSON array of Rallypoint peers to connect to.
NsmNode nsm
[Optional] Embedded NSM node settings (JSON key nsm; legacy flat NsmConfiguration accepted).
uint32_t sysFlags
[Optional, Default 0] Internal system flags
int listenPort
TCP port to listen on. Default is 7443.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
NetworkAddressRestrictionList multicastRestrictions
Multicasts to be restricted (inclusive or exclusive)
uint32_t normalTaskQueueBias
[Optional, Default 0] Sets the queue's normal task bias
std::string name
A human-readable name for the Rallypoint.
PacketCapturer txCapture
Details for capture of transmitted packets
StatusUploadConfiguration statusUpload
Process-level HTTP POST settings for status / link / route uploads.
std::vector< RallypointReflector > staticReflectors
Vector of static groups.
bool enableLeafReflectionReverseSubscription
If enabled, causes a domain leaf to reverse-subscribe to a core node upon the core subscribing and a ...
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
IpFamilyType_t ipFamily
[Optional, Default IpFamilyType_t::ifIp4] Address familiy to be used for listening
int peerRtTestIntervalMs
[Optional, Default: 60000] Milliseconds between sending round-trip test requests to peers
WatchdogSettings watchdog
[Optional] Settings for the Rallypoint's watchdog.
DiscoveryConfiguration discovery
Details discovery capabilities.
bool isMeshLeaf
Indicates whether this Rallypoint is part of a core domain or hangs off the periphery as a leaf node.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
GroupRestrictionAccessPolicyType_t groupRestrictionAccessPolicyType
The policy employed to allow group registration.
RallypointServerStreamStatsExport streamStatsExport
File export of per-stream counters. Also POSTed as rp-streams when statusUpload.baseUrl is set,...
Licensing licensing
Licensing settings.
PacketCapturer rxCapture
Details for capture of received packets
std::vector< std::string > extraDomains
[Optional] List of additional domains that can be reached via this RP
uint32_t maxOutboundPeerConnectionIntervalDeltaSecs
[Optional, Default 15] Sets the delta value for the maximum number of seconds to delay when attemptin...
TuningSettings tuning
[Optional] Low-level tuning
RallypointAdvertisingSettings advertising
[Optional] Settings for advertising.
Featureset featureset
Optional feature set.
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the Rallypoint's interaction with an external health-checker such as a load-balanc...
std::vector< RallypointExtendedGroupRestriction > extendedGroupRestrictions
Extended group restrictions.
int ioPools
Number of threading pools to create for network I/O. Default is -1 which creates 1 I/O pool per CPU c...
RallypointServerStatusReportConfiguration statusReport
Details for producing a status report.
std::vector< NamedIdentity > additionalIdentities
[Optional] List of additional named identities
IgmpSnooping igmpSnooping
IGMP snooping configuration.
RallypointServerLinkGraph linkGraph
Details for producing a Graphviz-compatible link graph.
RallypointServerLimits limits
Details for capacity limits and determining processing load.
PeeringConfiguration peeringConfiguration
Internal - not serialized.
std::string domainName
[Optional] This Rallypoint's domain name
bool allowMulticastForwarding
Allows traffic received on unicast links to be forwarded to the multicast network.
RallypointWebsocketSettings websocket
[Optional] Settings for websocket operation
std::string peeringConfigurationFileCommand
Command-line to execute that returns a JSON array of Rallypoint peers to connect to.
RallypointServerRouteMap routeMap
Details for producing a report containing the route map.
StreamIdPrivacyType_t streamIdPrivacyType
[Optional, default sptDefault] Modes for stream ID transformation.
bool allowPeerForwarding
Set to true to allow forwarding of packets received from other Rallypoints to all other Rallypoints....
TcpNetworkTxOptions tcpTxOptions
Tx options for TCP.
RallypointUdpStreaming udpStreaming
Optional configuration for high-performance UDP streaming.
bool forwardMulticastAddressing
Enables forwarding of multicast addressing to peer Rallypoints.
std::vector< RallypointRpRtTimingBehavior > peerRtBehaviors
[Optional] Array of behaviors for roundtrip times to peers
std::string id
A unqiue identifier for the Rallypoint.
bool disableLoopDetection
If true, turns off loop detection.
std::vector< std::string > blockedDomains
[Optional] List of domains that explictly MAY NOT connect to this RP
std::vector< std::string > allowedDomains
[Optional] List of domains that explicitly MAY connect to this RP
std::string certStoreFileName
Path to the certificate store.
RallypointQuicSettings quic
[Optional] Settings for QUIC operation (UDP listener). Reuses the Rallypoint TLS certificate.
int peeringConfigurationFileCheckSecs
Number of seconds between checks to see if the peering configuration has been updated....
Tls tls
Details concerning Transport Layer Security.
RtiCloudSettings rtiCloud
[Optional] Rally Tactical cloud (RTI) integration.
TODO: Configuration for Rallypoint limits.
uint32_t maxQOpsPerSec
Maximum number of queue operations per second (0 = unlimited)
uint32_t maxInboundBacklog
Maximum number of inbound backlog requests the Rallypoint will accept.
uint32_t normalPriorityQueueThreshold
Number of normal priority queue operations after which new connections will not be accepted.
uint32_t maxPeers
Maximum number of peers (0 = unlimited)
uint32_t maxTxBytesPerSec
Maximum number of bytes transmitted per second (0 = unlimited)
uint32_t maxTxPacketsPerSec
Maximum number of packets transmitted per second (0 = unlimited)
uint32_t maxRegisteredStreams
Maximum number of registered streams (0 = unlimited)
uint32_t maxClients
Maximum number of clients (0 = unlimited)
uint32_t maxMulticastReflectors
Maximum number of multicastReflectors (0 = unlimited)
uint32_t maxStreamPaths
Maximum number of bidirectional stream paths (0 = unlimited)
uint32_t lowPriorityQueueThreshold
Number of low priority queue operations after which new connections will not be accepted.
uint32_t maxRxBytesPerSec
Maximum number of bytes received per second (0 = unlimited)
uint32_t denyNewConnectionCpuThreshold
The CPU utilization threshold percentage (0-100) beyond which new connections are denied.
uint32_t maxRxPacketsPerSec
Maximum number of packets received per second (0 = unlimited)
uint32_t warnAtCpuThreshold
The CPU utilization threshold percentage (0-100) beyond which warnings are logged.
std::string leafRpStyling
std::string coreRpStyling
bool includeDigraphEnclosure
std::string clientStyling
TODO: Configuration for the Rallypoint status report file.
bool includePeerLinkDetails
bool includeClientLinkDetails
bool resetCountersAfterExport
ExportFormat_t
Enum describing format(s) for the stream stats export.
Streaming configuration for RP clients.
int listenPort
UDP port to listen on. Default is 7444.
TxPriority_t priority
[Optional, Default: priVoice] Transmission priority. This has meaning on some operating systems based...
RallypointUdpStreamingIpvX ipv4
IPv4
bool enabled
[Optional, Default true] If true, enables UDP streaming unless turned off on a per-family basis.
CryptoType_t cryptoType
[Optional, Default ctSharedKeyAes256FullIv] The crypto method to be used
int ttl
[Optional, Default: 64] Time to live or hop limit.
CryptoType_t
Enum describing UDP streaming modes.
int keepaliveIntervalSecs
[Optional, Default: 15] Interval (seconds) at which to send UDP keepalives
RallypointUdpStreamingIpvX ipv6
IPv6.
Streaming configuration for RP clients.
bool enabled
[Optional, Default true] If true, enables UDP streaming for vX.
NetworkAddress external
Network address for external entities to transmit to. Defaults to the address of the local interface ...
Defines settings for Rallypoint websockets functionality.
int listenPort
Listen port (TCP). Default is 8443.
SecurityCertificate certificate
Certificate to be used for WebSockets.
bool requireTls
[Default: false] Indicates whether TLS is required
bool enabled
[Default: false] Websocket is enabled
bool requireClientCertificate
[Default: false] Indicates whether the client is required to present a certificate
Options for Ranger packets.
int count
[Optional, Default: 5] Number of ranger packets to send when a new interval starts
int hangTimerSecs
[Optional, Default: -1] Number of seconds since last packet transmission before 'count' packets are s...
RFC4733 event information.
bool end
Indicates whether this is the end of the event.
Helper class for serializing and deserializing the RiffDescriptor JSON.
CertificateDescriptor certDescriptor
[Optional] X.509 certificate parsed into a CertificateDescriptor object.
std::string meta
[Optional] Meta data associated with the file - typically a stringified JSON object.
bool verified
True if the ECDSA signature is verified.
int channels
Number of audio channels.
std::string signature
[Optional] ECDSA signature
std::string certPem
[Optional] X.509 certificate in PEM format used to sign the RIFF file.
int sampleCount
Number of audio samples.
std::string file
Name of the RIFF file.
Optional Rally Tactical cloud (RTI) integration (Rallypoint, Engage Bridge Service,...
std::string serviceBaseUrlPrefix
[Optional, Default: "prod.com"] Prefix used to construct default RTI SaaS base URL as "<prefix>....
std::string enrollmentCode
Enrollment code for the RTI cloud service.
bool enabled
Master switch: when true, the product uses RTI cloud HTTP APIs (token + heartbeat).
std::string name
Name of the CODEC.
int engageType
An integer representing the codec type.
int rtpPayloadType
The RTP payload type identifier.
RtpPayloadTypeTranslation.
uint16_t engage
The payload type used by Engage.
uint16_t external
The payload type used by the external entity.
Configuration for the optional RtpProfile.
JitterMode_t
Jitter buffer mode.
int signalledInboundProcessorInactivityMs
[Optional, Default: inboundProcessorInactivityMs * 4] The number of milliseconds of RTP inactivity on...
int jitterUnderrunReductionAger
[Optional, Default: 100] Number of jitter buffer operations after which to reduce any underrun
int jitterMinMs
[Optional, Default: 100] Low-water mark for jitter buffers that are in a buffering state.
int jitterMaxFactor
[Optional, Default: 8] The factor by which to multiply the jitter buffer's active low-water to determ...
int inboundProcessorInactivityMs
[Optional, Default: 500] The number of milliseconds of RTP inactivity before heuristically determinin...
JitterMode_t mode
[Optional, Default: jmStandard] Specifies the operation mode (see JitterMode_t).
int jitterForceTrimAtMs
[Optional, Default: 0] Forces trimming of the jitter buffer if the queue length is greater (and not z...
int latePacketSequenceRange
[Optional, Default: 5] The delta in RTP sequence numbers in order to heuristically determine the star...
int jitterMaxExceededClipHangMs
[Optional, Default: 1500] Number of milliseconds for which the jitter buffer may exceed max before cl...
int jitterTrimPercentage
[Optional, Default: 10] The percentage of the overall jitter buffer sample count to trim when potenti...
int jitterMaxTrimMs
[Optional, Default: 250] Maximum number of milliseconds to be trimmed from a jitter buffer at any one...
int jitterMaxMs
[Optional, Default: 10000] Maximum number of milliseconds allowed in the queue
int latePacketTimestampRangeMs
[Optional, Default: 500] The delta in milliseconds in order to heuristically determine the start of a...
int jitterMaxExceededClipPerc
[Optional, Default: 10] Percentage by which maximum number of samples in the queue exceeded computed ...
int zombieLifetimeMs
[Optional, Default: 15000] The number of milliseconds that a "zombified" RTP processor is kept around...
int rtcpPresenceTimeoutMs
[Optional, Default: 45000] Timeout for RTCP presence.
int jitterUnderrunReductionThresholdMs
[Optional, Default: 1500] Number of milliseconds of error-free operations in a jitter buffer before t...
Configuration for a secure signature.
std::string signature
Contains the signature.
std::string certificate
Contains the PEM-formatted text of the certificate.
Configuration for a Security Certificate used in various configurations.
std::string key
As for above but for certificate's private key.
std::string certificate
Contains the PEM-formatted text of the certificate, OR, a reference to a PEM file denoted by "@file:/...
std::string alias
[Optional] An alias
std::string nodeId
[Optional] A node ID
Process-level HTTP POST settings for status report uploads.
RestrictionType_t type
Type indicating how the elements are to be treated.
std::vector< std::string > elements
List of elements.
RestrictionElementType_t elementsType
Type indicating what kind of data each element contains.
std::string nodeId
A unique identifier for the asset.
Group group
Details for the talkgroup.
Network Transmit Options for TCP.
Parameters for querying the group timeline.
bool onlyCommitted
Include only committed (not in-progress) events.
uint64_t startedOnOrAfter
Include events that started on or after this UNIX millisecond timestamp.
int onlyType
Include events for this type.
long maxCount
Maximum number of records to return.
uint64_t endedOnOrBefore
Include events that ended on or after this UNIX millisecond timestamp.
std::string sql
Ignore all other settings for SQL construction and use this query string instead.
bool mostRecentFirst
Sorted results with most recent timestamp first.
std::string onlyNodeId
Include events for this transmitter node ID.
int onlyDirection
Include events for this direction.
int onlyTxId
Include events for this transmission ID.
std::string onlyAlias
Include events for this transmitter alias.
TODO: Transport Security Layer (TLS) settings.
bool verifyPeers
[Optional, Default: true] When true, checks the far-end certificate validity and Engage-specific TLS ...
StringRestrictionList subjectRestrictions
[NOT USED AT THIS TIME]
std::vector< std::string > caCertificates
[Optional] Array of CA certificates (PEM or "@" file/certstore references) to be used to validate far...
StringRestrictionList issuerRestrictions
[NOT USED AT THIS TIME]
bool allowSelfSignedCertificates
[Optional, Default: false] When true, accepts far-end certificates that are self-signed.
std::vector< std::string > crlSerials
[Optional] Array of serial numbers certificates that have been revoked
Translation configuration.
std::vector< TranslationSession > sessions
Array of sessions in the configuration.
std::vector< Group > groups
Array of groups in the configuration.
Translation session settings.
std::vector< std::string > groups
List of group IDs to be included in the session.
bool enabled
[Optional, Default: true] Enable the session
Description of a transport impairment.
int lossPercentage
[Optional, Default: 0] Percentage of packets to drop (0-100).
int jitterMs
[Optional, Default: 0] Max random delay in milliseconds applied to a packet.
int errorPercentage
[Optional, Default: 0] When > 0, percentage of packets forced to error path.
uint32_t maxActiveBlobObjects
[Optional, Default 0 (no max)] Maximum number of blob objects allowed to be active
uint32_t maxActiveRtpProcessors
[Optional, Default 0 (no max)] Maximum number concurrent RTP processors
uint32_t maxPooledBufferMb
[Optional, Default 0 (no max)] Maximum number of buffer bytes allowed to be pooled
uint32_t maxActiveBufferObjects
[Optional, Default 0 (no max)] Maximum number of buffer objects allowed to be active
uint32_t maxPooledBufferObjects
[Optional, Default 0 (no max)] Maximum number of buffer objects allowed to be pooled
uint32_t maxPooledRtpObjects
[Optional, Default 0 (no max)] Maximum number of RTP objects allowed to be pooled
uint32_t maxPooledBlobMb
[Optional, Default 0 (no max)] Maximum number of blob bytes allowed to be pooled
uint32_t maxPooledRtpMb
[Optional, Default 0 (no max)] Maximum number of RTP bytes allowed to be pooled
uint32_t maxActiveRtpObjects
[Optional, Default 0 (no max)] Maximum number of RTP objects allowed to be active
uint32_t maxPooledBlobObjects
[Optional, Default 0 (no max)] Maximum number of blob objects allowed to be pooled
Configuration for the audio transmit properties for a group.
int startTxNotifications
[Optional, Default: 5] Number of start TX notifications to send when TX is about to begin.
int framingMs
[Optional, Default: 60] Audio sample framing size in milliseconds.
HeaderExtensionType_t hdrExtType
[Optional, Default: hetEngageStandard] The header extension type to use. See HeaderExtensionType_t fo...
int maxTxSecs
[Optional, Default: 0] Maximum number of seconds the Engine will transmit for.
uint32_t internalKey
[INTERNAL] The Engine-assigned key for the codec
bool enabled
[Optional, Default: true] Audio transmission is enabled
bool fdx
[Optional, Default: false] Indicates if full duplex audio is supported.
int initialHeaderBurst
[Optional, Default: 5] Number of headers to send at the beginning of a talk burst.
bool resetRtpOnTx
[Optional, Default: true] Resets RTP counters on each new transmission.
bool dtx
[Optional, Default: false] Support discontinuous transmission on those CODECs that allow it
std::string encoderName
[Optional] The name of the external codec - overrides encoder
TxCodec_t encoder
[Optional, Default: ctOpus8000] Specifies the Codec Type to use for the transmission....
HeaderExtensionType_t
Header extension types.
int blockCount
[Optional, Default: 0] If >0, derives framingMs based on the encoder's internal operation
int smoothedHangTimeMs
[Optional, Default: 0] Hang timer for ongoing TX - only applicable if enableSmoothing is true
int customRtpPayloadType
[Optional, Default: -1] The custom RTP payload type to use for transmission. A value of -1 causes the...
bool noHdrExt
[Optional, Default: false] Set to true whether to disable header extensions.
bool enableSmoothing
[Optional, Default: true] Smooth input audio
int trailingHeaderBurst
[Optional, Default: 5] Number of headers to send at the conclusion of a talk burst.
int extensionSendInterval
[Optional, Default: 10] The number of packets when to periodically send the header extension.
TxCodec_t
Codec Types enum.
Optional audio streaming from a URI for engageBeginGroupTxAdvanced.
std::string uri
URI for the file.
int repeatCount
[Optional, Default: 0] Number of times to repeat
Voice Activity Detection settings.
bool enabled
[Optional, Default: false] Enable VAD
Mode_t mode
[Optional, Default: vamDefault] Specifies VAD mode. See Mode_t for all modes
Voice to voice session settings.
std::vector< std::string > groups
List of group IDs to be included in the session.
bool enabled
[Optional, Default: true] Enable the session
int intervalMs
[Optional, Default: 5000] Interval at which checks are made.
int hangDetectionMs
[Optional, Default: 2000] Number of milliseconds that must pass before a hang is assumed.
int slowExecutionThresholdMs
[Optional, Default: 100] Maximum number of milliseconds that a task may take before being considered ...
bool abortOnHang
[Optional, Default: true] If true, aborts the process if a hang is detected.
bool enabled
[Optional, Default: true] Enables/disables a watchdog.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * OID_RTS_PEM
Rally Tactical Systems' PEN as assigned by IANA.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * OID_RTS_CERT_SUBJ_ACCESS_TAGS
The link to the Rallypoint is down.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_EXCLUDED_SERIAL
The Rallypoint denied the registration request because the far-end's certificate serial number has be...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_SECURITY_CLASSIFICATION_LEVEL_TOO_HIGH
The Rallypoint has denied the registration because the registration is for a security level not allow...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_ON_BLACKLIST
The Rallypoint denied the registration request because the far-end does appears in blackist criteria.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_EXCLUDED_FINGERPRINT
The Rallypoint denied the registration request because the far-end's certificate fingerprint has been...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NO_ISSUER
The Rallypoint denied the registration request because the far-end's certificate does not have an an ...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_GENERAL_DENIAL
The Rallypoint has denied the registration for no specific reason.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NO_ACCESS_TAG
The Rallypoint denied the registration request because the far-end's certificate does not have an acc...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NO_SUBJECT
The Rallypoint denied the registration request because the far-end's certificate does not have an an ...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NOT_ALLOWED
The Rallypoint is not accepting registration for the group at this time.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_EXCLUDED_SUBJECT
The Rallypoint denied the registration request because the far-end's certificate subject has been exc...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NO_LINK
The link to the Rallypoint is down.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NO_SERIAL
The Rallypoint denied the registration request because the far-end's certificate does not have an an ...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NO_FINGERPRINT
The Rallypoint denied the registration request because the far-end's certificate does not have an an ...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_EXCLUDED_ISSUER
The Rallypoint denied the registration request because the far-end's certificate issuer has been excl...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_EXCLUDED_ACCESS_TAG
The Rallypoint denied the registration request because the far-end's certificate does not have an acc...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_UNREGISTERED
The group has been gracefully unregistered from the Rallypoint.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NO_REAON
No particular reason was provided.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_DISCONNECTED_REASON_NOT_ON_WHITELIST
The Rallypoint denied the registration request because the far-end does not appear in any whitelist c...
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_DOMO
The source is Domo Tactical via Magellan discovery.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_CISTECH
The source is CISTECH via Magellan discovery.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_CORE
The source is a Magellan-capable entity.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_INTERNAL
Internal to Engage.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_TAIT
The source is Tait via Magellan discovery.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_TRELLISWARE
The source is Trellisware via Magellan discovery.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_SILVUS
The source is Silvus via Magellan discovery.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_VOCALITY
The source is Vocality via Magellan discovery.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_PERSISTENT
The source is Persistent Systems via Magellan discovery.
static ENGAGE_IGNORE_COMPILER_UNUSED_WARNING const char * GROUP_SOURCE_ENGAGE_MAGELLAN_KENWOOD
The source is Kenwood via Magellan discovery.
static const uint8_t ENGAGE_DEFAULT_BLOB_RTP_PAYLOAD_TYPE
The default RTP payload type Engage uses for RTP blob messaging.