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()
2649 int applicationPercentage;
2662 applicationPercentage = 0;
2665 errorPercentage = 0;
2669 static void to_json(nlohmann::json& j,
const TransportImpairment& p)
2672 TOJSON_IMPL(applicationPercentage),
2673 TOJSON_IMPL(jitterMs),
2674 TOJSON_IMPL(lossPercentage),
2675 TOJSON_IMPL(errorPercentage)
2678 static void from_json(
const nlohmann::json& j, TransportImpairment& p)
2681 getOptional<int>(
"applicationPercentage", p.applicationPercentage, j, 0);
2682 getOptional<int>(
"jitterMs", p.jitterMs, j, 0);
2683 getOptional<int>(
"lossPercentage", p.lossPercentage, j, 0);
2684 getOptional<int>(
"errorPercentage", p.errorPercentage, j, 0);
2688 JSON_SERIALIZED_CLASS(NsmNetworking)
2702 IMPLEMENT_JSON_SERIALIZATION()
2706 std::string address;
2713 std::string cryptoPassword;
2714 int maxUdpPayloadBytes;
2726 priority = TxPriority_t::priVoice;
2728 rxImpairment.clear();
2729 txImpairment.clear();
2730 cryptoPassword.clear();
2731 maxUdpPayloadBytes = 800;
2735 static void to_json(nlohmann::json& j,
const NsmNetworking& p)
2737 nlohmann::json pathJson;
2738 to_json(pathJson, p.address);
2742 TOJSON_IMPL(priority),
2743 TOJSON_IMPL(txOversend),
2744 TOJSON_IMPL(rxImpairment),
2745 TOJSON_IMPL(txImpairment),
2746 TOJSON_IMPL(cryptoPassword),
2747 TOJSON_IMPL(maxUdpPayloadBytes)
2750 static void from_json(
const nlohmann::json& j, NsmNetworking& p)
2753 getOptional<std::string>(
"address", p.address, j);
2754 getOptional<int>(
"port", p.port, j, 8513);
2755 getOptional<int>(
"ttl", p.ttl, j, 1);
2756 getOptional<TxPriority_t>(
"priority", p.priority, j, TxPriority_t::priVoice);
2757 getOptional<int>(
"txOversend", p.txOversend, j, 0);
2758 getOptional<TransportImpairment>(
"rxImpairment", p.rxImpairment, j);
2759 getOptional<TransportImpairment>(
"txImpairment", p.txImpairment, j);
2760 getOptional(
"cryptoPassword", p.cryptoPassword, j, EMPTY_STRING);
2761 getOptional<int>(
"maxUdpPayloadBytes", p.maxUdpPayloadBytes, j, 800);
2765 JSON_SERIALIZED_CLASS(NsmNodeResource)
2773 IMPLEMENT_JSON_SERIALIZATION()
2794 static void to_json(nlohmann::json& j,
const NsmNodeResource& p)
2798 TOJSON_IMPL(priority)
2801 static void from_json(
const nlohmann::json& j, NsmNodeResource& p)
2804 getOptional<std::string>(
"id", p.id, j);
2805 getOptional<int>(
"priority", p.priority, j, -1);
2812 if (!j.contains(
"resources") || !j[
"resources"].is_array())
2816 for (
const auto& el : j[
"resources"])
2818 if (!el.is_object())
2824 getOptional<std::string>(
"id", nr.
id, el);
2825 getOptional<int>(
"priority", nr.
priority, el, -1);
2835 JSON_SERIALIZED_CLASS(NsmConfiguration)
2846 IMPLEMENT_JSON_SERIALIZATION()
2854 std::vector<NsmNodeResource> resources;
2858 int transitionSecsFactor;
2863 bool logCommandOutput;
2873 favorUptime =
false;
2876 tokenStart = 1000000;
2879 transitionSecsFactor = 3;
2880 internalMultiplier = 1;
2881 goingActiveRandomDelayMs = 500;
2882 logCommandOutput =
false;
2886 static void to_json(nlohmann::json& j,
const NsmConfiguration& p)
2890 TOJSON_IMPL(favorUptime),
2891 TOJSON_IMPL(networking),
2892 TOJSON_IMPL(resources),
2893 TOJSON_IMPL(tokenStart),
2894 TOJSON_IMPL(tokenEnd),
2895 TOJSON_IMPL(intervalSecs),
2896 TOJSON_IMPL(transitionSecsFactor),
2897 TOJSON_IMPL(internalMultiplier),
2898 TOJSON_IMPL(goingActiveRandomDelayMs),
2899 TOJSON_IMPL(logCommandOutput),
2902 static void from_json(
const nlohmann::json& j, NsmConfiguration& p)
2905 getOptional(
"id", p.id, j);
2906 getOptional<bool>(
"favorUptime", p.favorUptime, j,
false);
2907 getOptional<NsmNetworking>(
"networking", p.networking, j);
2909 getOptional<int>(
"tokenStart", p.tokenStart, j, 1000000);
2910 getOptional<int>(
"tokenEnd", p.tokenEnd, j, 2000000);
2911 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 1);
2912 getOptional<int>(
"transitionSecsFactor", p.transitionSecsFactor, j, 3);
2913 getOptional<int>(
"internalMultiplier", p.internalMultiplier, j, 1);
2914 getOptional<int>(
"goingActiveRandomDelayMs", p.goingActiveRandomDelayMs, j, 500);
2915 getOptional<bool>(
"logCommandOutput", p.logCommandOutput, j,
false);
2920 JSON_SERIALIZED_CLASS(Rallypoint)
2930 IMPLEMENT_JSON_SERIALIZATION()
3039 certificate.clear();
3040 certificateKey.clear();
3041 caCertificates.clear();
3043 transactionTimeoutMs = 0;
3044 disableMessageSigning =
false;
3045 connectionTimeoutSecs = 0;
3046 tcpTxOptions.clear();
3048 protocol = rppTlsTcp;
3050 additionalProtocols.clear();
3053 bool matches(
const Rallypoint& other)
3055 if(!host.matches(other.host))
3060 if(protocol != other.protocol)
3065 if(path.compare(other.path) != 0)
3070 if(certificate.compare(other.certificate) != 0)
3075 if(certificateKey.compare(other.certificateKey) != 0)
3080 if(verifyPeer != other.verifyPeer)
3085 if(allowSelfSignedCertificate != other.allowSelfSignedCertificate)
3090 if(caCertificates.size() != other.caCertificates.size())
3095 for(
size_t x = 0; x < caCertificates.size(); x++)
3099 for(
size_t y = 0; y < other.caCertificates.size(); y++)
3101 if(caCertificates[x].compare(other.caCertificates[y]) == 0)
3114 if(transactionTimeoutMs != other.transactionTimeoutMs)
3119 if(disableMessageSigning != other.disableMessageSigning)
3123 if(connectionTimeoutSecs != other.connectionTimeoutSecs)
3127 if(tcpTxOptions.
priority != other.tcpTxOptions.priority)
3131 if(sni.compare(other.sni) != 0)
3140 static void to_json(nlohmann::json& j,
const Rallypoint& p)
3144 TOJSON_IMPL(certificate),
3145 TOJSON_IMPL(certificateKey),
3146 TOJSON_IMPL(verifyPeer),
3147 TOJSON_IMPL(allowSelfSignedCertificate),
3148 TOJSON_IMPL(caCertificates),
3149 TOJSON_IMPL(transactionTimeoutMs),
3150 TOJSON_IMPL(disableMessageSigning),
3151 TOJSON_IMPL(connectionTimeoutSecs),
3152 TOJSON_IMPL(tcpTxOptions),
3154 TOJSON_IMPL(protocol),
3156 TOJSON_IMPL(additionalProtocols)
3160 static void from_json(
const nlohmann::json& j, Rallypoint& p)
3163 j.at(
"host").get_to(p.host);
3164 getOptional(
"certificate", p.certificate, j);
3165 getOptional(
"certificateKey", p.certificateKey, j);
3166 getOptional<bool>(
"verifyPeer", p.verifyPeer, j,
true);
3167 getOptional<bool>(
"allowSelfSignedCertificate", p.allowSelfSignedCertificate, j,
false);
3168 getOptional<std::vector<std::string>>(
"caCertificates", p.caCertificates, j);
3169 getOptional<int>(
"transactionTimeoutMs", p.transactionTimeoutMs, j, 0);
3170 getOptional<bool>(
"disableMessageSigning", p.disableMessageSigning, j,
false);
3171 getOptional<int>(
"connectionTimeoutSecs", p.connectionTimeoutSecs, j, 0);
3172 getOptional<TcpNetworkTxOptions>(
"tcpTxOptions", p.tcpTxOptions, j);
3173 getOptional<std::string>(
"sni", p.sni, j);
3174 getOptional<Rallypoint::RpProtocol_t>(
"protocol", p.protocol, j, Rallypoint::RpProtocol_t::rppTlsTcp);
3175 getOptional<std::string>(
"path", p.path, j);
3176 getOptional<std::string>(
"additionalProtocols", p.additionalProtocols, j);
3180 JSON_SERIALIZED_CLASS(RallypointCluster)
3193 IMPLEMENT_JSON_SERIALIZATION()
3209 } ConnectionStrategy_t;
3233 connectionStrategy = csRoundRobin;
3234 rallypoints.clear();
3236 connectionTimeoutSecs = 5;
3237 transactionTimeoutMs = 10000;
3241 static void to_json(nlohmann::json& j,
const RallypointCluster& p)
3244 TOJSON_IMPL(connectionStrategy),
3245 TOJSON_IMPL(rallypoints),
3246 TOJSON_IMPL(rolloverSecs),
3247 TOJSON_IMPL(connectionTimeoutSecs),
3248 TOJSON_IMPL(transactionTimeoutMs)
3251 static void from_json(
const nlohmann::json& j, RallypointCluster& p)
3254 getOptional<RallypointCluster::ConnectionStrategy_t>(
"connectionStrategy", p.connectionStrategy, RallypointCluster::ConnectionStrategy_t::csRoundRobin);
3255 getOptional<std::vector<Rallypoint>>(
"rallypoints", p.rallypoints, j);
3256 getOptional<int>(
"rolloverSecs", p.rolloverSecs, j, 10);
3257 getOptional<int>(
"connectionTimeoutSecs", p.connectionTimeoutSecs, j, 5);
3258 getOptional<int>(
"transactionTimeoutMs", p.transactionTimeoutMs, j, 10000);
3263 JSON_SERIALIZED_CLASS(NetworkDeviceDescriptor)
3275 IMPLEMENT_JSON_SERIALIZATION()
3316 manufacturer.clear();
3319 serialNumber.clear();
3324 virtual std::string toString()
3328 snprintf(buff,
sizeof(buff),
"deviceId=%d, name=%s, manufacturer=%s, model=%s, hardwareId=%s, serialNumber=%s, type=%s, extra=%s",
3331 manufacturer.c_str(),
3334 serialNumber.c_str(),
3338 return std::string(buff);
3342 static void to_json(nlohmann::json& j,
const NetworkDeviceDescriptor& p)
3345 TOJSON_IMPL(deviceId),
3347 TOJSON_IMPL(manufacturer),
3349 TOJSON_IMPL(hardwareId),
3350 TOJSON_IMPL(serialNumber),
3355 static void from_json(
const nlohmann::json& j, NetworkDeviceDescriptor& p)
3358 getOptional<int>(
"deviceId", p.deviceId, j, 0);
3359 getOptional(
"name", p.name, j);
3360 getOptional(
"manufacturer", p.manufacturer, j);
3361 getOptional(
"model", p.model, j);
3362 getOptional(
"hardwareId", p.hardwareId, j);
3363 getOptional(
"serialNumber", p.serialNumber, j);
3364 getOptional(
"type", p.type, j);
3365 getOptional(
"extra", p.extra, j);
3369 JSON_SERIALIZED_CLASS(AudioGate)
3380 IMPLEMENT_JSON_SERIALIZATION()
3419 static void to_json(nlohmann::json& j,
const AudioGate& p)
3422 TOJSON_IMPL(enabled),
3423 TOJSON_IMPL(useVad),
3424 TOJSON_IMPL(hangMs),
3425 TOJSON_IMPL(windowMin),
3426 TOJSON_IMPL(windowMax),
3427 TOJSON_IMPL(coefficient)
3430 static void from_json(
const nlohmann::json& j, AudioGate& p)
3433 getOptional<bool>(
"enabled", p.enabled, j,
false);
3434 getOptional<bool>(
"useVad", p.useVad, j,
false);
3435 getOptional<uint32_t>(
"hangMs", p.hangMs, j, 1500);
3436 getOptional<uint32_t>(
"windowMin", p.windowMin, j, 25);
3437 getOptional<uint32_t>(
"windowMax", p.windowMax, j, 125);
3438 getOptional<double>(
"coefficient", p.coefficient, j, 1.75);
3442 JSON_SERIALIZED_CLASS(TxAudio)
3457 IMPLEMENT_JSON_SERIALIZATION()
3458 IMPLEMENT_JSON_DOCUMENTATION(
TxAudio)
3629 hetEngageStandard = 0,
3632 hetNatoStanga5643 = 1
3633 } HeaderExtensionType_t;
3715 encoder = TxAudio::TxCodec_t::ctUnknown;
3716 encoderName.clear();
3722 extensionSendInterval = 10;
3723 initialHeaderBurst = 5;
3724 trailingHeaderBurst = 5;
3725 startTxNotifications = 5;
3726 customRtpPayloadType = -1;
3728 resetRtpOnTx =
true;
3729 enableSmoothing =
true;
3731 smoothedHangTimeMs = 0;
3732 hdrExtType = HeaderExtensionType_t::hetEngageStandard;
3736 static void to_json(nlohmann::json& j,
const TxAudio& p)
3739 TOJSON_IMPL(enabled),
3740 TOJSON_IMPL(encoder),
3741 TOJSON_IMPL(encoderName),
3742 TOJSON_IMPL(framingMs),
3743 TOJSON_IMPL(blockCount),
3745 TOJSON_IMPL(noHdrExt),
3746 TOJSON_IMPL(maxTxSecs),
3747 TOJSON_IMPL(extensionSendInterval),
3748 TOJSON_IMPL(initialHeaderBurst),
3749 TOJSON_IMPL(trailingHeaderBurst),
3750 TOJSON_IMPL(startTxNotifications),
3751 TOJSON_IMPL(customRtpPayloadType),
3752 TOJSON_IMPL(resetRtpOnTx),
3753 TOJSON_IMPL(enableSmoothing),
3755 TOJSON_IMPL(smoothedHangTimeMs),
3756 TOJSON_IMPL(hdrExtType)
3761 static void from_json(
const nlohmann::json& j, TxAudio& p)
3764 getOptional<bool>(
"enabled", p.enabled, j,
true);
3765 getOptional<TxAudio::TxCodec_t>(
"encoder", p.encoder, j, TxAudio::TxCodec_t::ctOpus8000);
3766 getOptional<std::string>(
"encoderName", p.encoderName, j, EMPTY_STRING);
3767 getOptional(
"framingMs", p.framingMs, j, 60);
3768 getOptional(
"blockCount", p.blockCount, j, 0);
3769 getOptional(
"fdx", p.fdx, j,
false);
3770 getOptional(
"noHdrExt", p.noHdrExt, j,
false);
3771 getOptional(
"maxTxSecs", p.maxTxSecs, j, 0);
3772 getOptional(
"extensionSendInterval", p.extensionSendInterval, j, 10);
3773 getOptional(
"initialHeaderBurst", p.initialHeaderBurst, j, 5);
3774 getOptional(
"trailingHeaderBurst", p.trailingHeaderBurst, j, 5);
3775 getOptional(
"startTxNotifications", p.startTxNotifications, j, 5);
3776 getOptional(
"customRtpPayloadType", p.customRtpPayloadType, j, -1);
3777 getOptional(
"resetRtpOnTx", p.resetRtpOnTx, j,
true);
3778 getOptional(
"enableSmoothing", p.enableSmoothing, j,
true);
3779 getOptional(
"dtx", p.dtx, j,
false);
3780 getOptional(
"smoothedHangTimeMs", p.smoothedHangTimeMs, j, 0);
3781 getOptional(
"hdrExtType", p.hdrExtType, j, TxAudio::HeaderExtensionType_t::hetEngageStandard);
3787 JSON_SERIALIZED_CLASS(AudioRegistryDevice)
3799 IMPLEMENT_JSON_SERIALIZATION()
3838 manufacturer.clear();
3840 serialNumber.clear();
3845 virtual std::string toString()
3849 snprintf(buff,
sizeof(buff),
"hardwareId=%s, isDefault=%d, name=%s, manufacturer=%s, model=%s, serialNumber=%s, type=%s, extra=%s",
3853 manufacturer.c_str(),
3855 serialNumber.c_str(),
3859 return std::string(buff);
3863 static void to_json(nlohmann::json& j,
const AudioRegistryDevice& p)
3866 TOJSON_IMPL(hardwareId),
3867 TOJSON_IMPL(isDefault),
3869 TOJSON_IMPL(manufacturer),
3871 TOJSON_IMPL(serialNumber),
3876 static void from_json(
const nlohmann::json& j, AudioRegistryDevice& p)
3879 getOptional<std::string>(
"hardwareId", p.hardwareId, j, EMPTY_STRING);
3880 getOptional<bool>(
"isDefault", p.isDefault, j,
false);
3881 getOptional(
"name", p.name, j);
3882 getOptional(
"manufacturer", p.manufacturer, j);
3883 getOptional(
"model", p.model, j);
3884 getOptional(
"serialNumber", p.serialNumber, j);
3885 getOptional(
"type", p.type, j);
3886 getOptional(
"extra", p.extra, j);
3891 JSON_SERIALIZED_CLASS(AudioRegistry)
3903 IMPLEMENT_JSON_SERIALIZATION()
3924 virtual std::string toString()
3926 return std::string(
"");
3930 static void to_json(nlohmann::json& j,
const AudioRegistry& p)
3933 TOJSON_IMPL(inputs),
3934 TOJSON_IMPL(outputs)
3937 static void from_json(
const nlohmann::json& j, AudioRegistry& p)
3940 getOptional<std::vector<AudioRegistryDevice>>(
"inputs", p.inputs, j);
3941 getOptional<std::vector<AudioRegistryDevice>>(
"outputs", p.outputs, j);
3945 JSON_SERIALIZED_CLASS(AudioDeviceDescriptor)
3957 IMPLEMENT_JSON_SERIALIZATION()
4051 direction = dirUnknown;
4052 boostPercentage = 0;
4057 manufacturer.clear();
4060 serialNumber.clear();
4066 virtual std::string toString()
4070 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",
4078 manufacturer.c_str(),
4081 serialNumber.c_str(),
4087 return std::string(buff);
4091 static void to_json(nlohmann::json& j,
const AudioDeviceDescriptor& p)
4094 TOJSON_IMPL(deviceId),
4095 TOJSON_IMPL(samplingRate),
4096 TOJSON_IMPL(channels),
4097 TOJSON_IMPL(direction),
4098 TOJSON_IMPL(boostPercentage),
4099 TOJSON_IMPL(isAdad),
4101 TOJSON_IMPL(manufacturer),
4103 TOJSON_IMPL(hardwareId),
4104 TOJSON_IMPL(serialNumber),
4105 TOJSON_IMPL(isDefault),
4108 TOJSON_IMPL(isPresent)
4111 static void from_json(
const nlohmann::json& j, AudioDeviceDescriptor& p)
4114 getOptional<int>(
"deviceId", p.deviceId, j, 0);
4115 getOptional<int>(
"samplingRate", p.samplingRate, j, 0);
4116 getOptional<int>(
"channels", p.channels, j, 0);
4117 getOptional<AudioDeviceDescriptor::Direction_t>(
"direction", p.direction, j,
4118 AudioDeviceDescriptor::Direction_t::dirUnknown);
4119 getOptional<int>(
"boostPercentage", p.boostPercentage, j, 0);
4121 getOptional<bool>(
"isAdad", p.isAdad, j,
false);
4122 getOptional(
"name", p.name, j);
4123 getOptional(
"manufacturer", p.manufacturer, j);
4124 getOptional(
"model", p.model, j);
4125 getOptional(
"hardwareId", p.hardwareId, j);
4126 getOptional(
"serialNumber", p.serialNumber, j);
4127 getOptional(
"isDefault", p.isDefault, j);
4128 getOptional(
"type", p.type, j);
4129 getOptional(
"extra", p.extra, j);
4130 getOptional<bool>(
"isPresent", p.isPresent, j,
false);
4134 JSON_SERIALIZED_CLASS(ListOfAudioDeviceDescriptor)
4137 IMPLEMENT_JSON_SERIALIZATION()
4141 std::vector<AudioDeviceDescriptor> list;
4160 static void from_json(
const nlohmann::json& j, ListOfAudioDeviceDescriptor& p)
4163 getOptional<std::vector<AudioDeviceDescriptor>>(
"list", p.list, j);
4167 JSON_SERIALIZED_CLASS(Audio)
4177 IMPLEMENT_JSON_SERIALIZATION()
4178 IMPLEMENT_JSON_DOCUMENTATION(
Audio)
4220 inputHardwareId.clear();
4223 outputHardwareId.clear();
4225 outputLevelLeft = 100;
4226 outputLevelRight = 100;
4227 outputMuted =
false;
4231 static void to_json(nlohmann::json& j,
const Audio& p)
4234 TOJSON_IMPL(enabled),
4235 TOJSON_IMPL(inputId),
4236 TOJSON_IMPL(inputHardwareId),
4237 TOJSON_IMPL(inputGain),
4238 TOJSON_IMPL(outputId),
4239 TOJSON_IMPL(outputHardwareId),
4240 TOJSON_IMPL(outputLevelLeft),
4241 TOJSON_IMPL(outputLevelRight),
4242 TOJSON_IMPL(outputMuted)
4245 static void from_json(
const nlohmann::json& j, Audio& p)
4248 getOptional<bool>(
"enabled", p.enabled, j,
true);
4249 getOptional<int>(
"inputId", p.inputId, j, 0);
4250 getOptional<std::string>(
"inputHardwareId", p.inputHardwareId, j, EMPTY_STRING);
4251 getOptional<int>(
"inputGain", p.inputGain, j, 0);
4252 getOptional<int>(
"outputId", p.outputId, j, 0);
4253 getOptional<std::string>(
"outputHardwareId", p.outputHardwareId, j, EMPTY_STRING);
4254 getOptional<int>(
"outputGain", p.outputGain, j, 0);
4255 getOptional<int>(
"outputLevelLeft", p.outputLevelLeft, j, 100);
4256 getOptional<int>(
"outputLevelRight", p.outputLevelRight, j, 100);
4257 getOptional<bool>(
"outputMuted", p.outputMuted, j,
false);
4261 JSON_SERIALIZED_CLASS(TalkerInformation)
4273 IMPLEMENT_JSON_SERIALIZATION()
4289 matSsrcGenerated = 2
4290 } ManufacturedAliasType_t;
4335 aliasSpecializer = 0;
4337 manufacturedAliasType = ManufacturedAliasType_t::matNone;
4342 static void to_json(nlohmann::json& j,
const TalkerInformation& p)
4346 TOJSON_IMPL(nodeId),
4347 TOJSON_IMPL(rxFlags),
4348 TOJSON_IMPL(txPriority),
4350 TOJSON_IMPL(duplicateCount),
4351 TOJSON_IMPL(aliasSpecializer),
4352 TOJSON_IMPL(rxMuted),
4353 TOJSON_IMPL(manufacturedAliasType),
4357 static void from_json(
const nlohmann::json& j, TalkerInformation& p)
4360 getOptional<std::string>(
"alias", p.alias, j, EMPTY_STRING);
4361 getOptional<std::string>(
"nodeId", p.nodeId, j, EMPTY_STRING);
4362 getOptional<uint16_t>(
"rxFlags", p.rxFlags, j, 0);
4363 getOptional<int>(
"txPriority", p.txPriority, j, 0);
4364 getOptional<uint32_t>(
"txId", p.txId, j, 0);
4365 getOptional<int>(
"duplicateCount", p.duplicateCount, j, 0);
4366 getOptional<uint16_t>(
"aliasSpecializer", p.aliasSpecializer, j, 0);
4367 getOptional<bool>(
"rxMuted", p.rxMuted, j,
false);
4368 getOptional<TalkerInformation::ManufacturedAliasType_t>(
"manufacturedAliasType", p.manufacturedAliasType, j, TalkerInformation::ManufacturedAliasType_t::matNone);
4369 getOptional<uint32_t>(
"ssrc", p.ssrc, j, 0);
4373 JSON_SERIALIZED_CLASS(GroupTalkers)
4387 IMPLEMENT_JSON_SERIALIZATION()
4392 std::vector<TalkerInformation>
list;
4405 static void to_json(nlohmann::json& j,
const GroupTalkers& p)
4411 static void from_json(
const nlohmann::json& j, GroupTalkers& p)
4414 getOptional<std::vector<TalkerInformation>>(
"list", p.list, j);
4418 JSON_SERIALIZED_CLASS(Presence)
4430 IMPLEMENT_JSON_SERIALIZATION()
4431 IMPLEMENT_JSON_DOCUMENTATION(
Presence)
4479 minIntervalSecs = 5;
4480 reduceImmediacy =
false;
4484 static void to_json(nlohmann::json& j,
const Presence& p)
4487 TOJSON_IMPL(format),
4488 TOJSON_IMPL(intervalSecs),
4489 TOJSON_IMPL(listenOnly),
4490 TOJSON_IMPL(minIntervalSecs),
4491 TOJSON_IMPL(reduceImmediacy)
4494 static void from_json(
const nlohmann::json& j, Presence& p)
4497 getOptional<Presence::Format_t>(
"format", p.format, j, Presence::Format_t::pfEngage);
4498 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 30);
4499 getOptional<bool>(
"listenOnly", p.listenOnly, j,
false);
4500 getOptional<int>(
"minIntervalSecs", p.minIntervalSecs, j, 5);
4501 getOptional<bool>(
"reduceImmediacy", p.reduceImmediacy, j,
false);
4506 JSON_SERIALIZED_CLASS(Advertising)
4518 IMPLEMENT_JSON_SERIALIZATION()
4540 alwaysAdvertise =
false;
4544 static void to_json(nlohmann::json& j,
const Advertising& p)
4547 TOJSON_IMPL(enabled),
4548 TOJSON_IMPL(intervalMs),
4549 TOJSON_IMPL(alwaysAdvertise)
4552 static void from_json(
const nlohmann::json& j, Advertising& p)
4555 getOptional(
"enabled", p.enabled, j,
false);
4556 getOptional<int>(
"intervalMs", p.intervalMs, j, 20000);
4557 getOptional<bool>(
"alwaysAdvertise", p.alwaysAdvertise, j,
false);
4561 JSON_SERIALIZED_CLASS(GroupPriorityTranslation)
4573 IMPLEMENT_JSON_SERIALIZATION()
4599 static void to_json(nlohmann::json& j,
const GroupPriorityTranslation& p)
4604 TOJSON_IMPL(priority)
4607 static void from_json(
const nlohmann::json& j, GroupPriorityTranslation& p)
4610 j.at(
"rx").get_to(p.rx);
4611 j.at(
"tx").get_to(p.tx);
4612 FROMJSON_IMPL(priority,
int, 0);
4616 JSON_SERIALIZED_CLASS(GroupTimeline)
4630 IMPLEMENT_JSON_SERIALIZATION()
4649 maxAudioTimeMs = 30000;
4654 static void to_json(nlohmann::json& j,
const GroupTimeline& p)
4657 TOJSON_IMPL(enabled),
4658 TOJSON_IMPL(maxAudioTimeMs),
4659 TOJSON_IMPL(recordAudio)
4662 static void from_json(
const nlohmann::json& j, GroupTimeline& p)
4665 getOptional(
"enabled", p.enabled, j,
true);
4666 getOptional<int>(
"maxAudioTimeMs", p.maxAudioTimeMs, j, 30000);
4667 getOptional(
"recordAudio", p.recordAudio, j,
true);
4770 IMPLEMENT_JSON_SERIALIZATION()
4792 static void to_json(nlohmann::json& j,
const GroupAppTransport& p)
4795 TOJSON_IMPL(enabled),
4799 static void from_json(
const nlohmann::json& j, GroupAppTransport& p)
4802 getOptional<bool>(
"enabled", p.enabled, j,
false);
4803 getOptional<std::string>(
"id", p.id, j);
4807 JSON_SERIALIZED_CLASS(RtpProfile)
4819 IMPLEMENT_JSON_SERIALIZATION()
4837 jmReleaseOnTxEnd = 2
4900 jitterMaxMs = 10000;
4902 jitterMaxFactor = 8;
4903 jitterTrimPercentage = 10;
4904 jitterUnderrunReductionThresholdMs = 1500;
4905 jitterUnderrunReductionAger = 100;
4906 latePacketSequenceRange = 5;
4907 latePacketTimestampRangeMs = 2000;
4908 inboundProcessorInactivityMs = 500;
4909 jitterForceTrimAtMs = 0;
4910 rtcpPresenceTimeoutMs = 45000;
4911 jitterMaxExceededClipPerc = 10;
4912 jitterMaxExceededClipHangMs = 1500;
4913 zombieLifetimeMs = 15000;
4914 jitterMaxTrimMs = 250;
4915 signalledInboundProcessorInactivityMs = (inboundProcessorInactivityMs * 4);
4919 static void to_json(nlohmann::json& j,
const RtpProfile& p)
4923 TOJSON_IMPL(jitterMaxMs),
4924 TOJSON_IMPL(inboundProcessorInactivityMs),
4925 TOJSON_IMPL(jitterMinMs),
4926 TOJSON_IMPL(jitterMaxFactor),
4927 TOJSON_IMPL(jitterTrimPercentage),
4928 TOJSON_IMPL(jitterUnderrunReductionThresholdMs),
4929 TOJSON_IMPL(jitterUnderrunReductionAger),
4930 TOJSON_IMPL(latePacketSequenceRange),
4931 TOJSON_IMPL(latePacketTimestampRangeMs),
4932 TOJSON_IMPL(inboundProcessorInactivityMs),
4933 TOJSON_IMPL(jitterForceTrimAtMs),
4934 TOJSON_IMPL(jitterMaxExceededClipPerc),
4935 TOJSON_IMPL(jitterMaxExceededClipHangMs),
4936 TOJSON_IMPL(zombieLifetimeMs),
4937 TOJSON_IMPL(jitterMaxTrimMs),
4938 TOJSON_IMPL(signalledInboundProcessorInactivityMs)
4941 static void from_json(
const nlohmann::json& j, RtpProfile& p)
4944 FROMJSON_IMPL(mode, RtpProfile::JitterMode_t, RtpProfile::JitterMode_t::jmStandard);
4945 FROMJSON_IMPL(jitterMaxMs,
int, 10000);
4946 FROMJSON_IMPL(jitterMinMs,
int, 20);
4947 FROMJSON_IMPL(jitterMaxFactor,
int, 8);
4948 FROMJSON_IMPL(jitterTrimPercentage,
int, 10);
4949 FROMJSON_IMPL(jitterUnderrunReductionThresholdMs,
int, 1500);
4950 FROMJSON_IMPL(jitterUnderrunReductionAger,
int, 100);
4951 FROMJSON_IMPL(latePacketSequenceRange,
int, 5);
4952 FROMJSON_IMPL(latePacketTimestampRangeMs,
int, 2000);
4953 FROMJSON_IMPL(inboundProcessorInactivityMs,
int, 500);
4954 FROMJSON_IMPL(jitterForceTrimAtMs,
int, 0);
4955 FROMJSON_IMPL(rtcpPresenceTimeoutMs,
int, 45000);
4956 FROMJSON_IMPL(jitterMaxExceededClipPerc,
int, 10);
4957 FROMJSON_IMPL(jitterMaxExceededClipHangMs,
int, 1500);
4958 FROMJSON_IMPL(zombieLifetimeMs,
int, 15000);
4959 FROMJSON_IMPL(jitterMaxTrimMs,
int, 250);
4960 FROMJSON_IMPL(signalledInboundProcessorInactivityMs,
int, (p.inboundProcessorInactivityMs * 4));
4964 JSON_SERIALIZED_CLASS(Tls)
4976 IMPLEMENT_JSON_SERIALIZATION()
4977 IMPLEMENT_JSON_DOCUMENTATION(
Tls)
5007 allowSelfSignedCertificates =
false;
5008 caCertificates.clear();
5009 subjectRestrictions.clear();
5010 issuerRestrictions.clear();
5015 static void to_json(nlohmann::json& j,
const Tls& p)
5018 TOJSON_IMPL(verifyPeers),
5019 TOJSON_IMPL(allowSelfSignedCertificates),
5020 TOJSON_IMPL(caCertificates),
5021 TOJSON_IMPL(subjectRestrictions),
5022 TOJSON_IMPL(issuerRestrictions),
5023 TOJSON_IMPL(crlSerials)
5026 static void from_json(
const nlohmann::json& j, Tls& p)
5029 getOptional<bool>(
"verifyPeers", p.verifyPeers, j,
true);
5030 getOptional<bool>(
"allowSelfSignedCertificates", p.allowSelfSignedCertificates, j,
false);
5031 getOptional<std::vector<std::string>>(
"caCertificates", p.caCertificates, j);
5032 getOptional<StringRestrictionList>(
"subjectRestrictions", p.subjectRestrictions, j);
5033 getOptional<StringRestrictionList>(
"issuerRestrictions", p.issuerRestrictions, j);
5034 getOptional<std::vector<std::string>>(
"crlSerials", p.crlSerials, j);
5038 JSON_SERIALIZED_CLASS(RangerPackets)
5052 IMPLEMENT_JSON_SERIALIZATION()
5073 virtual void initForDocumenting()
5078 static void to_json(nlohmann::json& j,
const RangerPackets& p)
5081 TOJSON_IMPL(hangTimerSecs),
5085 static void from_json(
const nlohmann::json& j, RangerPackets& p)
5088 getOptional<int>(
"hangTimerSecs", p.hangTimerSecs, j, 11);
5089 getOptional<int>(
"count", p.count, j, 5);
5093 JSON_SERIALIZED_CLASS(Source)
5107 IMPLEMENT_JSON_SERIALIZATION()
5108 IMPLEMENT_JSON_DOCUMENTATION(
Source)
5115 uint8_t _internal_binary_nodeId[ENGAGE_MAX_NODE_ID_SIZE];
5121 uint8_t _internal_binary_alias[ENGAGE_MAX_ALIAS_SIZE];
5131 memset(_internal_binary_nodeId, 0,
sizeof(_internal_binary_nodeId));
5134 memset(_internal_binary_alias, 0,
sizeof(_internal_binary_alias));
5137 virtual void initForDocumenting()
5142 static void to_json(nlohmann::json& j,
const Source& p)
5145 TOJSON_IMPL(nodeId),
5149 static void from_json(
const nlohmann::json& j, Source& p)
5152 FROMJSON_IMPL_SIMPLE(nodeId);
5153 FROMJSON_IMPL_SIMPLE(alias);
5157 JSON_SERIALIZED_CLASS(GroupBridgeTargetOutputDetail)
5171 IMPLEMENT_JSON_SERIALIZATION()
5208 mode = BridgingOpMode_t::bomRaw;
5209 mixedStreamTxParams.clear();
5212 virtual void initForDocumenting()
5218 static void to_json(nlohmann::json& j,
const GroupBridgeTargetOutputDetail& p)
5222 TOJSON_IMPL(mixedStreamTxParams)
5225 static void from_json(
const nlohmann::json& j, GroupBridgeTargetOutputDetail& p)
5228 FROMJSON_IMPL_SIMPLE(mode);
5229 FROMJSON_IMPL_SIMPLE(mixedStreamTxParams);
5233 JSON_SERIALIZED_CLASS(GroupDefaultAudioPriority)
5247 IMPLEMENT_JSON_SERIALIZATION()
5268 virtual void initForDocumenting()
5274 static void to_json(nlohmann::json& j,
const GroupDefaultAudioPriority& p)
5281 static void from_json(
const nlohmann::json& j, GroupDefaultAudioPriority& p)
5284 FROMJSON_IMPL_SIMPLE(tx);
5285 FROMJSON_IMPL_SIMPLE(rx);
5289 JSON_SERIALIZED_CLASS(Group)
5302 IMPLEMENT_JSON_SERIALIZATION()
5303 IMPLEMENT_JSON_DOCUMENTATION(
Group)
5326 iagpAnonymousAlias = 0,
5330 } InboundAliasGenerationPolicy_t;
5505 bridgeTargetOutputDetail.clear();
5506 defaultAudioPriority.clear();
5510 interfaceName.clear();
5516 cryptoPassword.clear();
5520 rallypoints.clear();
5521 rallypointCluster.clear();
5526 blockAdvertising =
false;
5532 enableMulticastFailover =
false;
5533 multicastFailoverSecs = 10;
5535 rtcpPresenceRx.clear();
5537 presenceGroupAffinities.clear();
5538 disablePacketEvents =
false;
5540 rfc4733RtpPayloadId = 0;
5541 inboundRtpPayloadTypeTranslations.clear();
5542 priorityTranslation.clear();
5544 stickyTidHangSecs = 10;
5545 anonymousAlias.clear();
5548 appTransport.clear();
5549 allowLoopback =
false;
5552 rangerPackets.clear();
5554 _wasDeserialized_rtpProfile =
false;
5556 txImpairment.clear();
5557 rxImpairment.clear();
5559 specializerAffinities.clear();
5563 ignoreSources.clear();
5565 languageCode.clear();
5572 inboundAliasGenerationPolicy = iagpAnonymousAlias;
5575 ignoreAudioTraffic =
false;
5579 static void to_json(nlohmann::json& j,
const Group& p)
5583 TOJSON_IMPL(bridgeTargetOutputDetail),
5584 TOJSON_IMPL(defaultAudioPriority),
5587 TOJSON_IMPL(spokenName),
5588 TOJSON_IMPL(interfaceName),
5591 TOJSON_IMPL(txOptions),
5592 TOJSON_IMPL(txAudio),
5593 TOJSON_IMPL(presence),
5594 TOJSON_IMPL(cryptoPassword),
5603 TOJSON_IMPL(timeline),
5604 TOJSON_IMPL(blockAdvertising),
5605 TOJSON_IMPL(source),
5606 TOJSON_IMPL(maxRxSecs),
5607 TOJSON_IMPL(enableMulticastFailover),
5608 TOJSON_IMPL(multicastFailoverSecs),
5609 TOJSON_IMPL(rtcpPresenceRx),
5610 TOJSON_IMPL(presenceGroupAffinities),
5611 TOJSON_IMPL(disablePacketEvents),
5612 TOJSON_IMPL(rfc4733RtpPayloadId),
5613 TOJSON_IMPL(inboundRtpPayloadTypeTranslations),
5614 TOJSON_IMPL(priorityTranslation),
5615 TOJSON_IMPL(stickyTidHangSecs),
5616 TOJSON_IMPL(anonymousAlias),
5617 TOJSON_IMPL(lbCrypto),
5618 TOJSON_IMPL(appTransport),
5619 TOJSON_IMPL(allowLoopback),
5620 TOJSON_IMPL(rangerPackets),
5622 TOJSON_IMPL(txImpairment),
5623 TOJSON_IMPL(rxImpairment),
5625 TOJSON_IMPL(specializerAffinities),
5627 TOJSON_IMPL(securityLevel),
5629 TOJSON_IMPL(ignoreSources),
5631 TOJSON_IMPL(languageCode),
5632 TOJSON_IMPL(synVoice),
5634 TOJSON_IMPL(rxCapture),
5635 TOJSON_IMPL(txCapture),
5637 TOJSON_IMPL(blobRtpPayloadType),
5639 TOJSON_IMPL(inboundAliasGenerationPolicy),
5641 TOJSON_IMPL(gateIn),
5643 TOJSON_IMPL(ignoreAudioTraffic)
5649 if(p._wasDeserialized_rtpProfile || p.isDocumenting())
5651 j[
"rtpProfile"] = p.rtpProfile;
5654 if(p.isDocumenting())
5656 j[
"rallypointCluster"] = p.rallypointCluster;
5657 j[
"rallypoints"] = p.rallypoints;
5662 if(!p.rallypointCluster.rallypoints.empty())
5664 j[
"rallypointCluster"] = p.rallypointCluster;
5666 else if(!p.rallypoints.empty())
5668 j[
"rallypoints"] = p.rallypoints;
5672 static void from_json(
const nlohmann::json& j, Group& p)
5675 j.at(
"type").get_to(p.type);
5676 getOptional<GroupBridgeTargetOutputDetail>(
"bridgeTargetOutputDetail", p.bridgeTargetOutputDetail, j);
5677 j.at(
"id").get_to(p.id);
5678 getOptional<std::string>(
"name", p.name, j);
5679 getOptional<std::string>(
"spokenName", p.spokenName, j);
5680 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
5681 getOptional<NetworkAddress>(
"rx", p.rx, j);
5682 getOptional<NetworkAddress>(
"tx", p.tx, j);
5683 getOptional<NetworkTxOptions>(
"txOptions", p.txOptions, j);
5684 getOptional<std::string>(
"cryptoPassword", p.cryptoPassword, j);
5685 getOptional<std::string>(
"alias", p.alias, j);
5686 getOptional<TxAudio>(
"txAudio", p.txAudio, j);
5687 getOptional<Presence>(
"presence", p.presence, j);
5688 getOptional<std::vector<Rallypoint>>(
"rallypoints", p.rallypoints, j);
5689 getOptional<RallypointCluster>(
"rallypointCluster", p.rallypointCluster, j);
5690 getOptional<Audio>(
"audio", p.audio, j);
5691 getOptional<GroupTimeline>(
"timeline", p.timeline, j);
5692 getOptional<bool>(
"blockAdvertising", p.blockAdvertising, j,
false);
5693 getOptional<std::string>(
"source", p.source, j);
5694 getOptional<int>(
"maxRxSecs", p.maxRxSecs, j, 0);
5695 getOptional<bool>(
"enableMulticastFailover", p.enableMulticastFailover, j,
false);
5696 getOptional<int>(
"multicastFailoverSecs", p.multicastFailoverSecs, j, 10);
5697 getOptional<NetworkAddress>(
"rtcpPresenceRx", p.rtcpPresenceRx, j);
5698 getOptional<std::vector<std::string>>(
"presenceGroupAffinities", p.presenceGroupAffinities, j);
5699 getOptional<bool>(
"disablePacketEvents", p.disablePacketEvents, j,
false);
5700 getOptional<int>(
"rfc4733RtpPayloadId", p.rfc4733RtpPayloadId, j, 0);
5701 getOptional<std::vector<RtpPayloadTypeTranslation>>(
"inboundRtpPayloadTypeTranslations", p.inboundRtpPayloadTypeTranslations, j);
5702 getOptional<GroupPriorityTranslation>(
"priorityTranslation", p.priorityTranslation, j);
5703 getOptional<GroupDefaultAudioPriority>(
"defaultAudioPriority", p.defaultAudioPriority, j);
5704 getOptional<int>(
"stickyTidHangSecs", p.stickyTidHangSecs, j, 10);
5705 getOptional<std::string>(
"anonymousAlias", p.anonymousAlias, j);
5706 getOptional<bool>(
"lbCrypto", p.lbCrypto, j,
false);
5707 getOptional<GroupAppTransport>(
"appTransport", p.appTransport, j);
5708 getOptional<bool>(
"allowLoopback", p.allowLoopback, j,
false);
5709 getOptionalWithIndicator<RtpProfile>(
"rtpProfile", p.rtpProfile, j, &p._wasDeserialized_rtpProfile);
5710 getOptional<RangerPackets>(
"rangerPackets", p.rangerPackets, j);
5711 getOptional<TransportImpairment>(
"txImpairment", p.txImpairment, j);
5712 getOptional<TransportImpairment>(
"rxImpairment", p.rxImpairment, j);
5713 getOptional<std::vector<uint16_t>>(
"specializerAffinities", p.specializerAffinities, j);
5714 getOptional<uint32_t>(
"securityLevel", p.securityLevel, j, 0);
5715 getOptional<std::vector<Source>>(
"ignoreSources", p.ignoreSources, j);
5716 getOptional<std::string>(
"languageCode", p.languageCode, j);
5717 getOptional<std::string>(
"synVoice", p.synVoice, j);
5719 getOptional<PacketCapturer>(
"rxCapture", p.rxCapture, j);
5720 getOptional<PacketCapturer>(
"txCapture", p.txCapture, j);
5724 getOptional<Group::InboundAliasGenerationPolicy_t>(
"inboundAliasGenerationPolicy", p.inboundAliasGenerationPolicy, j, Group::InboundAliasGenerationPolicy_t::iagpAnonymousAlias);
5726 getOptional<AudioGate>(
"gateIn", p.gateIn, j);
5728 getOptional<bool>(
"ignoreAudioTraffic", p.ignoreAudioTraffic, j,
false);
5730 FROMJSON_BASE_IMPL();
5735 JSON_SERIALIZED_CLASS(Mission)
5738 IMPLEMENT_JSON_SERIALIZATION()
5739 IMPLEMENT_JSON_DOCUMENTATION(
Mission)
5744 std::vector<Group> groups;
5745 std::chrono::system_clock::time_point begins;
5746 std::chrono::system_clock::time_point ends;
5747 std::string certStoreId;
5748 int multicastFailoverPolicy;
5756 certStoreId.clear();
5757 multicastFailoverPolicy = 0;
5762 static void to_json(nlohmann::json& j,
const Mission& p)
5767 TOJSON_IMPL(groups),
5768 TOJSON_IMPL(certStoreId),
5769 TOJSON_IMPL(multicastFailoverPolicy),
5770 TOJSON_IMPL(rallypoint)
5774 static void from_json(
const nlohmann::json& j, Mission& p)
5777 j.at(
"id").get_to(p.id);
5778 j.at(
"name").get_to(p.name);
5783 j.at(
"groups").get_to(p.groups);
5790 FROMJSON_IMPL(certStoreId, std::string, EMPTY_STRING);
5791 FROMJSON_IMPL(multicastFailoverPolicy,
int, 0);
5792 getOptional<Rallypoint>(
"rallypoint", p.rallypoint, j);
5796 JSON_SERIALIZED_CLASS(LicenseDescriptor)
5808 IMPLEMENT_JSON_SERIALIZATION()
5817 static const int STATUS_OK = 0;
5818 static const int ERR_NULL_ENTITLEMENT_KEY = -1;
5819 static const int ERR_NULL_LICENSE_KEY = -2;
5820 static const int ERR_INVALID_LICENSE_KEY_LEN = -3;
5821 static const int ERR_LICENSE_KEY_VERIFICATION_FAILURE = -4;
5822 static const int ERR_ACTIVATION_CODE_VERIFICATION_FAILURE = -5;
5823 static const int ERR_INVALID_EXPIRATION_DATE = -6;
5824 static const int ERR_GENERAL_FAILURE = -7;
5825 static const int ERR_NOT_INITIALIZED = -8;
5826 static const int ERR_REQUIRES_ACTIVATION = -9;
5827 static const int ERR_LICENSE_NOT_SUITED_FOR_ACTIVATION = -10;
5835 static const uint8_t LIC_CARGO_FLAG_LIMIT_TO_FEATURES = 0x01;
5902 entitlement.clear();
5904 activationCode.clear();
5907 expiresFormatted.clear();
5912 status = ERR_NOT_INITIALIZED;
5913 manufacturerId.clear();
5914 activationHmac.clear();
5918 static void to_json(nlohmann::json& j,
const LicenseDescriptor& p)
5922 {
"entitlement",
"*entitlement*"},
5924 TOJSON_IMPL(activationCode),
5926 TOJSON_IMPL(expires),
5927 TOJSON_IMPL(expiresFormatted),
5929 TOJSON_IMPL(deviceId),
5930 TOJSON_IMPL(status),
5932 {
"manufacturerId",
"*manufacturerId*"},
5934 TOJSON_IMPL(cargoFlags),
5935 TOJSON_IMPL(activationHmac)
5939 static void from_json(
const nlohmann::json& j, LicenseDescriptor& p)
5942 FROMJSON_IMPL(entitlement, std::string, EMPTY_STRING);
5943 FROMJSON_IMPL(key, std::string, EMPTY_STRING);
5944 FROMJSON_IMPL(activationCode, std::string, EMPTY_STRING);
5945 FROMJSON_IMPL(type,
int, 0);
5946 FROMJSON_IMPL(expires, time_t, 0);
5947 FROMJSON_IMPL(expiresFormatted, std::string, EMPTY_STRING);
5948 FROMJSON_IMPL(flags, uint32_t, 0);
5949 FROMJSON_IMPL(deviceId, std::string, EMPTY_STRING);
5950 FROMJSON_IMPL(status,
int, LicenseDescriptor::ERR_NOT_INITIALIZED);
5951 FROMJSON_IMPL(manufacturerId, std::string, EMPTY_STRING);
5952 FROMJSON_IMPL(cargo, std::string, EMPTY_STRING);
5953 FROMJSON_IMPL(cargoFlags, uint8_t, 0);
5954 FROMJSON_IMPL(activationHmac, std::string, EMPTY_STRING);
5959 JSON_SERIALIZED_CLASS(EngineNetworkingRpUdpStreaming)
5973 IMPLEMENT_JSON_SERIALIZATION()
6001 keepaliveIntervalSecs = 15;
6002 priority = TxPriority_t::priVoice;
6006 virtual void initForDocumenting()
6011 static void to_json(nlohmann::json& j,
const EngineNetworkingRpUdpStreaming& p)
6014 TOJSON_IMPL(enabled),
6016 TOJSON_IMPL(keepaliveIntervalSecs),
6017 TOJSON_IMPL(priority),
6021 static void from_json(
const nlohmann::json& j, EngineNetworkingRpUdpStreaming& p)
6024 getOptional<bool>(
"enabled", p.enabled, j,
false);
6025 getOptional<int>(
"port", p.port, j, 0);
6026 getOptional<int>(
"keepaliveIntervalSecs", p.keepaliveIntervalSecs, j, 15);
6027 getOptional<TxPriority_t>(
"priority", p.priority, j, TxPriority_t::priVoice);
6028 getOptional<int>(
"ttl", p.ttl, j, 64);
6032 JSON_SERIALIZED_CLASS(EnginePolicyNetworking)
6043 IMPLEMENT_JSON_SERIALIZATION()
6079 multicastRejoinSecs = 8;
6080 rallypointRtTestIntervalMs = 60000;
6081 logRtpJitterBufferStats =
false;
6082 preventMulticastFailover =
false;
6083 addressResolutionPolicy = AddressResolutionPolicy_t::arpIpv6ThenIpv4;
6085 rpUdpStreaming.clear();
6090 static void to_json(nlohmann::json& j,
const EnginePolicyNetworking& p)
6093 TOJSON_IMPL(defaultNic),
6094 TOJSON_IMPL(multicastRejoinSecs),
6096 TOJSON_IMPL(rallypointRtTestIntervalMs),
6097 TOJSON_IMPL(logRtpJitterBufferStats),
6098 TOJSON_IMPL(preventMulticastFailover),
6100 TOJSON_IMPL(rpUdpStreaming),
6101 TOJSON_IMPL(rtpProfile),
6102 TOJSON_IMPL(addressResolutionPolicy)
6105 static void from_json(
const nlohmann::json& j, EnginePolicyNetworking& p)
6108 FROMJSON_IMPL(defaultNic, std::string, EMPTY_STRING);
6109 FROMJSON_IMPL(multicastRejoinSecs,
int, 8);
6110 FROMJSON_IMPL(rallypointRtTestIntervalMs,
int, 60000);
6111 FROMJSON_IMPL(logRtpJitterBufferStats,
bool,
false);
6112 FROMJSON_IMPL(preventMulticastFailover,
bool,
false);
6114 getOptional<EngineNetworkingRpUdpStreaming>(
"rpUdpStreaming", p.rpUdpStreaming, j);
6115 getOptional<RtpProfile>(
"rtpProfile", p.rtpProfile, j);
6116 getOptional<AddressResolutionPolicy_t>(
"addressResolutionPolicy", p.addressResolutionPolicy, j, AddressResolutionPolicy_t::arpIpv6ThenIpv4);
6120 JSON_SERIALIZED_CLASS(Aec)
6132 IMPLEMENT_JSON_SERIALIZATION()
6133 IMPLEMENT_JSON_DOCUMENTATION(
Aec)
6188 static void to_json(nlohmann::json& j,
const Aec& p)
6191 TOJSON_IMPL(enabled),
6193 TOJSON_IMPL(speakerTailMs),
6197 static void from_json(
const nlohmann::json& j, Aec& p)
6200 FROMJSON_IMPL(enabled,
bool,
false);
6201 FROMJSON_IMPL(mode, Aec::Mode_t, Aec::Mode_t::aecmDefault);
6202 FROMJSON_IMPL(speakerTailMs,
int, 60);
6203 FROMJSON_IMPL(cng,
bool,
true);
6207 JSON_SERIALIZED_CLASS(Vad)
6219 IMPLEMENT_JSON_SERIALIZATION()
6220 IMPLEMENT_JSON_DOCUMENTATION(
Vad)
6240 vamVeryAggressive = 3
6261 static void to_json(nlohmann::json& j,
const Vad& p)
6264 TOJSON_IMPL(enabled),
6268 static void from_json(
const nlohmann::json& j, Vad& p)
6271 FROMJSON_IMPL(enabled,
bool,
false);
6272 FROMJSON_IMPL(mode, Vad::Mode_t, Vad::Mode_t::vamDefault);
6276 JSON_SERIALIZED_CLASS(Bridge)
6288 IMPLEMENT_JSON_SERIALIZATION()
6289 IMPLEMENT_JSON_DOCUMENTATION(
Bridge)
6320 static void to_json(nlohmann::json& j,
const Bridge& p)
6325 TOJSON_IMPL(groups),
6326 TOJSON_IMPL(enabled)
6329 static void from_json(
const nlohmann::json& j, Bridge& p)
6332 FROMJSON_IMPL(
id, std::string, EMPTY_STRING);
6333 FROMJSON_IMPL(name, std::string, EMPTY_STRING);
6334 getOptional<std::vector<std::string>>(
"groups", p.groups, j);
6335 FROMJSON_IMPL(enabled,
bool,
true);
6339 JSON_SERIALIZED_CLASS(AndroidAudio)
6351 IMPLEMENT_JSON_SERIALIZATION()
6355 constexpr static int INVALID_SESSION_ID = -9999;
6416 performanceMode = 12;
6420 sessionId = AndroidAudio::INVALID_SESSION_ID;
6425 static void to_json(nlohmann::json& j,
const AndroidAudio& p)
6429 TOJSON_IMPL(sharingMode),
6430 TOJSON_IMPL(performanceMode),
6432 TOJSON_IMPL(contentType),
6433 TOJSON_IMPL(inputPreset),
6434 TOJSON_IMPL(sessionId),
6435 TOJSON_IMPL(engineMode)
6438 static void from_json(
const nlohmann::json& j, AndroidAudio& p)
6441 FROMJSON_IMPL(api,
int, 0);
6442 FROMJSON_IMPL(sharingMode,
int, 0);
6443 FROMJSON_IMPL(performanceMode,
int, 12);
6444 FROMJSON_IMPL(usage,
int, 2);
6445 FROMJSON_IMPL(contentType,
int, 1);
6446 FROMJSON_IMPL(inputPreset,
int, 7);
6447 FROMJSON_IMPL(sessionId,
int, AndroidAudio::INVALID_SESSION_ID);
6448 FROMJSON_IMPL(engineMode,
int, 0);
6452 JSON_SERIALIZED_CLASS(EnginePolicyAudio)
6464 IMPLEMENT_JSON_SERIALIZATION()
6522 hardwareEnabled =
true;
6523 internalRate = 16000;
6524 internalChannels = 2;
6531 denoiseInput =
false;
6532 denoiseOutput =
false;
6533 saveInputPcm =
false;
6534 saveOutputPcm =
false;
6539 static void to_json(nlohmann::json& j,
const EnginePolicyAudio& p)
6542 TOJSON_IMPL(enabled),
6543 TOJSON_IMPL(hardwareEnabled),
6544 TOJSON_IMPL(internalRate),
6545 TOJSON_IMPL(internalChannels),
6546 TOJSON_IMPL(muteTxOnTx),
6549 TOJSON_IMPL(android),
6550 TOJSON_IMPL(inputAgc),
6551 TOJSON_IMPL(outputAgc),
6552 TOJSON_IMPL(denoiseInput),
6553 TOJSON_IMPL(denoiseOutput),
6554 TOJSON_IMPL(saveInputPcm),
6555 TOJSON_IMPL(saveOutputPcm),
6556 TOJSON_IMPL(registry)
6559 static void from_json(
const nlohmann::json& j, EnginePolicyAudio& p)
6562 getOptional<bool>(
"enabled", p.enabled, j,
true);
6563 getOptional<bool>(
"hardwareEnabled", p.hardwareEnabled, j,
true);
6564 FROMJSON_IMPL(internalRate,
int, 16000);
6565 FROMJSON_IMPL(internalChannels,
int, 2);
6567 FROMJSON_IMPL(muteTxOnTx,
bool,
false);
6568 getOptional<Aec>(
"aec", p.aec, j);
6569 getOptional<Vad>(
"vad", p.vad, j);
6570 getOptional<AndroidAudio>(
"android", p.android, j);
6571 getOptional<Agc>(
"inputAgc", p.inputAgc, j);
6572 getOptional<Agc>(
"outputAgc", p.outputAgc, j);
6573 FROMJSON_IMPL(denoiseInput,
bool,
false);
6574 FROMJSON_IMPL(denoiseOutput,
bool,
false);
6575 FROMJSON_IMPL(saveInputPcm,
bool,
false);
6576 FROMJSON_IMPL(saveOutputPcm,
bool,
false);
6577 getOptional<AudioRegistry>(
"registry", p.registry, j);
6581 JSON_SERIALIZED_CLASS(SecurityCertificate)
6593 IMPLEMENT_JSON_SERIALIZATION()
6615 certificate.clear();
6620 static void to_json(nlohmann::json& j,
const SecurityCertificate& p)
6623 TOJSON_IMPL(certificate),
6627 static void from_json(
const nlohmann::json& j, SecurityCertificate& p)
6630 FROMJSON_IMPL(certificate, std::string, EMPTY_STRING);
6631 FROMJSON_IMPL(key, std::string, EMPTY_STRING);
6636 JSON_SERIALIZED_CLASS(EnginePolicySecurity)
6649 IMPLEMENT_JSON_SERIALIZATION()
6682 certificate.clear();
6683 caCertificates.clear();
6687 static void to_json(nlohmann::json& j,
const EnginePolicySecurity& p)
6690 TOJSON_IMPL(certificate),
6691 TOJSON_IMPL(caCertificates)
6694 static void from_json(
const nlohmann::json& j, EnginePolicySecurity& p)
6697 getOptional(
"certificate", p.certificate, j);
6698 getOptional<std::vector<std::string>>(
"caCertificates", p.caCertificates, j);
6702 JSON_SERIALIZED_CLASS(EnginePolicyLogging)
6714 IMPLEMENT_JSON_SERIALIZATION()
6747 enableSyslog =
false;
6751 static void to_json(nlohmann::json& j,
const EnginePolicyLogging& p)
6754 TOJSON_IMPL(maxLevel),
6755 TOJSON_IMPL(enableSyslog)
6758 static void from_json(
const nlohmann::json& j, EnginePolicyLogging& p)
6761 getOptional(
"maxLevel", p.maxLevel, j, 4);
6762 getOptional(
"enableSyslog", p.enableSyslog, j);
6767 JSON_SERIALIZED_CLASS(EnginePolicyDatabase)
6770 IMPLEMENT_JSON_SERIALIZATION()
6781 DatabaseType_t type;
6782 std::string fixedFileName;
6783 bool forceMaintenance;
6793 type = DatabaseType_t::dbtFixedMemory;
6794 fixedFileName.clear();
6795 forceMaintenance =
false;
6796 reclaimSpace =
false;
6804 TOJSON_IMPL(fixedFileName),
6805 TOJSON_IMPL(forceMaintenance),
6806 TOJSON_IMPL(reclaimSpace)
6809 static void from_json(
const nlohmann::json& j, EnginePolicyDatabase& p)
6812 FROMJSON_IMPL(type, EnginePolicyDatabase::DatabaseType_t, EnginePolicyDatabase::DatabaseType_t::dbtFixedMemory);
6813 FROMJSON_IMPL(fixedFileName, std::string, EMPTY_STRING);
6814 FROMJSON_IMPL(forceMaintenance,
bool,
false);
6815 FROMJSON_IMPL(reclaimSpace,
bool,
false);
6820 JSON_SERIALIZED_CLASS(SecureSignature)
6830 IMPLEMENT_JSON_SERIALIZATION()
6851 certificate.clear();
6857 static void to_json(nlohmann::json& j,
const SecureSignature& p)
6860 TOJSON_IMPL(certificate),
6862 TOJSON_IMPL(signature)
6865 static void from_json(
const nlohmann::json& j, SecureSignature& p)
6868 FROMJSON_IMPL(certificate, std::string, EMPTY_STRING);
6870 FROMJSON_IMPL(signature, std::string, EMPTY_STRING);
6874 JSON_SERIALIZED_CLASS(NamedAudioDevice)
6877 IMPLEMENT_JSON_SERIALIZATION()
6882 std::string manufacturer;
6885 std::string serialNumber;
6898 manufacturer.clear();
6901 serialNumber.clear();
6912 TOJSON_IMPL(manufacturer),
6915 TOJSON_IMPL(serialNumber),
6918 TOJSON_IMPL(isDefault),
6921 static void from_json(
const nlohmann::json& j, NamedAudioDevice& p)
6924 getOptional<std::string>(
"name", p.name, j, EMPTY_STRING);
6925 getOptional<std::string>(
"manufacturer", p.manufacturer, j, EMPTY_STRING);
6926 getOptional<std::string>(
"model", p.model, j, EMPTY_STRING);
6927 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
6928 getOptional<std::string>(
"serialNumber", p.serialNumber, j, EMPTY_STRING);
6929 getOptional<std::string>(
"type", p.type, j, EMPTY_STRING);
6930 getOptional<std::string>(
"extra", p.extra, j, EMPTY_STRING);
6931 getOptional<bool>(
"isDefault", p.isDefault, j,
false);
6936 JSON_SERIALIZED_CLASS(EnginePolicyNamedAudioDevices)
6939 IMPLEMENT_JSON_SERIALIZATION()
6943 std::vector<NamedAudioDevice> inputs;
6944 std::vector<NamedAudioDevice> outputs;
6961 TOJSON_IMPL(inputs),
6962 TOJSON_IMPL(outputs)
6965 static void from_json(
const nlohmann::json& j, EnginePolicyNamedAudioDevices& p)
6968 getOptional<std::vector<NamedAudioDevice>>(
"inputs", p.inputs, j);
6969 getOptional<std::vector<NamedAudioDevice>>(
"outputs", p.outputs, j);
6973 JSON_SERIALIZED_CLASS(Licensing)
6987 IMPLEMENT_JSON_SERIALIZATION()
7014 entitlement.clear();
7016 activationCode.clear();
7018 manufacturerId.clear();
7022 static void to_json(nlohmann::json& j,
const Licensing& p)
7025 TOJSON_IMPL(entitlement),
7027 TOJSON_IMPL(activationCode),
7028 TOJSON_IMPL(deviceId),
7029 TOJSON_IMPL(manufacturerId)
7032 static void from_json(
const nlohmann::json& j, Licensing& p)
7035 FROMJSON_IMPL(entitlement, std::string, EMPTY_STRING);
7036 FROMJSON_IMPL(key, std::string, EMPTY_STRING);
7037 FROMJSON_IMPL(activationCode, std::string, EMPTY_STRING);
7038 FROMJSON_IMPL(deviceId, std::string, EMPTY_STRING);
7039 FROMJSON_IMPL(manufacturerId, std::string, EMPTY_STRING);
7043 JSON_SERIALIZED_CLASS(DiscoveryMagellan)
7055 IMPLEMENT_JSON_SERIALIZATION()
7080 interfaceName.clear();
7086 static void to_json(nlohmann::json& j,
const DiscoveryMagellan& p)
7089 TOJSON_IMPL(enabled),
7090 TOJSON_IMPL(interfaceName),
7091 TOJSON_IMPL(security),
7095 static void from_json(
const nlohmann::json& j, DiscoveryMagellan& p)
7098 getOptional(
"enabled", p.enabled, j,
false);
7099 getOptional<Tls>(
"tls", p.tls, j);
7100 getOptional<SecurityCertificate>(
"security", p.security, j);
7101 FROMJSON_IMPL(interfaceName, std::string, EMPTY_STRING);
7105 JSON_SERIALIZED_CLASS(DiscoverySsdp)
7117 IMPLEMENT_JSON_SERIALIZATION()
7148 interfaceName.clear();
7150 searchTerms.clear();
7151 ageTimeoutMs = 30000;
7152 advertising.clear();
7156 static void to_json(nlohmann::json& j,
const DiscoverySsdp& p)
7159 TOJSON_IMPL(enabled),
7160 TOJSON_IMPL(interfaceName),
7161 TOJSON_IMPL(address),
7162 TOJSON_IMPL(searchTerms),
7163 TOJSON_IMPL(ageTimeoutMs),
7164 TOJSON_IMPL(advertising)
7167 static void from_json(
const nlohmann::json& j, DiscoverySsdp& p)
7170 getOptional(
"enabled", p.enabled, j,
false);
7171 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
7173 getOptional<NetworkAddress>(
"address", p.address, j);
7174 if(p.address.address.empty())
7176 p.address.address =
"255.255.255.255";
7178 if(p.address.port <= 0)
7180 p.address.port = 1900;
7183 getOptional<std::vector<std::string>>(
"searchTerms", p.searchTerms, j);
7184 getOptional<int>(
"ageTimeoutMs", p.ageTimeoutMs, j, 30000);
7185 getOptional<Advertising>(
"advertising", p.advertising, j);
7189 JSON_SERIALIZED_CLASS(DiscoverySap)
7201 IMPLEMENT_JSON_SERIALIZATION()
7228 interfaceName.clear();
7230 ageTimeoutMs = 30000;
7231 advertising.clear();
7235 static void to_json(nlohmann::json& j,
const DiscoverySap& p)
7238 TOJSON_IMPL(enabled),
7239 TOJSON_IMPL(interfaceName),
7240 TOJSON_IMPL(address),
7241 TOJSON_IMPL(ageTimeoutMs),
7242 TOJSON_IMPL(advertising)
7245 static void from_json(
const nlohmann::json& j, DiscoverySap& p)
7248 getOptional(
"enabled", p.enabled, j,
false);
7249 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
7250 getOptional<NetworkAddress>(
"address", p.address, j);
7251 if(p.address.address.empty())
7253 p.address.address =
"224.2.127.254";
7255 if(p.address.port <= 0)
7257 p.address.port = 9875;
7260 getOptional<int>(
"ageTimeoutMs", p.ageTimeoutMs, j, 30000);
7261 getOptional<Advertising>(
"advertising", p.advertising, j);
7265 JSON_SERIALIZED_CLASS(DiscoveryCistech)
7279 IMPLEMENT_JSON_SERIALIZATION()
7284 std::string interfaceName;
7296 interfaceName.clear();
7298 ageTimeoutMs = 30000;
7305 TOJSON_IMPL(enabled),
7306 TOJSON_IMPL(interfaceName),
7307 TOJSON_IMPL(address),
7308 TOJSON_IMPL(ageTimeoutMs)
7311 static void from_json(
const nlohmann::json& j, DiscoveryCistech& p)
7314 getOptional(
"enabled", p.enabled, j,
false);
7315 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
7316 getOptional<NetworkAddress>(
"address", p.address, j);
7317 getOptional<int>(
"ageTimeoutMs", p.ageTimeoutMs, j, 30000);
7322 JSON_SERIALIZED_CLASS(DiscoveryTrellisware)
7334 IMPLEMENT_JSON_SERIALIZATION()
7357 static void to_json(nlohmann::json& j,
const DiscoveryTrellisware& p)
7360 TOJSON_IMPL(enabled),
7361 TOJSON_IMPL(security)
7364 static void from_json(
const nlohmann::json& j, DiscoveryTrellisware& p)
7367 getOptional(
"enabled", p.enabled, j,
false);
7368 getOptional<SecurityCertificate>(
"security", p.security, j);
7372 JSON_SERIALIZED_CLASS(DiscoveryConfiguration)
7384 IMPLEMENT_JSON_SERIALIZATION()
7417 static void to_json(nlohmann::json& j,
const DiscoveryConfiguration& p)
7420 TOJSON_IMPL(magellan),
7423 TOJSON_IMPL(cistech),
7424 TOJSON_IMPL(trellisware)
7427 static void from_json(
const nlohmann::json& j, DiscoveryConfiguration& p)
7430 getOptional<DiscoveryMagellan>(
"magellan", p.magellan, j);
7431 getOptional<DiscoverySsdp>(
"ssdp", p.ssdp, j);
7432 getOptional<DiscoverySap>(
"sap", p.sap, j);
7433 getOptional<DiscoveryCistech>(
"cistech", p.cistech, j);
7434 getOptional<DiscoveryTrellisware>(
"trellisware", p.trellisware, j);
7439 JSON_SERIALIZED_CLASS(EnginePolicyInternals)
7453 IMPLEMENT_JSON_SERIALIZATION()
7468 int logTaskQueueStatsIntervalMs;
7470 bool enableLazySpeakerClosure;
7507 housekeeperIntervalMs = 1000;
7508 logTaskQueueStatsIntervalMs = 0;
7511 enableLazySpeakerClosure =
false;
7512 rpClusterStrategy = RallypointCluster::ConnectionStrategy_t::csRoundRobin;
7513 rpClusterRolloverSecs = 10;
7514 rtpExpirationCheckIntervalMs = 250;
7515 rpConnectionTimeoutSecs = 0;
7516 rpTransactionTimeoutMs = 0;
7517 stickyTidHangSecs = 10;
7518 uriStreamingIntervalMs = 60;
7519 delayedMicrophoneClosureSecs = 15;
7524 static void to_json(nlohmann::json& j,
const EnginePolicyInternals& p)
7527 TOJSON_IMPL(watchdog),
7528 TOJSON_IMPL(housekeeperIntervalMs),
7529 TOJSON_IMPL(logTaskQueueStatsIntervalMs),
7530 TOJSON_IMPL(maxTxSecs),
7531 TOJSON_IMPL(maxRxSecs),
7532 TOJSON_IMPL(enableLazySpeakerClosure),
7533 TOJSON_IMPL(rpClusterStrategy),
7534 TOJSON_IMPL(rpClusterRolloverSecs),
7535 TOJSON_IMPL(rtpExpirationCheckIntervalMs),
7536 TOJSON_IMPL(rpConnectionTimeoutSecs),
7537 TOJSON_IMPL(rpTransactionTimeoutMs),
7538 TOJSON_IMPL(stickyTidHangSecs),
7539 TOJSON_IMPL(uriStreamingIntervalMs),
7540 TOJSON_IMPL(delayedMicrophoneClosureSecs),
7544 static void from_json(
const nlohmann::json& j, EnginePolicyInternals& p)
7547 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
7548 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
7549 getOptional<int>(
"logTaskQueueStatsIntervalMs", p.logTaskQueueStatsIntervalMs, j, 0);
7550 getOptional<int>(
"maxTxSecs", p.maxTxSecs, j, 30);
7551 getOptional<int>(
"maxRxSecs", p.maxRxSecs, j, 0);
7552 getOptional<bool>(
"enableLazySpeakerClosure", p.enableLazySpeakerClosure, j,
false);
7553 getOptional<RallypointCluster::ConnectionStrategy_t>(
"rpClusterStrategy", p.rpClusterStrategy, j, RallypointCluster::ConnectionStrategy_t::csRoundRobin);
7554 getOptional<int>(
"rpClusterRolloverSecs", p.rpClusterRolloverSecs, j, 10);
7555 getOptional<int>(
"rtpExpirationCheckIntervalMs", p.rtpExpirationCheckIntervalMs, j, 250);
7556 getOptional<int>(
"rpConnectionTimeoutSecs", p.rpConnectionTimeoutSecs, j, 0);
7557 getOptional<int>(
"rpTransactionTimeoutMs", p.rpTransactionTimeoutMs, j, 0);
7558 getOptional<int>(
"stickyTidHangSecs", p.stickyTidHangSecs, j, 10);
7559 getOptional<int>(
"uriStreamingIntervalMs", p.uriStreamingIntervalMs, j, 60);
7560 getOptional<int>(
"delayedMicrophoneClosureSecs", p.delayedMicrophoneClosureSecs, j, 15);
7561 getOptional<TuningSettings>(
"tuning", p.tuning, j);
7565 JSON_SERIALIZED_CLASS(EnginePolicyTimelines)
7579 IMPLEMENT_JSON_SERIALIZATION()
7641 storageRoot.clear();
7642 maxStorageMb = 1024;
7643 maxMemMb = maxStorageMb;
7644 maxAudioEventMemMb = maxMemMb;
7645 maxDiskMb = maxStorageMb;
7646 maxEventAgeSecs = (86400 * 30);
7647 groomingIntervalSecs = (60 * 30);
7649 autosaveIntervalSecs = 5;
7651 disableSigningAndVerification =
false;
7656 static void to_json(nlohmann::json& j,
const EnginePolicyTimelines& p)
7659 TOJSON_IMPL(enabled),
7660 TOJSON_IMPL(storageRoot),
7661 TOJSON_IMPL(maxMemMb),
7662 TOJSON_IMPL(maxAudioEventMemMb),
7663 TOJSON_IMPL(maxDiskMb),
7664 TOJSON_IMPL(maxEventAgeSecs),
7665 TOJSON_IMPL(maxEvents),
7666 TOJSON_IMPL(groomingIntervalSecs),
7667 TOJSON_IMPL(autosaveIntervalSecs),
7668 TOJSON_IMPL(security),
7669 TOJSON_IMPL(disableSigningAndVerification),
7670 TOJSON_IMPL(ephemeral)
7673 static void from_json(
const nlohmann::json& j, EnginePolicyTimelines& p)
7676 getOptional<bool>(
"enabled", p.enabled, j,
true);
7677 getOptional<std::string>(
"storageRoot", p.storageRoot, j, EMPTY_STRING);
7679 getOptional<int>(
"maxStorageMb", p.maxStorageMb, j, 1024);
7680 getOptional<int>(
"maxMemMb", p.maxMemMb, j, p.maxStorageMb);
7681 getOptional<int>(
"maxAudioEventMemMb", p.maxAudioEventMemMb, j, p.maxMemMb);
7682 getOptional<int>(
"maxDiskMb", p.maxDiskMb, j, p.maxStorageMb);
7683 getOptional<long>(
"maxEventAgeSecs", p.maxEventAgeSecs, j, (86400 * 30));
7684 getOptional<long>(
"groomingIntervalSecs", p.groomingIntervalSecs, j, (60 * 30));
7685 getOptional<long>(
"autosaveIntervalSecs", p.autosaveIntervalSecs, j, 5);
7686 getOptional<int>(
"maxEvents", p.maxEvents, j, 1000);
7687 getOptional<SecurityCertificate>(
"security", p.security, j);
7688 getOptional<bool>(
"disableSigningAndVerification", p.disableSigningAndVerification, j,
false);
7689 getOptional<bool>(
"ephemeral", p.ephemeral, j,
false);
7694 JSON_SERIALIZED_CLASS(RtpMapEntry)
7706 IMPLEMENT_JSON_SERIALIZATION()
7728 rtpPayloadType = -1;
7732 static void to_json(nlohmann::json& j,
const RtpMapEntry& p)
7736 TOJSON_IMPL(engageType),
7737 TOJSON_IMPL(rtpPayloadType)
7740 static void from_json(
const nlohmann::json& j, RtpMapEntry& p)
7743 getOptional<std::string>(
"name", p.name, j, EMPTY_STRING);
7744 getOptional<int>(
"engageType", p.engageType, j, -1);
7745 getOptional<int>(
"rtpPayloadType", p.rtpPayloadType, j, -1);
7749 JSON_SERIALIZED_CLASS(ExternalModule)
7761 IMPLEMENT_JSON_SERIALIZATION()
7783 configuration.clear();
7787 static void to_json(nlohmann::json& j,
const ExternalModule& p)
7794 if(!p.configuration.empty())
7796 j[
"configuration"] = p.configuration;
7799 static void from_json(
const nlohmann::json& j, ExternalModule& p)
7802 getOptional<std::string>(
"name", p.name, j, EMPTY_STRING);
7803 getOptional<std::string>(
"file", p.file, j, EMPTY_STRING);
7807 p.configuration = j.at(
"configuration");
7811 p.configuration.clear();
7817 JSON_SERIALIZED_CLASS(ExternalCodecDescriptor)
7829 IMPLEMENT_JSON_SERIALIZATION()
7852 rtpPayloadType = -1;
7855 rtpTsMultiplier = 0;
7859 static void to_json(nlohmann::json& j,
const ExternalCodecDescriptor& p)
7862 TOJSON_IMPL(rtpPayloadType),
7863 TOJSON_IMPL(samplingRate),
7864 TOJSON_IMPL(channels),
7865 TOJSON_IMPL(rtpTsMultiplier)
7868 static void from_json(
const nlohmann::json& j, ExternalCodecDescriptor& p)
7872 getOptional<int>(
"rtpPayloadType", p.rtpPayloadType, j, -1);
7873 getOptional<int>(
"samplingRate", p.samplingRate, j, -1);
7874 getOptional<int>(
"channels", p.channels, j, -1);
7875 getOptional<int>(
"rtpTsMultiplier", p.rtpTsMultiplier, j, -1);
7879 JSON_SERIALIZED_CLASS(EngineStatusReportConfiguration)
7891 IMPLEMENT_JSON_SERIALIZATION()
7923 includeMemoryDetail =
false;
7924 includeTaskQueueDetail =
false;
7929 static void to_json(nlohmann::json& j,
const EngineStatusReportConfiguration& p)
7932 TOJSON_IMPL(fileName),
7933 TOJSON_IMPL(intervalSecs),
7934 TOJSON_IMPL(enabled),
7935 TOJSON_IMPL(includeMemoryDetail),
7936 TOJSON_IMPL(includeTaskQueueDetail),
7940 static void from_json(
const nlohmann::json& j, EngineStatusReportConfiguration& p)
7943 getOptional<std::string>(
"fileName", p.fileName, j);
7944 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
7945 getOptional<bool>(
"enabled", p.enabled, j,
false);
7946 getOptional<std::string>(
"runCmd", p.runCmd, j);
7947 getOptional<bool>(
"includeMemoryDetail", p.includeMemoryDetail, j,
false);
7948 getOptional<bool>(
"includeTaskQueueDetail", p.includeTaskQueueDetail, j,
false);
7952 JSON_SERIALIZED_CLASS(EnginePolicy)
7966 IMPLEMENT_JSON_SERIALIZATION()
8023 dataDirectory.clear();
8034 namedAudioDevices.clear();
8035 externalCodecs.clear();
8037 statusReport.clear();
8041 static void to_json(nlohmann::json& j,
const EnginePolicy& p)
8044 TOJSON_IMPL(dataDirectory),
8045 TOJSON_IMPL(licensing),
8046 TOJSON_IMPL(security),
8047 TOJSON_IMPL(networking),
8049 TOJSON_IMPL(discovery),
8050 TOJSON_IMPL(logging),
8051 TOJSON_IMPL(internals),
8052 TOJSON_IMPL(timelines),
8053 TOJSON_IMPL(database),
8054 TOJSON_IMPL(featureset),
8055 TOJSON_IMPL(namedAudioDevices),
8056 TOJSON_IMPL(externalCodecs),
8057 TOJSON_IMPL(rtpMap),
8058 TOJSON_IMPL(statusReport)
8061 static void from_json(
const nlohmann::json& j, EnginePolicy& p)
8064 FROMJSON_IMPL_SIMPLE(dataDirectory);
8065 FROMJSON_IMPL_SIMPLE(licensing);
8066 FROMJSON_IMPL_SIMPLE(security);
8067 FROMJSON_IMPL_SIMPLE(networking);
8068 FROMJSON_IMPL_SIMPLE(audio);
8069 FROMJSON_IMPL_SIMPLE(discovery);
8070 FROMJSON_IMPL_SIMPLE(logging);
8071 FROMJSON_IMPL_SIMPLE(internals);
8072 FROMJSON_IMPL_SIMPLE(timelines);
8073 FROMJSON_IMPL_SIMPLE(database);
8074 FROMJSON_IMPL_SIMPLE(featureset);
8075 FROMJSON_IMPL_SIMPLE(namedAudioDevices);
8076 FROMJSON_IMPL_SIMPLE(externalCodecs);
8077 FROMJSON_IMPL_SIMPLE(rtpMap);
8078 FROMJSON_IMPL_SIMPLE(statusReport);
8083 JSON_SERIALIZED_CLASS(TalkgroupAsset)
8095 IMPLEMENT_JSON_SERIALIZATION()
8118 static void to_json(nlohmann::json& j,
const TalkgroupAsset& p)
8121 TOJSON_IMPL(nodeId),
8125 static void from_json(
const nlohmann::json& j, TalkgroupAsset& p)
8128 getOptional<std::string>(
"nodeId", p.nodeId, j);
8129 getOptional<Group>(
"group", p.group, j);
8133 JSON_SERIALIZED_CLASS(EngageDiscoveredGroup)
8143 IMPLEMENT_JSON_SERIALIZATION()
8173 static void to_json(nlohmann::json& j,
const EngageDiscoveredGroup& p)
8182 static void from_json(
const nlohmann::json& j, EngageDiscoveredGroup& p)
8185 getOptional<std::string>(
"id", p.id, j);
8186 getOptional<int>(
"type", p.type, j, 0);
8187 getOptional<NetworkAddress>(
"rx", p.rx, j);
8188 getOptional<NetworkAddress>(
"tx", p.tx, j);
8192 JSON_SERIALIZED_CLASS(RallypointPeer)
8204 IMPLEMENT_JSON_SERIALIZATION()
8211 olpUseRpConfiguration = 0,
8218 } OutboundLeafPolicy_t;
8223 olpUseRpWebSocketTlsConfiguration = 0,
8226 olpUseTlsForWebSocket = 1,
8229 olpDoNotUseTlsForWebSocket = 2
8230 } OutboundWebSocketTlsPolicy_t;
8274 certificate.clear();
8275 connectionTimeoutSecs = 0;
8276 forceIsMeshLeaf =
false;
8277 outboundLeafPolicy = OutboundLeafPolicy_t::olpUseRpConfiguration;
8278 protocol = Rallypoint::RpProtocol_t::rppTlsTcp;
8280 additionalProtocols.clear();
8281 outboundWebSocketTlsPolicy = OutboundWebSocketTlsPolicy_t::olpUseRpWebSocketTlsConfiguration;
8285 static void to_json(nlohmann::json& j,
const RallypointPeer& p)
8289 TOJSON_IMPL(enabled),
8291 TOJSON_IMPL(certificate),
8292 TOJSON_IMPL(connectionTimeoutSecs),
8293 TOJSON_IMPL(forceIsMeshLeaf),
8294 TOJSON_IMPL(outboundLeafPolicy),
8295 TOJSON_IMPL(protocol),
8297 TOJSON_IMPL(additionalProtocols),
8298 TOJSON_IMPL(outboundWebSocketTlsPolicy)
8301 static void from_json(
const nlohmann::json& j, RallypointPeer& p)
8304 j.at(
"id").get_to(p.id);
8305 getOptional<bool>(
"enabled", p.enabled, j,
true);
8306 getOptional<NetworkAddress>(
"host", p.host, j);
8307 getOptional<SecurityCertificate>(
"certificate", p.certificate, j);
8308 getOptional<int>(
"connectionTimeoutSecs", p.connectionTimeoutSecs, j, 0);
8309 getOptional<bool>(
"forceIsMeshLeaf", p.forceIsMeshLeaf, j,
false);
8310 getOptional<RallypointPeer::OutboundLeafPolicy_t>(
"outboundLeafPolicy", p.outboundLeafPolicy, j, RallypointPeer::OutboundLeafPolicy_t::olpUseRpConfiguration);
8311 getOptional<Rallypoint::RpProtocol_t>(
"protocol", p.protocol, j, Rallypoint::RpProtocol_t::rppTlsTcp);
8312 getOptional<std::string>(
"path", p.path, j);
8313 getOptional<std::string>(
"additionalProtocols", p.additionalProtocols, j);
8314 getOptional<RallypointPeer::OutboundWebSocketTlsPolicy_t>(
"outboundWebSocketTlsPolicy", p.outboundWebSocketTlsPolicy, j, RallypointPeer::OutboundWebSocketTlsPolicy_t::olpUseRpWebSocketTlsConfiguration);
8318 JSON_SERIALIZED_CLASS(RallypointServerLimits)
8330 IMPLEMENT_JSON_SERIALIZATION()
8388 maxMulticastReflectors = 0;
8389 maxRegisteredStreams = 0;
8391 maxRxPacketsPerSec = 0;
8392 maxTxPacketsPerSec = 0;
8393 maxRxBytesPerSec = 0;
8394 maxTxBytesPerSec = 0;
8396 maxInboundBacklog = 64;
8397 lowPriorityQueueThreshold = 64;
8398 normalPriorityQueueThreshold = 256;
8399 denyNewConnectionCpuThreshold = 75;
8400 warnAtCpuThreshold = 65;
8404 static void to_json(nlohmann::json& j,
const RallypointServerLimits& p)
8407 TOJSON_IMPL(maxClients),
8408 TOJSON_IMPL(maxPeers),
8409 TOJSON_IMPL(maxMulticastReflectors),
8410 TOJSON_IMPL(maxRegisteredStreams),
8411 TOJSON_IMPL(maxStreamPaths),
8412 TOJSON_IMPL(maxRxPacketsPerSec),
8413 TOJSON_IMPL(maxTxPacketsPerSec),
8414 TOJSON_IMPL(maxRxBytesPerSec),
8415 TOJSON_IMPL(maxTxBytesPerSec),
8416 TOJSON_IMPL(maxQOpsPerSec),
8417 TOJSON_IMPL(maxInboundBacklog),
8418 TOJSON_IMPL(lowPriorityQueueThreshold),
8419 TOJSON_IMPL(normalPriorityQueueThreshold),
8420 TOJSON_IMPL(denyNewConnectionCpuThreshold),
8421 TOJSON_IMPL(warnAtCpuThreshold)
8424 static void from_json(
const nlohmann::json& j, RallypointServerLimits& p)
8427 getOptional<uint32_t>(
"maxClients", p.maxClients, j, 0);
8428 getOptional<uint32_t>(
"maxPeers", p.maxPeers, j, 0);
8429 getOptional<uint32_t>(
"maxMulticastReflectors", p.maxMulticastReflectors, j, 0);
8430 getOptional<uint32_t>(
"maxRegisteredStreams", p.maxRegisteredStreams, j, 0);
8431 getOptional<uint32_t>(
"maxStreamPaths", p.maxStreamPaths, j, 0);
8432 getOptional<uint32_t>(
"maxRxPacketsPerSec", p.maxRxPacketsPerSec, j, 0);
8433 getOptional<uint32_t>(
"maxTxPacketsPerSec", p.maxTxPacketsPerSec, j, 0);
8434 getOptional<uint32_t>(
"maxRxBytesPerSec", p.maxRxBytesPerSec, j, 0);
8435 getOptional<uint32_t>(
"maxTxBytesPerSec", p.maxTxBytesPerSec, j, 0);
8436 getOptional<uint32_t>(
"maxQOpsPerSec", p.maxQOpsPerSec, j, 0);
8437 getOptional<uint32_t>(
"maxInboundBacklog", p.maxInboundBacklog, j, 64);
8438 getOptional<uint32_t>(
"lowPriorityQueueThreshold", p.lowPriorityQueueThreshold, j, 64);
8439 getOptional<uint32_t>(
"normalPriorityQueueThreshold", p.normalPriorityQueueThreshold, j, 256);
8440 getOptional<uint32_t>(
"denyNewConnectionCpuThreshold", p.denyNewConnectionCpuThreshold, j, 75);
8441 getOptional<uint32_t>(
"warnAtCpuThreshold", p.warnAtCpuThreshold, j, 65);
8445 JSON_SERIALIZED_CLASS(RallypointServerStatusReportConfiguration)
8457 IMPLEMENT_JSON_SERIALIZATION()
8492 includeLinks =
false;
8493 includePeerLinkDetails =
false;
8494 includeClientLinkDetails =
false;
8499 static void to_json(nlohmann::json& j,
const RallypointServerStatusReportConfiguration& p)
8502 TOJSON_IMPL(fileName),
8503 TOJSON_IMPL(intervalSecs),
8504 TOJSON_IMPL(enabled),
8505 TOJSON_IMPL(includeLinks),
8506 TOJSON_IMPL(includePeerLinkDetails),
8507 TOJSON_IMPL(includeClientLinkDetails),
8511 static void from_json(
const nlohmann::json& j, RallypointServerStatusReportConfiguration& p)
8514 getOptional<std::string>(
"fileName", p.fileName, j);
8515 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
8516 getOptional<bool>(
"enabled", p.enabled, j,
false);
8517 getOptional<bool>(
"includeLinks", p.includeLinks, j,
false);
8518 getOptional<bool>(
"includePeerLinkDetails", p.includePeerLinkDetails, j,
false);
8519 getOptional<bool>(
"includeClientLinkDetails", p.includeClientLinkDetails, j,
false);
8520 getOptional<std::string>(
"runCmd", p.runCmd, j);
8524 JSON_SERIALIZED_CLASS(RallypointServerLinkGraph)
8527 IMPLEMENT_JSON_SERIALIZATION()
8570 includeDigraphEnclosure =
true;
8571 includeClients =
false;
8572 coreRpStyling =
"[shape=hexagon color=firebrick style=filled]";
8573 leafRpStyling =
"[shape=box color=gray style=filled]";
8574 clientStyling.clear();
8579 static void to_json(nlohmann::json& j,
const RallypointServerLinkGraph& p)
8582 TOJSON_IMPL(fileName),
8583 TOJSON_IMPL(minRefreshSecs),
8584 TOJSON_IMPL(enabled),
8585 TOJSON_IMPL(includeDigraphEnclosure),
8586 TOJSON_IMPL(includeClients),
8587 TOJSON_IMPL(coreRpStyling),
8588 TOJSON_IMPL(leafRpStyling),
8589 TOJSON_IMPL(clientStyling),
8593 static void from_json(
const nlohmann::json& j, RallypointServerLinkGraph& p)
8596 getOptional<std::string>(
"fileName", p.fileName, j);
8597 getOptional<int>(
"minRefreshSecs", p.minRefreshSecs, j, 5);
8598 getOptional<bool>(
"enabled", p.enabled, j,
false);
8599 getOptional<bool>(
"includeDigraphEnclosure", p.includeDigraphEnclosure, j,
true);
8600 getOptional<bool>(
"includeClients", p.includeClients, j,
false);
8601 getOptional<std::string>(
"coreRpStyling", p.coreRpStyling, j,
"[shape=hexagon color=firebrick style=filled]");
8602 getOptional<std::string>(
"leafRpStyling", p.leafRpStyling, j,
"[shape=box color=gray style=filled]");
8603 getOptional<std::string>(
"clientStyling", p.clientStyling, j);
8604 getOptional<std::string>(
"runCmd", p.runCmd, j);
8609 JSON_SERIALIZED_CLASS(RallypointServerStreamStatsExport)
8619 IMPLEMENT_JSON_SERIALIZATION()
8662 resetCountersAfterExport =
false;
8668 static void to_json(nlohmann::json& j,
const RallypointServerStreamStatsExport& p)
8671 TOJSON_IMPL(fileName),
8672 TOJSON_IMPL(intervalSecs),
8673 TOJSON_IMPL(enabled),
8674 TOJSON_IMPL(resetCountersAfterExport),
8675 TOJSON_IMPL(runCmd),
8679 static void from_json(
const nlohmann::json& j, RallypointServerStreamStatsExport& p)
8682 getOptional<std::string>(
"fileName", p.fileName, j);
8683 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
8684 getOptional<bool>(
"enabled", p.enabled, j,
false);
8685 getOptional<bool>(
"resetCountersAfterExport", p.resetCountersAfterExport, j,
false);
8686 getOptional<std::string>(
"runCmd", p.runCmd, j);
8687 getOptional<RallypointServerStreamStatsExport::ExportFormat_t>(
"format", p.format, j, RallypointServerStreamStatsExport::ExportFormat_t::fmtCsv);
8691 JSON_SERIALIZED_CLASS(RallypointServerRouteMap)
8694 IMPLEMENT_JSON_SERIALIZATION()
8723 static void to_json(nlohmann::json& j,
const RallypointServerRouteMap& p)
8726 TOJSON_IMPL(fileName),
8727 TOJSON_IMPL(minRefreshSecs),
8728 TOJSON_IMPL(enabled),
8732 static void from_json(
const nlohmann::json& j, RallypointServerRouteMap& p)
8735 getOptional<std::string>(
"fileName", p.fileName, j);
8736 getOptional<int>(
"minRefreshSecs", p.minRefreshSecs, j, 5);
8737 getOptional<bool>(
"enabled", p.enabled, j,
false);
8738 getOptional<std::string>(
"runCmd", p.runCmd, j);
8743 JSON_SERIALIZED_CLASS(ExternalHealthCheckResponder)
8755 IMPLEMENT_JSON_SERIALIZATION()
8774 immediateClose =
true;
8778 static void to_json(nlohmann::json& j,
const ExternalHealthCheckResponder& p)
8781 TOJSON_IMPL(listenPort),
8782 TOJSON_IMPL(immediateClose)
8785 static void from_json(
const nlohmann::json& j, ExternalHealthCheckResponder& p)
8788 getOptional<int>(
"listenPort", p.listenPort, j, 0);
8789 getOptional<bool>(
"immediateClose", p.immediateClose, j,
true);
8794 JSON_SERIALIZED_CLASS(PeeringConfiguration)
8804 IMPLEMENT_JSON_SERIALIZATION()
8834 static void to_json(nlohmann::json& j,
const PeeringConfiguration& p)
8838 TOJSON_IMPL(version),
8839 TOJSON_IMPL(comments),
8843 static void from_json(
const nlohmann::json& j, PeeringConfiguration& p)
8846 getOptional<std::string>(
"id", p.id, j);
8847 getOptional<int>(
"version", p.version, j, 0);
8848 getOptional<std::string>(
"comments", p.comments, j);
8849 getOptional<std::vector<RallypointPeer>>(
"peers", p.peers, j);
8853 JSON_SERIALIZED_CLASS(IgmpSnooping)
8863 IMPLEMENT_JSON_SERIALIZATION()
8886 queryIntervalMs = 125000;
8887 subscriptionTimeoutMs = 0;
8891 static void to_json(nlohmann::json& j,
const IgmpSnooping& p)
8894 TOJSON_IMPL(enabled),
8895 TOJSON_IMPL(queryIntervalMs),
8896 TOJSON_IMPL(subscriptionTimeoutMs)
8899 static void from_json(
const nlohmann::json& j, IgmpSnooping& p)
8902 getOptional<bool>(
"enabled", p.enabled, j);
8903 getOptional<int>(
"queryIntervalMs", p.queryIntervalMs, j, 125000);
8904 getOptional<int>(
"subscriptionTimeoutMs", p.subscriptionTimeoutMs, j, 0);
8909 JSON_SERIALIZED_CLASS(RallypointReflector)
8918 IMPLEMENT_JSON_SERIALIZATION()
8933 } DirectionRestriction_t;
8965 multicastInterfaceName.clear();
8966 additionalTx.clear();
8967 directionRestriction = drNone;
8971 static void to_json(nlohmann::json& j,
const RallypointReflector& p)
8977 TOJSON_IMPL(multicastInterfaceName),
8978 TOJSON_IMPL(additionalTx),
8979 TOJSON_IMPL(directionRestriction)
8982 static void from_json(
const nlohmann::json& j, RallypointReflector& p)
8985 j.at(
"id").get_to(p.id);
8986 j.at(
"rx").get_to(p.rx);
8987 j.at(
"tx").get_to(p.tx);
8988 getOptional<std::string>(
"multicastInterfaceName", p.multicastInterfaceName, j);
8989 getOptional<std::vector<NetworkAddress>>(
"additionalTx", p.additionalTx, j);
8990 getOptional<RallypointReflector::DirectionRestriction_t>(
"directionRestriction", p.directionRestriction, j, RallypointReflector::DirectionRestriction_t::drNone);
8995 JSON_SERIALIZED_CLASS(RallypointUdpStreamingIpvX)
9004 IMPLEMENT_JSON_SERIALIZATION()
9026 static void to_json(nlohmann::json& j,
const RallypointUdpStreamingIpvX& p)
9029 TOJSON_IMPL(enabled),
9030 TOJSON_IMPL(external)
9033 static void from_json(
const nlohmann::json& j, RallypointUdpStreamingIpvX& p)
9036 getOptional<bool>(
"enabled", p.enabled, j,
true);
9037 getOptional<NetworkAddress>(
"external", p.external, j);
9041 JSON_SERIALIZED_CLASS(RallypointUdpStreaming)
9050 IMPLEMENT_JSON_SERIALIZATION()
9061 ctSharedKeyAes256FullIv = 1,
9064 ctSharedKeyAes256IdxIv = 2,
9067 ctSharedKeyChaCha20FullIv = 3,
9070 ctSharedKeyChaCha20IdxIv = 4
9106 cryptoType = CryptoType_t::ctSharedKeyAes256FullIv;
9110 keepaliveIntervalSecs = 15;
9111 priority = TxPriority_t::priVoice;
9116 static void to_json(nlohmann::json& j,
const RallypointUdpStreaming& p)
9119 TOJSON_IMPL(enabled),
9120 TOJSON_IMPL(cryptoType),
9121 TOJSON_IMPL(listenPort),
9122 TOJSON_IMPL(keepaliveIntervalSecs),
9125 TOJSON_IMPL(priority),
9129 static void from_json(
const nlohmann::json& j, RallypointUdpStreaming& p)
9132 getOptional<bool>(
"enabled", p.enabled, j,
true);
9133 getOptional<RallypointUdpStreaming::CryptoType_t>(
"cryptoType", p.cryptoType, j, RallypointUdpStreaming::CryptoType_t::ctSharedKeyAes256FullIv);
9134 getOptional<int>(
"listenPort", p.listenPort, j, 7444);
9135 getOptional<int>(
"keepaliveIntervalSecs", p.keepaliveIntervalSecs, j, 15);
9136 getOptional<RallypointUdpStreamingIpvX>(
"ipv4", p.ipv4, j);
9137 getOptional<RallypointUdpStreamingIpvX>(
"ipv6", p.ipv6, j);
9138 getOptional<TxPriority_t>(
"priority", p.priority, j, TxPriority_t::priVoice);
9139 getOptional<int>(
"ttl", p.ttl, j, 64);
9143 JSON_SERIALIZED_CLASS(RallypointRpRtTimingBehavior)
9152 IMPLEMENT_JSON_SERIALIZATION()
9197 static void to_json(nlohmann::json& j,
const RallypointRpRtTimingBehavior& p)
9200 TOJSON_IMPL(behavior),
9201 TOJSON_IMPL(atOrAboveMs),
9205 static void from_json(
const nlohmann::json& j, RallypointRpRtTimingBehavior& p)
9208 getOptional<RallypointRpRtTimingBehavior::BehaviorType_t>(
"behavior", p.behavior, j, RallypointRpRtTimingBehavior::BehaviorType_t::btNone);
9209 getOptional<uint32_t>(
"atOrAboveMs", p.atOrAboveMs, j, 0);
9210 getOptional<std::string>(
"runCmd", p.runCmd, j);
9215 JSON_SERIALIZED_CLASS(RallypointWebsocketSettings)
9224 IMPLEMENT_JSON_SERIALIZATION()
9252 certificate.clear();
9253 requireClientCertificate =
false;
9258 static void to_json(nlohmann::json& j,
const RallypointWebsocketSettings& p)
9261 TOJSON_IMPL(enabled),
9262 TOJSON_IMPL(listenPort),
9263 TOJSON_IMPL(certificate),
9264 TOJSON_IMPL(requireClientCertificate),
9265 TOJSON_IMPL(requireTls)
9268 static void from_json(
const nlohmann::json& j, RallypointWebsocketSettings& p)
9271 getOptional<bool>(
"enabled", p.enabled, j,
false);
9272 getOptional<int>(
"listenPort", p.listenPort, j, 8443);
9273 getOptional<SecurityCertificate>(
"certificate", p.certificate, j);
9274 getOptional<bool>(
"requireClientCertificate", p.requireClientCertificate, j,
false);
9275 getOptional<bool>(
"requireTls", p.requireTls, j,
true);
9281 JSON_SERIALIZED_CLASS(RallypointAdvertisingSettings)
9290 IMPLEMENT_JSON_SERIALIZATION()
9321 serviceName =
"_rallypoint._tcp.local.";
9322 interfaceName.clear();
9328 static void to_json(nlohmann::json& j,
const RallypointAdvertisingSettings& p)
9331 TOJSON_IMPL(enabled),
9332 TOJSON_IMPL(hostName),
9333 TOJSON_IMPL(serviceName),
9334 TOJSON_IMPL(interfaceName),
9339 static void from_json(
const nlohmann::json& j, RallypointAdvertisingSettings& p)
9342 getOptional<bool>(
"enabled", p.enabled, j,
false);
9343 getOptional<std::string>(
"hostName", p.hostName, j);
9344 getOptional<std::string>(
"serviceName", p.serviceName, j,
"_rallypoint._tcp.local.");
9345 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
9347 getOptional<int>(
"port", p.port, j, 0);
9348 getOptional<int>(
"ttl", p.ttl, j, 60);
9355 JSON_SERIALIZED_CLASS(NamedIdentity)
9364 IMPLEMENT_JSON_SERIALIZATION()
9382 certificate.clear();
9386 static void to_json(nlohmann::json& j,
const NamedIdentity& p)
9390 TOJSON_IMPL(certificate)
9393 static void from_json(
const nlohmann::json& j, NamedIdentity& p)
9396 getOptional<std::string>(
"name", p.name, j);
9397 getOptional<SecurityCertificate>(
"certificate", p.certificate, j);
9401 JSON_SERIALIZED_CLASS(RallypointExtendedGroupRestriction)
9410 IMPLEMENT_JSON_SERIALIZATION()
9428 restrictions.clear();
9432 static void to_json(nlohmann::json& j,
const RallypointExtendedGroupRestriction& p)
9436 TOJSON_IMPL(restrictions)
9439 static void from_json(
const nlohmann::json& j, RallypointExtendedGroupRestriction& p)
9442 getOptional<std::string>(
"id", p.id, j);
9443 getOptional<std::vector<StringRestrictionList>>(
"restrictions", p.restrictions, j);
9448 JSON_SERIALIZED_CLASS(RallypointServer)
9459 IMPLEMENT_JSON_SERIALIZATION()
9467 sptCertPublicKey = 2,
9470 sptCertFingerprint = 5,
9484 } StreamIdPrivacyType_t;
9684 interfaceName.clear();
9685 certificate.clear();
9686 allowMulticastForwarding =
false;
9687 peeringConfiguration.clear();
9688 peeringConfigurationFileName.clear();
9689 peeringConfigurationFileCommand.clear();
9690 peeringConfigurationFileCheckSecs = 60;
9692 statusReport.clear();
9695 externalHealthCheckResponder.clear();
9696 allowPeerForwarding =
false;
9697 multicastInterfaceName.clear();
9700 forwardDiscoveredGroups =
false;
9701 forwardMulticastAddressing =
false;
9703 disableMessageSigning =
false;
9704 multicastRestrictions.clear();
9705 igmpSnooping.clear();
9706 staticReflectors.clear();
9707 tcpTxOptions.clear();
9708 multicastTxOptions.clear();
9709 certStoreFileName.clear();
9710 certStorePasswordHex.clear();
9711 groupRestrictions.clear();
9712 configurationCheckSignalName =
"rts.7b392d1.${id}";
9715 udpStreaming.clear();
9717 normalTaskQueueBias = 0;
9718 enableLeafReflectionReverseSubscription =
false;
9719 disableLoopDetection =
false;
9720 maxSecurityLevel = 0;
9722 streamStatsExport.clear();
9723 maxOutboundPeerConnectionIntervalDeltaSecs = 15;
9724 peerRtTestIntervalMs = 60000;
9725 peerRtBehaviors.clear();
9728 advertising.clear();
9729 extendedGroupRestrictions.clear();
9730 groupRestrictionAccessPolicyType = GroupRestrictionAccessPolicyType_t::graptPermissive;
9731 ipFamily = IpFamilyType_t::ifIp4;
9735 allowedDomains.clear();
9736 blockedDomains.clear();
9737 extraDomains.clear();
9739 additionalIdentities.clear();
9740 streamIdPrivacyType = StreamIdPrivacyType_t::sptDefault;
9744 static void to_json(nlohmann::json& j,
const RallypointServer& p)
9747 TOJSON_IMPL(fipsCrypto),
9748 TOJSON_IMPL(watchdog),
9751 TOJSON_IMPL(listenPort),
9752 TOJSON_IMPL(interfaceName),
9753 TOJSON_IMPL(certificate),
9754 TOJSON_IMPL(allowMulticastForwarding),
9756 TOJSON_IMPL(peeringConfigurationFileName),
9757 TOJSON_IMPL(peeringConfigurationFileCommand),
9758 TOJSON_IMPL(peeringConfigurationFileCheckSecs),
9759 TOJSON_IMPL(ioPools),
9760 TOJSON_IMPL(statusReport),
9761 TOJSON_IMPL(limits),
9762 TOJSON_IMPL(linkGraph),
9763 TOJSON_IMPL(externalHealthCheckResponder),
9764 TOJSON_IMPL(allowPeerForwarding),
9765 TOJSON_IMPL(multicastInterfaceName),
9767 TOJSON_IMPL(discovery),
9768 TOJSON_IMPL(forwardDiscoveredGroups),
9769 TOJSON_IMPL(forwardMulticastAddressing),
9770 TOJSON_IMPL(isMeshLeaf),
9771 TOJSON_IMPL(disableMessageSigning),
9772 TOJSON_IMPL(multicastRestrictions),
9773 TOJSON_IMPL(igmpSnooping),
9774 TOJSON_IMPL(staticReflectors),
9775 TOJSON_IMPL(tcpTxOptions),
9776 TOJSON_IMPL(multicastTxOptions),
9777 TOJSON_IMPL(certStoreFileName),
9778 TOJSON_IMPL(certStorePasswordHex),
9779 TOJSON_IMPL(groupRestrictions),
9780 TOJSON_IMPL(configurationCheckSignalName),
9781 TOJSON_IMPL(featureset),
9782 TOJSON_IMPL(licensing),
9783 TOJSON_IMPL(udpStreaming),
9784 TOJSON_IMPL(sysFlags),
9785 TOJSON_IMPL(normalTaskQueueBias),
9786 TOJSON_IMPL(enableLeafReflectionReverseSubscription),
9787 TOJSON_IMPL(disableLoopDetection),
9788 TOJSON_IMPL(maxSecurityLevel),
9789 TOJSON_IMPL(routeMap),
9790 TOJSON_IMPL(streamStatsExport),
9791 TOJSON_IMPL(maxOutboundPeerConnectionIntervalDeltaSecs),
9792 TOJSON_IMPL(peerRtTestIntervalMs),
9793 TOJSON_IMPL(peerRtBehaviors),
9794 TOJSON_IMPL(websocket),
9796 TOJSON_IMPL(advertising),
9797 TOJSON_IMPL(extendedGroupRestrictions),
9798 TOJSON_IMPL(groupRestrictionAccessPolicyType),
9799 TOJSON_IMPL(ipFamily),
9800 TOJSON_IMPL(rxCapture),
9801 TOJSON_IMPL(txCapture),
9802 TOJSON_IMPL(domainName),
9803 TOJSON_IMPL(allowedDomains),
9804 TOJSON_IMPL(blockedDomains),
9805 TOJSON_IMPL(extraDomains),
9806 TOJSON_IMPL(tuning),
9807 TOJSON_IMPL(additionalIdentities),
9808 TOJSON_IMPL(streamIdPrivacyType)
9811 static void from_json(
const nlohmann::json& j, RallypointServer& p)
9814 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
9815 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
9816 getOptional<std::string>(
"id", p.id, j);
9817 getOptional<std::string>(
"name", p.name, j);
9818 getOptional<SecurityCertificate>(
"certificate", p.certificate, j);
9819 getOptional<std::string>(
"interfaceName", p.interfaceName, j);
9820 getOptional<int>(
"listenPort", p.listenPort, j, 7443);
9821 getOptional<bool>(
"allowMulticastForwarding", p.allowMulticastForwarding, j,
false);
9823 getOptional<std::string>(
"peeringConfigurationFileName", p.peeringConfigurationFileName, j);
9824 getOptional<std::string>(
"peeringConfigurationFileCommand", p.peeringConfigurationFileCommand, j);
9825 getOptional<int>(
"peeringConfigurationFileCheckSecs", p.peeringConfigurationFileCheckSecs, j, 60);
9826 getOptional<int>(
"ioPools", p.ioPools, j, -1);
9827 getOptional<RallypointServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
9828 getOptional<RallypointServerLimits>(
"limits", p.limits, j);
9829 getOptional<RallypointServerLinkGraph>(
"linkGraph", p.linkGraph, j);
9830 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
9831 getOptional<bool>(
"allowPeerForwarding", p.allowPeerForwarding, j,
false);
9832 getOptional<std::string>(
"multicastInterfaceName", p.multicastInterfaceName, j);
9833 getOptional<Tls>(
"tls", p.tls, j);
9834 getOptional<DiscoveryConfiguration>(
"discovery", p.discovery, j);
9835 getOptional<bool>(
"forwardDiscoveredGroups", p.forwardDiscoveredGroups, j,
false);
9836 getOptional<bool>(
"forwardMulticastAddressing", p.forwardMulticastAddressing, j,
false);
9837 getOptional<bool>(
"isMeshLeaf", p.isMeshLeaf, j,
false);
9838 getOptional<bool>(
"disableMessageSigning", p.disableMessageSigning, j,
false);
9839 getOptional<NetworkAddressRestrictionList>(
"multicastRestrictions", p.multicastRestrictions, j);
9840 getOptional<IgmpSnooping>(
"igmpSnooping", p.igmpSnooping, j);
9841 getOptional<std::vector<RallypointReflector>>(
"staticReflectors", p.staticReflectors, j);
9842 getOptional<TcpNetworkTxOptions>(
"tcpTxOptions", p.tcpTxOptions, j);
9843 getOptional<NetworkTxOptions>(
"multicastTxOptions", p.multicastTxOptions, j);
9844 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
9845 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
9846 getOptional<StringRestrictionList>(
"groupRestrictions", p.groupRestrictions, j);
9847 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.7b392d1.${id}");
9848 getOptional<Licensing>(
"licensing", p.licensing, j);
9849 getOptional<Featureset>(
"featureset", p.featureset, j);
9850 getOptional<RallypointUdpStreaming>(
"udpStreaming", p.udpStreaming, j);
9851 getOptional<uint32_t>(
"sysFlags", p.sysFlags, j, 0);
9852 getOptional<uint32_t>(
"normalTaskQueueBias", p.normalTaskQueueBias, j, 0);
9853 getOptional<bool>(
"enableLeafReflectionReverseSubscription", p.enableLeafReflectionReverseSubscription, j,
false);
9854 getOptional<bool>(
"disableLoopDetection", p.disableLoopDetection, j,
false);
9855 getOptional<uint32_t>(
"maxSecurityLevel", p.maxSecurityLevel, j, 0);
9856 getOptional<RallypointServerRouteMap>(
"routeMap", p.routeMap, j);
9857 getOptional<RallypointServerStreamStatsExport>(
"streamStatsExport", p.streamStatsExport, j);
9858 getOptional<uint32_t>(
"maxOutboundPeerConnectionIntervalDeltaSecs", p.maxOutboundPeerConnectionIntervalDeltaSecs, j, 15);
9859 getOptional<int>(
"peerRtTestIntervalMs", p.peerRtTestIntervalMs, j, 60000);
9860 getOptional<std::vector<RallypointRpRtTimingBehavior>>(
"peerRtBehaviors", p.peerRtBehaviors, j);
9861 getOptional<RallypointWebsocketSettings>(
"websocket", p.websocket, j);
9862 getOptional<NsmConfiguration>(
"nsm", p.nsm, j);
9863 getOptional<RallypointAdvertisingSettings>(
"advertising", p.advertising, j);
9864 getOptional<std::vector<RallypointExtendedGroupRestriction>>(
"extendedGroupRestrictions", p.extendedGroupRestrictions, j);
9865 getOptional<GroupRestrictionAccessPolicyType_t>(
"groupRestrictionAccessPolicyType", p.groupRestrictionAccessPolicyType, j, GroupRestrictionAccessPolicyType_t::graptPermissive);
9866 getOptional<IpFamilyType_t>(
"ipFamily", p.ipFamily, j, IpFamilyType_t::ifIp4);
9867 getOptional<PacketCapturer>(
"rxCapture", p.rxCapture, j);
9868 getOptional<PacketCapturer>(
"txCapture", p.txCapture, j);
9869 getOptional<std::string>(
"domainName", p.domainName, j);
9870 getOptional<std::vector<std::string>>(
"allowedDomains", p.allowedDomains, j);
9871 getOptional<std::vector<std::string>>(
"blockedDomains", p.blockedDomains, j);
9872 getOptional<std::vector<std::string>>(
"extraDomains", p.extraDomains, j);
9873 getOptional<TuningSettings>(
"tuning", p.tuning, j);
9874 getOptional<std::vector<NamedIdentity>>(
"additionalIdentities", p.additionalIdentities, j);
9875 getOptional<RallypointServer::StreamIdPrivacyType_t>(
"streamIdPrivacyType", p.streamIdPrivacyType, j, RallypointServer::StreamIdPrivacyType_t::sptDefault);
9879 JSON_SERIALIZED_CLASS(NsmNodeScripts)
9887 IMPLEMENT_JSON_SERIALIZATION()
9892 std::string beforeGoingActive;
9893 std::string onGoingActive;
9894 std::string beforeActive;
9895 std::string onActive;
9896 std::string inDashboard;
9897 std::string onStatusReport;
9907 beforeGoingActive.clear();
9908 onGoingActive.clear();
9909 beforeActive.clear();
9911 inDashboard.clear();
9912 onStatusReport.clear();
9919 TOJSON_IMPL(onIdle),
9920 TOJSON_IMPL(beforeGoingActive),
9921 TOJSON_IMPL(onGoingActive),
9922 TOJSON_IMPL(beforeActive),
9923 TOJSON_IMPL(onActive),
9924 TOJSON_IMPL(inDashboard),
9925 TOJSON_IMPL(onStatusReport)
9928 static void from_json(
const nlohmann::json& j, NsmNodeScripts& p)
9931 getOptional<std::string>(
"onIdle", p.onIdle, j);
9932 getOptional<std::string>(
"beforeGoingActive", p.beforeGoingActive, j);
9933 getOptional<std::string>(
"onGoingActive", p.onGoingActive, j);
9934 getOptional<std::string>(
"beforeActive", p.beforeActive, j);
9935 getOptional<std::string>(
"onActive", p.onActive, j);
9936 getOptional<std::string>(
"inDashboard", p.inDashboard, j);
9937 getOptional<std::string>(
"onStatusReport", p.onStatusReport, j);
9941 JSON_SERIALIZED_CLASS(NsmNodeLogging)
9949 IMPLEMENT_JSON_SERIALIZATION()
9957 bool logCommandOutput;
9958 bool logResourceStates;
9969 logCommandOutput =
false;
9970 logResourceStates =
false;
9974 static void to_json(nlohmann::json& j,
const NsmNodeLogging& p)
9978 TOJSON_IMPL(dashboard),
9979 TOJSON_IMPL(logCommandOutput),
9980 TOJSON_IMPL(logResourceStates)
9983 static void from_json(
const nlohmann::json& j, NsmNodeLogging& p)
9986 getOptional<int>(
"level", p.level, j, 3);
9987 getOptional<bool>(
"dashboard", p.dashboard, j,
false);
9988 getOptional<bool>(
"logCommandOutput", p.logCommandOutput, j,
false);
9989 getOptional<bool>(
"logResourceStates", p.logResourceStates, j,
false);
9993 JSON_SERIALIZED_CLASS(NsmNodePeriodic)
10001 IMPLEMENT_JSON_SERIALIZATION()
10007 std::string command;
10024 j = nlohmann::json{
10026 TOJSON_IMPL(intervalSecs),
10027 TOJSON_IMPL(command)
10030 static void from_json(
const nlohmann::json& j, NsmNodePeriodic& p)
10033 getOptional<std::string>(
"id", p.id, j);
10034 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 1);
10035 getOptional<std::string>(
"command", p.command, j);
10039 JSON_SERIALIZED_CLASS(NsmNodeCotSettings)
10047 IMPLEMENT_JSON_SERIALIZATION()
10079 detailJson.clear();
10083 static void to_json(nlohmann::json& j,
const NsmNodeCotSettings& p)
10085 j = nlohmann::json{
10086 TOJSON_IMPL(useCot),
10095 TOJSON_IMPL(detailJson)
10098 static void from_json(
const nlohmann::json& j, NsmNodeCotSettings& p)
10101 getOptional<bool>(
"useCot", p.useCot, j,
false);
10102 getOptional<std::string>(
"uid", p.uid, j);
10103 getOptional<std::string>(
"type", p.type, j);
10104 getOptional<std::string>(
"how", p.how, j);
10105 getOptional<std::string>(
"lat", p.lat, j);
10106 getOptional<std::string>(
"lon", p.lon, j);
10107 getOptional<std::string>(
"ce", p.ce, j);
10108 getOptional<std::string>(
"hae", p.hae, j);
10109 getOptional<std::string>(
"le", p.le, j);
10110 getOptional<std::string>(
"detailJson", p.detailJson, j);
10114 JSON_SERIALIZED_CLASS(NsmNodeStatusReportConfiguration)
10126 IMPLEMENT_JSON_SERIALIZATION()
10155 includeResourceDetail =
false;
10160 static void to_json(nlohmann::json& j,
const NsmNodeStatusReportConfiguration& p)
10162 j = nlohmann::json{
10163 TOJSON_IMPL(fileName),
10164 TOJSON_IMPL(intervalSecs),
10165 TOJSON_IMPL(enabled),
10166 TOJSON_IMPL(includeResourceDetail),
10167 TOJSON_IMPL(runCmd)
10170 static void from_json(
const nlohmann::json& j, NsmNodeStatusReportConfiguration& p)
10173 getOptional<std::string>(
"fileName", p.fileName, j);
10174 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
10175 getOptional<bool>(
"enabled", p.enabled, j,
false);
10176 getOptional<std::string>(
"runCmd", p.runCmd, j);
10177 getOptional<bool>(
"includeResourceDetail", p.includeResourceDetail, j,
false);
10181 JSON_SERIALIZED_CLASS(NsmNode)
10192 IMPLEMENT_JSON_SERIALIZATION()
10193 IMPLEMENT_JSON_DOCUMENTATION(
NsmNode)
10270 fipsCrypto.clear();
10274 domainName.clear();
10275 multicastInterfaceName.clear();
10276 stateMachine.clear();
10277 defaultPriority = 0;
10279 dashboardToken =
false;
10284 statusReport.clear();
10285 configurationCheckSignalName =
"rts.7b392d1.${id}";
10287 featureset.clear();
10291 ipFamily = IpFamilyType_t::ifIp4;
10295 static void to_json(nlohmann::json& j,
const NsmNode& p)
10297 j = nlohmann::json{
10298 TOJSON_IMPL(fipsCrypto),
10299 TOJSON_IMPL(watchdog),
10302 TOJSON_IMPL(domainName),
10303 TOJSON_IMPL(multicastInterfaceName),
10304 TOJSON_IMPL(stateMachine),
10305 TOJSON_IMPL(defaultPriority),
10306 TOJSON_IMPL(fixedToken),
10307 TOJSON_IMPL(dashboardToken),
10308 TOJSON_IMPL(scripts),
10309 TOJSON_IMPL(logging),
10311 TOJSON_IMPL(periodics),
10312 TOJSON_IMPL(statusReport),
10313 TOJSON_IMPL(configurationCheckSignalName),
10314 TOJSON_IMPL(featureset),
10315 TOJSON_IMPL(licensing),
10316 TOJSON_IMPL(ipFamily),
10317 TOJSON_IMPL(rxCapture),
10318 TOJSON_IMPL(txCapture),
10319 TOJSON_IMPL(tuning)
10322 static void from_json(
const nlohmann::json& j, NsmNode& p)
10325 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
10326 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
10327 getOptional<std::string>(
"id", p.id, j);
10328 getOptional<std::string>(
"name", p.name, j);
10329 getOptional<std::string>(
"domainName", p.domainName, j);
10330 getOptional<std::string>(
"multicastInterfaceName", p.multicastInterfaceName, j);
10331 getOptional<NsmConfiguration>(
"stateMachine", p.stateMachine, j);
10332 getOptional<int>(
"defaultPriority", p.defaultPriority, j, 0);
10333 getOptional<int>(
"fixedToken", p.fixedToken, j, -1);
10334 getOptional<bool>(
"dashboardToken", p.dashboardToken, j,
false);
10335 getOptional<NsmNodeScripts>(
"scripts", p.scripts, j);
10336 getOptional<NsmNodeLogging>(
"logging", p.logging, j);
10337 getOptional<NsmNodeCotSettings>(
"cot", p.cot, j);
10338 getOptional<std::vector<NsmNodePeriodic>>(
"periodics", p.periodics, j);
10339 getOptional<NsmNodeStatusReportConfiguration>(
"statusReport", p.statusReport, j);
10340 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.7b392d1.${id}");
10341 getOptional<Licensing>(
"licensing", p.licensing, j);
10342 getOptional<Featureset>(
"featureset", p.featureset, j);
10343 getOptional<PacketCapturer>(
"rxCapture", p.rxCapture, j);
10344 getOptional<PacketCapturer>(
"txCapture", p.txCapture, j);
10345 getOptional<TuningSettings>(
"tuning", p.tuning, j);
10346 getOptional<IpFamilyType_t>(
"ipFamily", p.ipFamily, j, IpFamilyType_t::ifIp4);
10349 JSON_SERIALIZED_CLASS(PlatformDiscoveredService)
10361 IMPLEMENT_JSON_SERIALIZATION()
10396 configurationVersion = 0;
10400 static void to_json(nlohmann::json& j,
const PlatformDiscoveredService& p)
10402 j = nlohmann::json{
10406 TOJSON_IMPL(address),
10408 TOJSON_IMPL(configurationVersion)
10411 static void from_json(
const nlohmann::json& j, PlatformDiscoveredService& p)
10414 getOptional<std::string>(
"id", p.id, j);
10415 getOptional<std::string>(
"type", p.type, j);
10416 getOptional<std::string>(
"name", p.name, j);
10417 getOptional<NetworkAddress>(
"address", p.address, j);
10418 getOptional<std::string>(
"uri", p.uri, j);
10419 getOptional<uint32_t>(
"configurationVersion", p.configurationVersion, j, 0);
10459 IMPLEMENT_JSON_SERIALIZATION()
10505 mostRecentFirst =
true;
10506 startedOnOrAfter = 0;
10507 endedOnOrBefore = 0;
10510 onlyCommitted =
true;
10512 onlyNodeId.clear();
10518 static void to_json(nlohmann::json& j,
const TimelineQueryParameters& p)
10520 j = nlohmann::json{
10521 TOJSON_IMPL(maxCount),
10522 TOJSON_IMPL(mostRecentFirst),
10523 TOJSON_IMPL(startedOnOrAfter),
10524 TOJSON_IMPL(endedOnOrBefore),
10525 TOJSON_IMPL(onlyDirection),
10526 TOJSON_IMPL(onlyType),
10527 TOJSON_IMPL(onlyCommitted),
10528 TOJSON_IMPL(onlyAlias),
10529 TOJSON_IMPL(onlyNodeId),
10530 TOJSON_IMPL(onlyTxId),
10534 static void from_json(
const nlohmann::json& j, TimelineQueryParameters& p)
10537 getOptional<long>(
"maxCount", p.maxCount, j, 50);
10538 getOptional<bool>(
"mostRecentFirst", p.mostRecentFirst, j,
false);
10539 getOptional<uint64_t>(
"startedOnOrAfter", p.startedOnOrAfter, j, 0);
10540 getOptional<uint64_t>(
"endedOnOrBefore", p.endedOnOrBefore, j, 0);
10541 getOptional<int>(
"onlyDirection", p.onlyDirection, j, 0);
10542 getOptional<int>(
"onlyType", p.onlyType, j, 0);
10543 getOptional<bool>(
"onlyCommitted", p.onlyCommitted, j,
true);
10544 getOptional<std::string>(
"onlyAlias", p.onlyAlias, j, EMPTY_STRING);
10545 getOptional<std::string>(
"onlyNodeId", p.onlyNodeId, j, EMPTY_STRING);
10546 getOptional<int>(
"onlyTxId", p.onlyTxId, j, 0);
10547 getOptional<std::string>(
"sql", p.sql, j, EMPTY_STRING);
10551 JSON_SERIALIZED_CLASS(CertStoreCertificate)
10560 IMPLEMENT_JSON_SERIALIZATION()
10587 certificatePem.clear();
10588 privateKeyPem.clear();
10589 internalData =
nullptr;
10594 static void to_json(nlohmann::json& j,
const CertStoreCertificate& p)
10596 j = nlohmann::json{
10598 TOJSON_IMPL(certificatePem),
10599 TOJSON_IMPL(privateKeyPem),
10603 static void from_json(
const nlohmann::json& j, CertStoreCertificate& p)
10606 j.at(
"id").get_to(p.id);
10607 j.at(
"certificatePem").get_to(p.certificatePem);
10608 getOptional<std::string>(
"privateKeyPem", p.privateKeyPem, j, EMPTY_STRING);
10609 getOptional<std::string>(
"tags", p.tags, j, EMPTY_STRING);
10613 JSON_SERIALIZED_CLASS(CertStore)
10622 IMPLEMENT_JSON_SERIALIZATION()
10623 IMPLEMENT_JSON_DOCUMENTATION(
CertStore)
10643 certificates.clear();
10648 static void to_json(nlohmann::json& j,
const CertStore& p)
10650 j = nlohmann::json{
10652 TOJSON_IMPL(certificates),
10656 static void from_json(
const nlohmann::json& j, CertStore& p)
10659 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
10660 getOptional<std::vector<CertStoreCertificate>>(
"certificates", p.certificates, j);
10661 getOptional<std::vector<KvPair>>(
"kvp", p.kvp, j);
10665 JSON_SERIALIZED_CLASS(CertStoreCertificateElement)
10674 IMPLEMENT_JSON_SERIALIZATION()
10698 hasPrivateKey =
false;
10703 static void to_json(nlohmann::json& j,
const CertStoreCertificateElement& p)
10705 j = nlohmann::json{
10707 TOJSON_IMPL(hasPrivateKey),
10711 if(!p.certificatePem.empty())
10713 j[
"certificatePem"] = p.certificatePem;
10716 static void from_json(
const nlohmann::json& j, CertStoreCertificateElement& p)
10719 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
10720 getOptional<bool>(
"hasPrivateKey", p.hasPrivateKey, j,
false);
10721 getOptional<std::string>(
"certificatePem", p.certificatePem, j, EMPTY_STRING);
10722 getOptional<std::string>(
"tags", p.tags, j, EMPTY_STRING);
10726 JSON_SERIALIZED_CLASS(CertStoreDescriptor)
10735 IMPLEMENT_JSON_SERIALIZATION()
10768 certificates.clear();
10773 static void to_json(nlohmann::json& j,
const CertStoreDescriptor& p)
10775 j = nlohmann::json{
10777 TOJSON_IMPL(fileName),
10778 TOJSON_IMPL(version),
10779 TOJSON_IMPL(flags),
10780 TOJSON_IMPL(certificates),
10784 static void from_json(
const nlohmann::json& j, CertStoreDescriptor& p)
10787 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
10788 getOptional<std::string>(
"fileName", p.fileName, j, EMPTY_STRING);
10789 getOptional<int>(
"version", p.version, j, 0);
10790 getOptional<int>(
"flags", p.flags, j, 0);
10791 getOptional<std::vector<CertStoreCertificateElement>>(
"certificates", p.certificates, j);
10792 getOptional<std::vector<KvPair>>(
"kvp", p.kvp, j);
10796 JSON_SERIALIZED_CLASS(CertificateSubjectElement)
10805 IMPLEMENT_JSON_SERIALIZATION()
10827 static void to_json(nlohmann::json& j,
const CertificateSubjectElement& p)
10829 j = nlohmann::json{
10834 static void from_json(
const nlohmann::json& j, CertificateSubjectElement& p)
10837 getOptional<std::string>(
"name", p.name, j, EMPTY_STRING);
10838 getOptional<std::string>(
"value", p.value, j, EMPTY_STRING);
10843 JSON_SERIALIZED_CLASS(CertificateDescriptor)
10852 IMPLEMENT_JSON_SERIALIZATION()
10901 selfSigned =
false;
10906 fingerprint.clear();
10907 subjectElements.clear();
10908 issuerElements.clear();
10909 certificatePem.clear();
10910 publicKeyPem.clear();
10914 static void to_json(nlohmann::json& j,
const CertificateDescriptor& p)
10916 j = nlohmann::json{
10917 TOJSON_IMPL(subject),
10918 TOJSON_IMPL(issuer),
10919 TOJSON_IMPL(selfSigned),
10920 TOJSON_IMPL(version),
10921 TOJSON_IMPL(notBefore),
10922 TOJSON_IMPL(notAfter),
10923 TOJSON_IMPL(serial),
10924 TOJSON_IMPL(fingerprint),
10925 TOJSON_IMPL(subjectElements),
10926 TOJSON_IMPL(issuerElements),
10927 TOJSON_IMPL(certificatePem),
10928 TOJSON_IMPL(publicKeyPem)
10931 static void from_json(
const nlohmann::json& j, CertificateDescriptor& p)
10934 getOptional<std::string>(
"subject", p.subject, j, EMPTY_STRING);
10935 getOptional<std::string>(
"issuer", p.issuer, j, EMPTY_STRING);
10936 getOptional<bool>(
"selfSigned", p.selfSigned, j,
false);
10937 getOptional<int>(
"version", p.version, j, 0);
10938 getOptional<std::string>(
"notBefore", p.notBefore, j, EMPTY_STRING);
10939 getOptional<std::string>(
"notAfter", p.notAfter, j, EMPTY_STRING);
10940 getOptional<std::string>(
"serial", p.serial, j, EMPTY_STRING);
10941 getOptional<std::string>(
"fingerprint", p.fingerprint, j, EMPTY_STRING);
10942 getOptional<std::string>(
"certificatePem", p.certificatePem, j, EMPTY_STRING);
10943 getOptional<std::string>(
"publicKeyPem", p.publicKeyPem, j, EMPTY_STRING);
10944 getOptional<std::vector<CertificateSubjectElement>>(
"subjectElements", p.subjectElements, j);
10945 getOptional<std::vector<CertificateSubjectElement>>(
"issuerElements", p.issuerElements, j);
10950 JSON_SERIALIZED_CLASS(RiffDescriptor)
10962 IMPLEMENT_JSON_SERIALIZATION()
11003 certDescriptor.clear();
11008 static void to_json(nlohmann::json& j,
const RiffDescriptor& p)
11010 j = nlohmann::json{
11012 TOJSON_IMPL(verified),
11013 TOJSON_IMPL(channels),
11014 TOJSON_IMPL(sampleCount),
11016 TOJSON_IMPL(certPem),
11017 TOJSON_IMPL(certDescriptor),
11018 TOJSON_IMPL(signature)
11022 static void from_json(
const nlohmann::json& j, RiffDescriptor& p)
11025 FROMJSON_IMPL(file, std::string, EMPTY_STRING);
11026 FROMJSON_IMPL(verified,
bool,
false);
11027 FROMJSON_IMPL(channels,
int, 0);
11028 FROMJSON_IMPL(sampleCount,
int, 0);
11029 FROMJSON_IMPL(meta, std::string, EMPTY_STRING);
11030 FROMJSON_IMPL(certPem, std::string, EMPTY_STRING);
11031 getOptional<CertificateDescriptor>(
"certDescriptor", p.certDescriptor, j);
11032 FROMJSON_IMPL(signature, std::string, EMPTY_STRING);
11037 JSON_SERIALIZED_CLASS(BridgeCreationDetail)
11046 IMPLEMENT_JSON_SERIALIZATION()
11064 csAlreadyExists = -3,
11067 csInvalidConfiguration = -4,
11070 csInvalidJson = -5,
11073 csInsufficientGroups = -6,
11076 csTooManyGroups = -7,
11079 csDuplicateGroup = -8,
11082 csLocalLoopDetected = -9,
11083 } CreationStatus_t;
11099 status = csUndefined;
11103 static void to_json(nlohmann::json& j,
const BridgeCreationDetail& p)
11105 j = nlohmann::json{
11107 TOJSON_IMPL(status)
11110 static void from_json(
const nlohmann::json& j, BridgeCreationDetail& p)
11113 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
11114 getOptional<BridgeCreationDetail::CreationStatus_t>(
"status", p.status, j, BridgeCreationDetail::CreationStatus_t::csUndefined);
11117 JSON_SERIALIZED_CLASS(GroupConnectionDetail)
11126 IMPLEMENT_JSON_SERIALIZATION()
11138 ctDirectDatagram = 1,
11142 } ConnectionType_t;
11167 connectionType = ctUndefined;
11169 asFailover =
false;
11174 static void to_json(nlohmann::json& j,
const GroupConnectionDetail& p)
11176 j = nlohmann::json{
11178 TOJSON_IMPL(connectionType),
11180 TOJSON_IMPL(asFailover),
11181 TOJSON_IMPL(reason)
11186 j[
"asFailover"] = p.asFailover;
11189 static void from_json(
const nlohmann::json& j, GroupConnectionDetail& p)
11192 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
11193 getOptional<GroupConnectionDetail::ConnectionType_t>(
"connectionType", p.connectionType, j, GroupConnectionDetail::ConnectionType_t::ctUndefined);
11194 getOptional<std::string>(
"peer", p.peer, j, EMPTY_STRING);
11195 getOptional<bool>(
"asFailover", p.asFailover, j,
false);
11196 getOptional<std::string>(
"reason", p.reason, j, EMPTY_STRING);
11200 JSON_SERIALIZED_CLASS(GroupTxDetail)
11209 IMPLEMENT_JSON_SERIALIZATION()
11227 txsNotAnAudioGroup = -1,
11233 txsNotConnected = -3,
11236 txsAlreadyTransmitting = -4,
11239 txsInvalidParams = -5,
11242 txsPriorityTooLow = -6,
11245 txsRxActiveOnNonFdx = -7,
11248 txsCannotSubscribeToInput = -8,
11254 txsTxEndedWithFailure = -10,
11257 txsBridgedButNotMultistream = -11,
11260 txsAutoEndedDueToNonMultistreamBridge = -12,
11263 txsReBeginWithoutPriorBegin = -13
11292 status = txsUndefined;
11294 remotePriority = 0;
11295 nonFdxMsHangRemaining = 0;
11300 static void to_json(nlohmann::json& j,
const GroupTxDetail& p)
11302 j = nlohmann::json{
11304 TOJSON_IMPL(status),
11305 TOJSON_IMPL(localPriority),
11310 if(p.status == GroupTxDetail::TxStatus_t::txsPriorityTooLow)
11312 j[
"remotePriority"] = p.remotePriority;
11314 else if(p.status == GroupTxDetail::TxStatus_t::txsRxActiveOnNonFdx)
11316 j[
"nonFdxMsHangRemaining"] = p.nonFdxMsHangRemaining;
11319 static void from_json(
const nlohmann::json& j, GroupTxDetail& p)
11322 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
11323 getOptional<GroupTxDetail::TxStatus_t>(
"status", p.status, j, GroupTxDetail::TxStatus_t::txsUndefined);
11324 getOptional<int>(
"localPriority", p.localPriority, j, 0);
11325 getOptional<int>(
"remotePriority", p.remotePriority, j, 0);
11326 getOptional<long>(
"nonFdxMsHangRemaining", p.nonFdxMsHangRemaining, j, 0);
11327 getOptional<uint32_t>(
"txId", p.txId, j, 0);
11331 JSON_SERIALIZED_CLASS(GroupCreationDetail)
11340 IMPLEMENT_JSON_SERIALIZATION()
11358 csConflictingRpListAndCluster = -2,
11361 csAlreadyExists = -3,
11364 csInvalidConfiguration = -4,
11367 csInvalidJson = -5,
11370 csCryptoFailure = -6,
11373 csAudioInputFailure = -7,
11376 csAudioOutputFailure = -8,
11379 csUnsupportedAudioEncoder = -9,
11385 csInvalidTransport = -11,
11388 csAudioInputDeviceNotFound = -12,
11391 csAudioOutputDeviceNotFound = -13
11392 } CreationStatus_t;
11408 status = csUndefined;
11412 static void to_json(nlohmann::json& j,
const GroupCreationDetail& p)
11414 j = nlohmann::json{
11416 TOJSON_IMPL(status)
11419 static void from_json(
const nlohmann::json& j, GroupCreationDetail& p)
11422 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
11423 getOptional<GroupCreationDetail::CreationStatus_t>(
"status", p.status, j, GroupCreationDetail::CreationStatus_t::csUndefined);
11428 JSON_SERIALIZED_CLASS(GroupReconfigurationDetail)
11437 IMPLEMENT_JSON_SERIALIZATION()
11455 rsInvalidConfiguration = -2,
11458 rsInvalidJson = -3,
11461 rsAudioInputFailure = -4,
11464 rsAudioOutputFailure = -5,
11467 rsDoesNotExist = -6,
11470 rsAudioInputInUse = -7,
11473 rsAudioDisabledForGroup = -8,
11476 rsGroupIsNotAudio = -9
11477 } ReconfigurationStatus_t;
11493 status = rsUndefined;
11497 static void to_json(nlohmann::json& j,
const GroupReconfigurationDetail& p)
11499 j = nlohmann::json{
11501 TOJSON_IMPL(status)
11504 static void from_json(
const nlohmann::json& j, GroupReconfigurationDetail& p)
11507 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
11508 getOptional<GroupReconfigurationDetail::ReconfigurationStatus_t>(
"status", p.status, j, GroupReconfigurationDetail::ReconfigurationStatus_t::rsUndefined);
11513 JSON_SERIALIZED_CLASS(GroupHealthReport)
11522 IMPLEMENT_JSON_SERIALIZATION()
11528 uint64_t lastErrorTs;
11529 uint64_t decryptionErrors;
11530 uint64_t encryptionErrors;
11531 uint64_t unsupportDecoderErrors;
11532 uint64_t decoderFailures;
11533 uint64_t decoderStartFailures;
11534 uint64_t inboundRtpPacketAllocationFailures;
11535 uint64_t inboundRtpPacketLoadFailures;
11536 uint64_t latePacketsDiscarded;
11537 uint64_t jitterBufferInsertionFailures;
11538 uint64_t presenceDeserializationFailures;
11539 uint64_t notRtpErrors;
11540 uint64_t generalErrors;
11541 uint64_t inboundRtpProcessorAllocationFailures;
11552 decryptionErrors = 0;
11553 encryptionErrors = 0;
11554 unsupportDecoderErrors = 0;
11555 decoderFailures = 0;
11556 decoderStartFailures = 0;
11557 inboundRtpPacketAllocationFailures = 0;
11558 inboundRtpPacketLoadFailures = 0;
11559 latePacketsDiscarded = 0;
11560 jitterBufferInsertionFailures = 0;
11561 presenceDeserializationFailures = 0;
11564 inboundRtpProcessorAllocationFailures = 0;
11570 j = nlohmann::json{
11572 TOJSON_IMPL(lastErrorTs),
11573 TOJSON_IMPL(decryptionErrors),
11574 TOJSON_IMPL(encryptionErrors),
11575 TOJSON_IMPL(unsupportDecoderErrors),
11576 TOJSON_IMPL(decoderFailures),
11577 TOJSON_IMPL(decoderStartFailures),
11578 TOJSON_IMPL(inboundRtpPacketAllocationFailures),
11579 TOJSON_IMPL(inboundRtpPacketLoadFailures),
11580 TOJSON_IMPL(latePacketsDiscarded),
11581 TOJSON_IMPL(jitterBufferInsertionFailures),
11582 TOJSON_IMPL(presenceDeserializationFailures),
11583 TOJSON_IMPL(notRtpErrors),
11584 TOJSON_IMPL(generalErrors),
11585 TOJSON_IMPL(inboundRtpProcessorAllocationFailures)
11588 static void from_json(
const nlohmann::json& j, GroupHealthReport& p)
11591 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
11592 getOptional<uint64_t>(
"lastErrorTs", p.lastErrorTs, j, 0);
11593 getOptional<uint64_t>(
"decryptionErrors", p.decryptionErrors, j, 0);
11594 getOptional<uint64_t>(
"encryptionErrors", p.encryptionErrors, j, 0);
11595 getOptional<uint64_t>(
"unsupportDecoderErrors", p.unsupportDecoderErrors, j, 0);
11596 getOptional<uint64_t>(
"decoderFailures", p.decoderFailures, j, 0);
11597 getOptional<uint64_t>(
"decoderStartFailures", p.decoderStartFailures, j, 0);
11598 getOptional<uint64_t>(
"inboundRtpPacketAllocationFailures", p.inboundRtpPacketAllocationFailures, j, 0);
11599 getOptional<uint64_t>(
"inboundRtpPacketLoadFailures", p.inboundRtpPacketLoadFailures, j, 0);
11600 getOptional<uint64_t>(
"latePacketsDiscarded", p.latePacketsDiscarded, j, 0);
11601 getOptional<uint64_t>(
"jitterBufferInsertionFailures", p.jitterBufferInsertionFailures, j, 0);
11602 getOptional<uint64_t>(
"presenceDeserializationFailures", p.presenceDeserializationFailures, j, 0);
11603 getOptional<uint64_t>(
"notRtpErrors", p.notRtpErrors, j, 0);
11604 getOptional<uint64_t>(
"generalErrors", p.generalErrors, j, 0);
11605 getOptional<uint64_t>(
"inboundRtpProcessorAllocationFailures", p.inboundRtpProcessorAllocationFailures, j, 0);
11609 JSON_SERIALIZED_CLASS(InboundProcessorStats)
11618 IMPLEMENT_JSON_SERIALIZATION()
11625 uint64_t minRtpSamplesInQueue;
11626 uint64_t maxRtpSamplesInQueue;
11627 uint64_t totalSamplesTrimmed;
11628 uint64_t underruns;
11630 uint64_t samplesInQueue;
11631 uint64_t totalPacketsReceived;
11632 uint64_t totalPacketsLost;
11633 uint64_t totalPacketsDiscarded;
11644 minRtpSamplesInQueue = 0;
11645 maxRtpSamplesInQueue = 0;
11646 totalSamplesTrimmed = 0;
11649 samplesInQueue = 0;
11650 totalPacketsReceived = 0;
11651 totalPacketsLost = 0;
11652 totalPacketsDiscarded = 0;
11658 j = nlohmann::json{
11660 TOJSON_IMPL(jitter),
11661 TOJSON_IMPL(minRtpSamplesInQueue),
11662 TOJSON_IMPL(maxRtpSamplesInQueue),
11663 TOJSON_IMPL(totalSamplesTrimmed),
11664 TOJSON_IMPL(underruns),
11665 TOJSON_IMPL(overruns),
11666 TOJSON_IMPL(samplesInQueue),
11667 TOJSON_IMPL(totalPacketsReceived),
11668 TOJSON_IMPL(totalPacketsLost),
11669 TOJSON_IMPL(totalPacketsDiscarded)
11672 static void from_json(
const nlohmann::json& j, InboundProcessorStats& p)
11675 getOptional<uint32_t>(
"ssrc", p.ssrc, j, 0);
11676 getOptional<double>(
"jitter", p.jitter, j, 0.0);
11677 getOptional<uint64_t>(
"minRtpSamplesInQueue", p.minRtpSamplesInQueue, j, 0);
11678 getOptional<uint64_t>(
"maxRtpSamplesInQueue", p.maxRtpSamplesInQueue, j, 0);
11679 getOptional<uint64_t>(
"totalSamplesTrimmed", p.totalSamplesTrimmed, j, 0);
11680 getOptional<uint64_t>(
"underruns", p.underruns, j, 0);
11681 getOptional<uint64_t>(
"overruns", p.overruns, j, 0);
11682 getOptional<uint64_t>(
"samplesInQueue", p.samplesInQueue, j, 0);
11683 getOptional<uint64_t>(
"totalPacketsReceived", p.totalPacketsReceived, j, 0);
11684 getOptional<uint64_t>(
"totalPacketsLost", p.totalPacketsLost, j, 0);
11685 getOptional<uint64_t>(
"totalPacketsDiscarded", p.totalPacketsDiscarded, j, 0);
11689 JSON_SERIALIZED_CLASS(TrafficCounter)
11698 IMPLEMENT_JSON_SERIALIZATION()
11722 j = nlohmann::json{
11723 TOJSON_IMPL(packets),
11724 TOJSON_IMPL(bytes),
11725 TOJSON_IMPL(errors)
11728 static void from_json(
const nlohmann::json& j, TrafficCounter& p)
11731 getOptional<uint64_t>(
"packets", p.packets, j, 0);
11732 getOptional<uint64_t>(
"bytes", p.bytes, j, 0);
11733 getOptional<uint64_t>(
"errors", p.errors, j, 0);
11737 JSON_SERIALIZED_CLASS(GroupStats)
11746 IMPLEMENT_JSON_SERIALIZATION()
11747 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(
GroupStats)
11770 static void to_json(nlohmann::json& j,
const GroupStats& p)
11772 j = nlohmann::json{
11775 TOJSON_IMPL(rxTraffic),
11776 TOJSON_IMPL(txTraffic)
11779 static void from_json(
const nlohmann::json& j, GroupStats& p)
11782 getOptional<std::string>(
"id", p.id, j, EMPTY_STRING);
11784 getOptional<TrafficCounter>(
"rxTraffic", p.rxTraffic, j);
11785 getOptional<TrafficCounter>(
"txTraffic", p.txTraffic, j);
11789 JSON_SERIALIZED_CLASS(RallypointConnectionDetail)
11798 IMPLEMENT_JSON_SERIALIZATION()
11825 internalId.clear();
11828 msToNextConnectionAttempt = 0;
11829 serverProcessingMs = -1.0f;
11833 static void to_json(nlohmann::json& j,
const RallypointConnectionDetail& p)
11835 j = nlohmann::json{
11836 TOJSON_IMPL(internalId),
11841 if(p.msToNextConnectionAttempt > 0)
11843 j[
"msToNextConnectionAttempt"] = p.msToNextConnectionAttempt;
11846 if(p.serverProcessingMs >= 0.0)
11848 j[
"serverProcessingMs"] = p.serverProcessingMs;
11851 static void from_json(
const nlohmann::json& j, RallypointConnectionDetail& p)
11854 getOptional<std::string>(
"internalId", p.internalId, j, EMPTY_STRING);
11855 getOptional<std::string>(
"host", p.host, j, EMPTY_STRING);
11856 getOptional<int>(
"port", p.port, j, 0);
11857 getOptional<uint64_t>(
"msToNextConnectionAttempt", p.msToNextConnectionAttempt, j, 0);
11858 getOptional<float>(
"serverProcessingMs", p.serverProcessingMs, j, -1.0);
11862 JSON_SERIALIZED_CLASS(TranslationSession)
11874 IMPLEMENT_JSON_SERIALIZATION()
11904 static void to_json(nlohmann::json& j,
const TranslationSession& p)
11906 j = nlohmann::json{
11909 TOJSON_IMPL(groups),
11910 TOJSON_IMPL(enabled)
11913 static void from_json(
const nlohmann::json& j, TranslationSession& p)
11916 FROMJSON_IMPL(
id, std::string, EMPTY_STRING);
11917 FROMJSON_IMPL(name, std::string, EMPTY_STRING);
11918 getOptional<std::vector<std::string>>(
"groups", p.groups, j);
11919 FROMJSON_IMPL(enabled,
bool,
true);
11923 JSON_SERIALIZED_CLASS(TranslationConfiguration)
11935 IMPLEMENT_JSON_SERIALIZATION()
11957 static void to_json(nlohmann::json& j,
const TranslationConfiguration& p)
11959 j = nlohmann::json{
11960 TOJSON_IMPL(sessions),
11961 TOJSON_IMPL(groups)
11964 static void from_json(
const nlohmann::json& j, TranslationConfiguration& p)
11967 getOptional<std::vector<TranslationSession>>(
"sessions", p.sessions, j);
11968 getOptional<std::vector<Group>>(
"groups", p.groups, j);
11972 JSON_SERIALIZED_CLASS(LingoServerStatusReportConfiguration)
11984 IMPLEMENT_JSON_SERIALIZATION()
12019 includeGroupDetail =
false;
12020 includeSessionDetail =
false;
12021 includeSessionGroupDetail =
false;
12026 static void to_json(nlohmann::json& j,
const LingoServerStatusReportConfiguration& p)
12028 j = nlohmann::json{
12029 TOJSON_IMPL(fileName),
12030 TOJSON_IMPL(intervalSecs),
12031 TOJSON_IMPL(enabled),
12032 TOJSON_IMPL(includeGroupDetail),
12033 TOJSON_IMPL(includeSessionDetail),
12034 TOJSON_IMPL(includeSessionGroupDetail),
12035 TOJSON_IMPL(runCmd)
12038 static void from_json(
const nlohmann::json& j, LingoServerStatusReportConfiguration& p)
12041 getOptional<std::string>(
"fileName", p.fileName, j);
12042 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
12043 getOptional<bool>(
"enabled", p.enabled, j,
false);
12044 getOptional<std::string>(
"runCmd", p.runCmd, j);
12045 getOptional<bool>(
"includeGroupDetail", p.includeGroupDetail, j,
false);
12046 getOptional<bool>(
"includeSessionDetail", p.includeSessionDetail, j,
false);
12047 getOptional<bool>(
"includeSessionGroupDetail", p.includeSessionGroupDetail, j,
false);
12051 JSON_SERIALIZED_CLASS(LingoServerInternals)
12065 IMPLEMENT_JSON_SERIALIZATION()
12087 housekeeperIntervalMs = 1000;
12091 static void to_json(nlohmann::json& j,
const LingoServerInternals& p)
12093 j = nlohmann::json{
12094 TOJSON_IMPL(watchdog),
12095 TOJSON_IMPL(housekeeperIntervalMs),
12096 TOJSON_IMPL(tuning)
12099 static void from_json(
const nlohmann::json& j, LingoServerInternals& p)
12102 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
12103 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
12104 getOptional<TuningSettings>(
"tuning", p.tuning, j);
12108 JSON_SERIALIZED_CLASS(LingoServerConfiguration)
12119 IMPLEMENT_JSON_SERIALIZATION()
12176 serviceConfigurationFileCheckSecs = 60;
12177 lingoConfigurationFileName.clear();
12178 lingoConfigurationFileCommand.clear();
12179 lingoConfigurationFileCheckSecs = 60;
12180 statusReport.clear();
12181 externalHealthCheckResponder.clear();
12183 certStoreFileName.clear();
12184 certStorePasswordHex.clear();
12185 enginePolicy.clear();
12186 configurationCheckSignalName =
"rts.22f4ec3.${id}";
12187 fipsCrypto.clear();
12193 static void to_json(nlohmann::json& j,
const LingoServerConfiguration& p)
12195 j = nlohmann::json{
12197 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
12198 TOJSON_IMPL(lingoConfigurationFileName),
12199 TOJSON_IMPL(lingoConfigurationFileCommand),
12200 TOJSON_IMPL(lingoConfigurationFileCheckSecs),
12201 TOJSON_IMPL(statusReport),
12202 TOJSON_IMPL(externalHealthCheckResponder),
12203 TOJSON_IMPL(internals),
12204 TOJSON_IMPL(certStoreFileName),
12205 TOJSON_IMPL(certStorePasswordHex),
12206 TOJSON_IMPL(enginePolicy),
12207 TOJSON_IMPL(configurationCheckSignalName),
12208 TOJSON_IMPL(fipsCrypto),
12209 TOJSON_IMPL(proxy),
12213 static void from_json(
const nlohmann::json& j, LingoServerConfiguration& p)
12216 getOptional<std::string>(
"id", p.id, j);
12217 getOptional<int>(
"serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
12218 getOptional<std::string>(
"lingoConfigurationFileName", p.lingoConfigurationFileName, j);
12219 getOptional<std::string>(
"lingoConfigurationFileCommand", p.lingoConfigurationFileCommand, j);
12220 getOptional<int>(
"lingoConfigurationFileCheckSecs", p.lingoConfigurationFileCheckSecs, j, 60);
12221 getOptional<LingoServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
12222 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
12223 getOptional<LingoServerInternals>(
"internals", p.internals, j);
12224 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
12225 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
12226 j.at(
"enginePolicy").get_to(p.enginePolicy);
12227 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.22f4ec3.${id}");
12228 getOptional<FipsCryptoSettings>(
"fipsCrypo", p.fipsCrypto, j);
12229 getOptional<NetworkAddress>(
"proxy", p.proxy, j);
12230 getOptional<NsmConfiguration>(
"nsm", p.nsm, j);
12235 JSON_SERIALIZED_CLASS(VoiceToVoiceSession)
12247 IMPLEMENT_JSON_SERIALIZATION()
12277 static void to_json(nlohmann::json& j,
const VoiceToVoiceSession& p)
12279 j = nlohmann::json{
12282 TOJSON_IMPL(groups),
12283 TOJSON_IMPL(enabled)
12286 static void from_json(
const nlohmann::json& j, VoiceToVoiceSession& p)
12289 FROMJSON_IMPL(
id, std::string, EMPTY_STRING);
12290 FROMJSON_IMPL(name, std::string, EMPTY_STRING);
12291 getOptional<std::vector<std::string>>(
"groups", p.groups, j);
12292 FROMJSON_IMPL(enabled,
bool,
true);
12296 JSON_SERIALIZED_CLASS(LingoConfiguration)
12308 IMPLEMENT_JSON_SERIALIZATION()
12325 voiceToVoiceSessions.clear();
12330 static void to_json(nlohmann::json& j,
const LingoConfiguration& p)
12332 j = nlohmann::json{
12333 TOJSON_IMPL(voiceToVoiceSessions),
12334 TOJSON_IMPL(groups)
12337 static void from_json(
const nlohmann::json& j, LingoConfiguration& p)
12340 getOptional<std::vector<VoiceToVoiceSession>>(
"voiceToVoiceSessions", p.voiceToVoiceSessions, j);
12341 getOptional<std::vector<Group>>(
"groups", p.groups, j);
12345 JSON_SERIALIZED_CLASS(BridgingConfiguration)
12357 IMPLEMENT_JSON_SERIALIZATION()
12379 static void to_json(nlohmann::json& j,
const BridgingConfiguration& p)
12381 j = nlohmann::json{
12382 TOJSON_IMPL(bridges),
12383 TOJSON_IMPL(groups)
12386 static void from_json(
const nlohmann::json& j, BridgingConfiguration& p)
12389 getOptional<std::vector<Bridge>>(
"bridges", p.bridges, j);
12390 getOptional<std::vector<Group>>(
"groups", p.groups, j);
12394 JSON_SERIALIZED_CLASS(BridgingServerStatusReportConfiguration)
12406 IMPLEMENT_JSON_SERIALIZATION()
12441 includeGroupDetail =
false;
12442 includeBridgeDetail =
false;
12443 includeBridgeGroupDetail =
false;
12448 static void to_json(nlohmann::json& j,
const BridgingServerStatusReportConfiguration& p)
12450 j = nlohmann::json{
12451 TOJSON_IMPL(fileName),
12452 TOJSON_IMPL(intervalSecs),
12453 TOJSON_IMPL(enabled),
12454 TOJSON_IMPL(includeGroupDetail),
12455 TOJSON_IMPL(includeBridgeDetail),
12456 TOJSON_IMPL(includeBridgeGroupDetail),
12457 TOJSON_IMPL(runCmd)
12460 static void from_json(
const nlohmann::json& j, BridgingServerStatusReportConfiguration& p)
12463 getOptional<std::string>(
"fileName", p.fileName, j);
12464 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
12465 getOptional<bool>(
"enabled", p.enabled, j,
false);
12466 getOptional<std::string>(
"runCmd", p.runCmd, j);
12467 getOptional<bool>(
"includeGroupDetail", p.includeGroupDetail, j,
false);
12468 getOptional<bool>(
"includeBridgeDetail", p.includeBridgeDetail, j,
false);
12469 getOptional<bool>(
"includeBridgeGroupDetail", p.includeBridgeGroupDetail, j,
false);
12473 JSON_SERIALIZED_CLASS(BridgingServerInternals)
12487 IMPLEMENT_JSON_SERIALIZATION()
12509 housekeeperIntervalMs = 1000;
12513 static void to_json(nlohmann::json& j,
const BridgingServerInternals& p)
12515 j = nlohmann::json{
12516 TOJSON_IMPL(watchdog),
12517 TOJSON_IMPL(housekeeperIntervalMs),
12518 TOJSON_IMPL(tuning)
12521 static void from_json(
const nlohmann::json& j, BridgingServerInternals& p)
12524 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
12525 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
12526 getOptional<TuningSettings>(
"tuning", p.tuning, j);
12530 JSON_SERIALIZED_CLASS(BridgingServerConfiguration)
12541 IMPLEMENT_JSON_SERIALIZATION()
12565 omADictatedByGroup = 3,
12622 serviceConfigurationFileCheckSecs = 60;
12623 bridgingConfigurationFileName.clear();
12624 bridgingConfigurationFileCommand.clear();
12625 bridgingConfigurationFileCheckSecs = 60;
12626 statusReport.clear();
12627 externalHealthCheckResponder.clear();
12629 certStoreFileName.clear();
12630 certStorePasswordHex.clear();
12631 enginePolicy.clear();
12632 configurationCheckSignalName =
"rts.6cc0651.${id}";
12633 fipsCrypto.clear();
12638 static void to_json(nlohmann::json& j,
const BridgingServerConfiguration& p)
12640 j = nlohmann::json{
12643 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
12644 TOJSON_IMPL(bridgingConfigurationFileName),
12645 TOJSON_IMPL(bridgingConfigurationFileCommand),
12646 TOJSON_IMPL(bridgingConfigurationFileCheckSecs),
12647 TOJSON_IMPL(statusReport),
12648 TOJSON_IMPL(externalHealthCheckResponder),
12649 TOJSON_IMPL(internals),
12650 TOJSON_IMPL(certStoreFileName),
12651 TOJSON_IMPL(certStorePasswordHex),
12652 TOJSON_IMPL(enginePolicy),
12653 TOJSON_IMPL(configurationCheckSignalName),
12654 TOJSON_IMPL(fipsCrypto),
12658 static void from_json(
const nlohmann::json& j, BridgingServerConfiguration& p)
12661 getOptional<std::string>(
"id", p.id, j);
12662 getOptional<BridgingServerConfiguration::OpMode_t>(
"mode", p.mode, j, BridgingServerConfiguration::OpMode_t::omRaw);
12663 getOptional<int>(
"serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
12664 getOptional<std::string>(
"bridgingConfigurationFileName", p.bridgingConfigurationFileName, j);
12665 getOptional<std::string>(
"bridgingConfigurationFileCommand", p.bridgingConfigurationFileCommand, j);
12666 getOptional<int>(
"bridgingConfigurationFileCheckSecs", p.bridgingConfigurationFileCheckSecs, j, 60);
12667 getOptional<BridgingServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
12668 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
12669 getOptional<BridgingServerInternals>(
"internals", p.internals, j);
12670 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
12671 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
12672 j.at(
"enginePolicy").get_to(p.enginePolicy);
12673 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.6cc0651.${id}");
12674 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
12675 getOptional<NsmConfiguration>(
"nsm", p.nsm, j);
12680 JSON_SERIALIZED_CLASS(EarGroupsConfiguration)
12692 IMPLEMENT_JSON_SERIALIZATION()
12710 static void to_json(nlohmann::json& j,
const EarGroupsConfiguration& p)
12712 j = nlohmann::json{
12713 TOJSON_IMPL(groups)
12716 static void from_json(
const nlohmann::json& j, EarGroupsConfiguration& p)
12719 getOptional<std::vector<Group>>(
"groups", p.groups, j);
12723 JSON_SERIALIZED_CLASS(EarServerStatusReportConfiguration)
12735 IMPLEMENT_JSON_SERIALIZATION()
12764 includeGroupDetail =
false;
12769 static void to_json(nlohmann::json& j,
const EarServerStatusReportConfiguration& p)
12771 j = nlohmann::json{
12772 TOJSON_IMPL(fileName),
12773 TOJSON_IMPL(intervalSecs),
12774 TOJSON_IMPL(enabled),
12775 TOJSON_IMPL(includeGroupDetail),
12776 TOJSON_IMPL(runCmd)
12779 static void from_json(
const nlohmann::json& j, EarServerStatusReportConfiguration& p)
12782 getOptional<std::string>(
"fileName", p.fileName, j);
12783 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
12784 getOptional<bool>(
"enabled", p.enabled, j,
false);
12785 getOptional<std::string>(
"runCmd", p.runCmd, j);
12786 getOptional<bool>(
"includeGroupDetail", p.includeGroupDetail, j,
false);
12790 JSON_SERIALIZED_CLASS(EarServerInternals)
12804 IMPLEMENT_JSON_SERIALIZATION()
12826 housekeeperIntervalMs = 1000;
12830 static void to_json(nlohmann::json& j,
const EarServerInternals& p)
12832 j = nlohmann::json{
12833 TOJSON_IMPL(watchdog),
12834 TOJSON_IMPL(housekeeperIntervalMs),
12835 TOJSON_IMPL(tuning)
12838 static void from_json(
const nlohmann::json& j, EarServerInternals& p)
12841 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
12842 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
12843 getOptional<TuningSettings>(
"tuning", p.tuning, j);
12847 JSON_SERIALIZED_CLASS(EarServerConfiguration)
12858 IMPLEMENT_JSON_SERIALIZATION()
12913 serviceConfigurationFileCheckSecs = 60;
12914 groupsConfigurationFileName.clear();
12915 groupsConfigurationFileCommand.clear();
12916 groupsConfigurationFileCheckSecs = 60;
12917 statusReport.clear();
12918 externalHealthCheckResponder.clear();
12920 certStoreFileName.clear();
12921 certStorePasswordHex.clear();
12922 enginePolicy.clear();
12923 configurationCheckSignalName =
"rts.9a164fa.${id}";
12924 fipsCrypto.clear();
12929 static void to_json(nlohmann::json& j,
const EarServerConfiguration& p)
12931 j = nlohmann::json{
12933 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
12934 TOJSON_IMPL(groupsConfigurationFileName),
12935 TOJSON_IMPL(groupsConfigurationFileCommand),
12936 TOJSON_IMPL(groupsConfigurationFileCheckSecs),
12937 TOJSON_IMPL(statusReport),
12938 TOJSON_IMPL(externalHealthCheckResponder),
12939 TOJSON_IMPL(internals),
12940 TOJSON_IMPL(certStoreFileName),
12941 TOJSON_IMPL(certStorePasswordHex),
12942 TOJSON_IMPL(enginePolicy),
12943 TOJSON_IMPL(configurationCheckSignalName),
12944 TOJSON_IMPL(fipsCrypto),
12948 static void from_json(
const nlohmann::json& j, EarServerConfiguration& p)
12951 getOptional<std::string>(
"id", p.id, j);
12952 getOptional<int>(
"serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
12953 getOptional<std::string>(
"groupsConfigurationFileName", p.groupsConfigurationFileName, j);
12954 getOptional<std::string>(
"groupsConfigurationFileCommand", p.groupsConfigurationFileCommand, j);
12955 getOptional<int>(
"groupsConfigurationFileCheckSecs", p.groupsConfigurationFileCheckSecs, j, 60);
12956 getOptional<EarServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
12957 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
12958 getOptional<EarServerInternals>(
"internals", p.internals, j);
12959 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
12960 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
12961 j.at(
"enginePolicy").get_to(p.enginePolicy);
12962 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.9a164fa.${id}");
12963 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
12964 getOptional<NsmConfiguration>(
"nsm", p.nsm, j);
12968 JSON_SERIALIZED_CLASS(EngageSemGroupsConfiguration)
12980 IMPLEMENT_JSON_SERIALIZATION()
12998 static void to_json(nlohmann::json& j,
const EngageSemGroupsConfiguration& p)
13000 j = nlohmann::json{
13001 TOJSON_IMPL(groups)
13004 static void from_json(
const nlohmann::json& j, EngageSemGroupsConfiguration& p)
13007 getOptional<std::vector<Group>>(
"groups", p.groups, j);
13011 JSON_SERIALIZED_CLASS(EngageSemServerStatusReportConfiguration)
13023 IMPLEMENT_JSON_SERIALIZATION()
13052 includeGroupDetail =
false;
13057 static void to_json(nlohmann::json& j,
const EngageSemServerStatusReportConfiguration& p)
13059 j = nlohmann::json{
13060 TOJSON_IMPL(fileName),
13061 TOJSON_IMPL(intervalSecs),
13062 TOJSON_IMPL(enabled),
13063 TOJSON_IMPL(includeGroupDetail),
13064 TOJSON_IMPL(runCmd)
13067 static void from_json(
const nlohmann::json& j, EngageSemServerStatusReportConfiguration& p)
13070 getOptional<std::string>(
"fileName", p.fileName, j);
13071 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
13072 getOptional<bool>(
"enabled", p.enabled, j,
false);
13073 getOptional<std::string>(
"runCmd", p.runCmd, j);
13074 getOptional<bool>(
"includeGroupDetail", p.includeGroupDetail, j,
false);
13078 JSON_SERIALIZED_CLASS(EngageSemServerInternals)
13092 IMPLEMENT_JSON_SERIALIZATION()
13114 housekeeperIntervalMs = 1000;
13118 static void to_json(nlohmann::json& j,
const EngageSemServerInternals& p)
13120 j = nlohmann::json{
13121 TOJSON_IMPL(watchdog),
13122 TOJSON_IMPL(housekeeperIntervalMs),
13123 TOJSON_IMPL(tuning)
13126 static void from_json(
const nlohmann::json& j, EngageSemServerInternals& p)
13129 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
13130 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
13131 getOptional<TuningSettings>(
"tuning", p.tuning, j);
13135 JSON_SERIALIZED_CLASS(EngageSemServerConfiguration)
13146 IMPLEMENT_JSON_SERIALIZATION()
13207 serviceConfigurationFileCheckSecs = 60;
13208 groupsConfigurationFileName.clear();
13209 groupsConfigurationFileCommand.clear();
13210 groupsConfigurationFileCheckSecs = 60;
13211 statusReport.clear();
13212 externalHealthCheckResponder.clear();
13214 certStoreFileName.clear();
13215 certStorePasswordHex.clear();
13216 enginePolicy.clear();
13217 configurationCheckSignalName =
"rts.9a164fa.${id}";
13218 fipsCrypto.clear();
13223 maxQueuingMs = 15000;
13229 static void to_json(nlohmann::json& j,
const EngageSemServerConfiguration& p)
13231 j = nlohmann::json{
13233 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
13234 TOJSON_IMPL(groupsConfigurationFileName),
13235 TOJSON_IMPL(groupsConfigurationFileCommand),
13236 TOJSON_IMPL(groupsConfigurationFileCheckSecs),
13237 TOJSON_IMPL(statusReport),
13238 TOJSON_IMPL(externalHealthCheckResponder),
13239 TOJSON_IMPL(internals),
13240 TOJSON_IMPL(certStoreFileName),
13241 TOJSON_IMPL(certStorePasswordHex),
13242 TOJSON_IMPL(enginePolicy),
13243 TOJSON_IMPL(configurationCheckSignalName),
13244 TOJSON_IMPL(fipsCrypto),
13246 TOJSON_IMPL(maxQueueLen),
13247 TOJSON_IMPL(minQueuingMs),
13248 TOJSON_IMPL(maxQueuingMs),
13249 TOJSON_IMPL(minPriority),
13250 TOJSON_IMPL(maxPriority)
13253 static void from_json(
const nlohmann::json& j, EngageSemServerConfiguration& p)
13256 getOptional<std::string>(
"id", p.id, j);
13257 getOptional<int>(
"serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
13258 getOptional<std::string>(
"groupsConfigurationFileName", p.groupsConfigurationFileName, j);
13259 getOptional<std::string>(
"groupsConfigurationFileCommand", p.groupsConfigurationFileCommand, j);
13260 getOptional<int>(
"groupsConfigurationFileCheckSecs", p.groupsConfigurationFileCheckSecs, j, 60);
13261 getOptional<EngageSemServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
13262 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
13263 getOptional<EngageSemServerInternals>(
"internals", p.internals, j);
13264 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
13265 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
13266 j.at(
"enginePolicy").get_to(p.enginePolicy);
13267 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.9a164fa.${id}");
13268 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
13269 getOptional<NsmConfiguration>(
"nsm", p.nsm, j);
13270 getOptional<int>(
"maxQueueLen", p.maxQueueLen, j, 64);
13271 getOptional<int>(
"minQueuingMs", p.minQueuingMs, j, 0);
13272 getOptional<int>(
"maxQueuingMs", p.maxQueuingMs, j, 15000);
13273 getOptional<int>(
"minPriority", p.minPriority, j, 0);
13274 getOptional<int>(
"maxPriority", p.maxPriority, j, 255);
13278 JSON_SERIALIZED_CLASS(EngateGroup)
13290 IMPLEMENT_JSON_SERIALIZATION()
13295 uint32_t inputHangMs;
13296 uint32_t inputActivationPowerThreshold;
13297 uint32_t inputDeactivationPowerThreshold;
13309 inputActivationPowerThreshold = 700;
13310 inputDeactivationPowerThreshold = 125;
13314 static void to_json(nlohmann::json& j,
const EngateGroup& p)
13317 to_json(g,
static_cast<const Group&
>(p));
13319 j = nlohmann::json{
13320 TOJSON_IMPL(useVad),
13321 TOJSON_IMPL(inputHangMs),
13322 TOJSON_IMPL(inputActivationPowerThreshold),
13323 TOJSON_IMPL(inputDeactivationPowerThreshold)
13326 static void from_json(
const nlohmann::json& j, EngateGroup& p)
13329 from_json(j,
static_cast<Group&
>(p));
13330 getOptional<uint32_t>(
"inputHangMs", p.inputHangMs, j, 750);
13331 getOptional<uint32_t>(
"inputActivationPowerThreshold", p.inputActivationPowerThreshold, j, 700);
13332 getOptional<uint32_t>(
"inputDeactivationPowerThreshold", p.inputDeactivationPowerThreshold, j, 125);
13336 JSON_SERIALIZED_CLASS(EngateGroupsConfiguration)
13348 IMPLEMENT_JSON_SERIALIZATION()
13366 static void to_json(nlohmann::json& j,
const EngateGroupsConfiguration& p)
13368 j = nlohmann::json{
13369 TOJSON_IMPL(groups)
13372 static void from_json(
const nlohmann::json& j, EngateGroupsConfiguration& p)
13375 getOptional<std::vector<EngateGroup>>(
"groups", p.groups, j);
13379 JSON_SERIALIZED_CLASS(EngateServerStatusReportConfiguration)
13391 IMPLEMENT_JSON_SERIALIZATION()
13420 includeGroupDetail =
false;
13425 static void to_json(nlohmann::json& j,
const EngateServerStatusReportConfiguration& p)
13427 j = nlohmann::json{
13428 TOJSON_IMPL(fileName),
13429 TOJSON_IMPL(intervalSecs),
13430 TOJSON_IMPL(enabled),
13431 TOJSON_IMPL(includeGroupDetail),
13432 TOJSON_IMPL(runCmd)
13435 static void from_json(
const nlohmann::json& j, EngateServerStatusReportConfiguration& p)
13438 getOptional<std::string>(
"fileName", p.fileName, j);
13439 getOptional<int>(
"intervalSecs", p.intervalSecs, j, 60);
13440 getOptional<bool>(
"enabled", p.enabled, j,
false);
13441 getOptional<std::string>(
"runCmd", p.runCmd, j);
13442 getOptional<bool>(
"includeGroupDetail", p.includeGroupDetail, j,
false);
13446 JSON_SERIALIZED_CLASS(EngateServerInternals)
13460 IMPLEMENT_JSON_SERIALIZATION()
13482 housekeeperIntervalMs = 1000;
13486 static void to_json(nlohmann::json& j,
const EngateServerInternals& p)
13488 j = nlohmann::json{
13489 TOJSON_IMPL(watchdog),
13490 TOJSON_IMPL(housekeeperIntervalMs),
13491 TOJSON_IMPL(tuning)
13494 static void from_json(
const nlohmann::json& j, EngateServerInternals& p)
13497 getOptional<WatchdogSettings>(
"watchdog", p.watchdog, j);
13498 getOptional<int>(
"housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
13499 getOptional<TuningSettings>(
"tuning", p.tuning, j);
13503 JSON_SERIALIZED_CLASS(EngateServerConfiguration)
13514 IMPLEMENT_JSON_SERIALIZATION()
13569 serviceConfigurationFileCheckSecs = 60;
13570 groupsConfigurationFileName.clear();
13571 groupsConfigurationFileCommand.clear();
13572 groupsConfigurationFileCheckSecs = 60;
13573 statusReport.clear();
13574 externalHealthCheckResponder.clear();
13576 certStoreFileName.clear();
13577 certStorePasswordHex.clear();
13578 enginePolicy.clear();
13579 configurationCheckSignalName =
"rts.9a164fa.${id}";
13580 fipsCrypto.clear();
13585 static void to_json(nlohmann::json& j,
const EngateServerConfiguration& p)
13587 j = nlohmann::json{
13589 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
13590 TOJSON_IMPL(groupsConfigurationFileName),
13591 TOJSON_IMPL(groupsConfigurationFileCommand),
13592 TOJSON_IMPL(groupsConfigurationFileCheckSecs),
13593 TOJSON_IMPL(statusReport),
13594 TOJSON_IMPL(externalHealthCheckResponder),
13595 TOJSON_IMPL(internals),
13596 TOJSON_IMPL(certStoreFileName),
13597 TOJSON_IMPL(certStorePasswordHex),
13598 TOJSON_IMPL(enginePolicy),
13599 TOJSON_IMPL(configurationCheckSignalName),
13600 TOJSON_IMPL(fipsCrypto),
13604 static void from_json(
const nlohmann::json& j, EngateServerConfiguration& p)
13607 getOptional<std::string>(
"id", p.id, j);
13608 getOptional<int>(
"serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
13609 getOptional<std::string>(
"groupsConfigurationFileName", p.groupsConfigurationFileName, j);
13610 getOptional<std::string>(
"groupsConfigurationFileCommand", p.groupsConfigurationFileCommand, j);
13611 getOptional<int>(
"groupsConfigurationFileCheckSecs", p.groupsConfigurationFileCheckSecs, j, 60);
13612 getOptional<EngateServerStatusReportConfiguration>(
"statusReport", p.statusReport, j);
13613 getOptional<ExternalHealthCheckResponder>(
"externalHealthCheckResponder", p.externalHealthCheckResponder, j);
13614 getOptional<EngateServerInternals>(
"internals", p.internals, j);
13615 getOptional<std::string>(
"certStoreFileName", p.certStoreFileName, j);
13616 getOptional<std::string>(
"certStorePasswordHex", p.certStorePasswordHex, j);
13617 j.at(
"enginePolicy").get_to(p.enginePolicy);
13618 getOptional<std::string>(
"configurationCheckSignalName", p.configurationCheckSignalName, j,
"rts.9a164fa.${id}");
13619 getOptional<FipsCryptoSettings>(
"fipsCrypto", p.fipsCrypto, j);
13620 getOptional<NsmConfiguration>(
"nsm", p.nsm, j);
13624 static inline void dumpExampleConfigurations(
const char *path)
13626 WatchdogSettings::document();
13627 FileRecordingRequest::document();
13628 Feature::document();
13629 Featureset::document();
13631 RtpPayloadTypeTranslation::document();
13632 NetworkInterfaceDevice::document();
13633 ListOfNetworkInterfaceDevice::document();
13634 RtpHeader::document();
13635 BlobInfo::document();
13636 TxAudioUri::document();
13637 AdvancedTxParams::document();
13638 Identity::document();
13639 Location::document();
13641 Connectivity::document();
13642 PresenceDescriptorGroupItem::document();
13643 PresenceDescriptor::document();
13644 NetworkTxOptions::document();
13645 TcpNetworkTxOptions::document();
13646 NetworkAddress::document();
13647 NetworkAddressRxTx::document();
13648 NetworkAddressRestrictionList::document();
13649 StringRestrictionList::document();
13650 Rallypoint::document();
13651 RallypointCluster::document();
13652 NetworkDeviceDescriptor::document();
13653 TxAudio::document();
13654 AudioDeviceDescriptor::document();
13655 ListOfAudioDeviceDescriptor::document();
13657 TalkerInformation::document();
13658 GroupTalkers::document();
13659 Presence::document();
13660 Advertising::document();
13661 GroupPriorityTranslation::document();
13662 GroupTimeline::document();
13663 GroupAppTransport::document();
13664 RtpProfile::document();
13666 Mission::document();
13667 LicenseDescriptor::document();
13668 EngineNetworkingRpUdpStreaming::document();
13669 EnginePolicyNetworking::document();
13672 Bridge::document();
13673 AndroidAudio::document();
13674 EnginePolicyAudio::document();
13675 SecurityCertificate::document();
13676 EnginePolicySecurity::document();
13677 EnginePolicyLogging::document();
13678 EnginePolicyDatabase::document();
13679 NamedAudioDevice::document();
13680 EnginePolicyNamedAudioDevices::document();
13681 Licensing::document();
13682 DiscoveryMagellan::document();
13683 DiscoverySsdp::document();
13684 DiscoverySap::document();
13685 DiscoveryCistech::document();
13686 DiscoveryTrellisware::document();
13687 DiscoveryConfiguration::document();
13688 EnginePolicyInternals::document();
13689 EnginePolicyTimelines::document();
13690 RtpMapEntry::document();
13691 ExternalModule::document();
13692 ExternalCodecDescriptor::document();
13693 EnginePolicy::document();
13694 TalkgroupAsset::document();
13695 EngageDiscoveredGroup::document();
13696 RallypointPeer::document();
13697 RallypointServerLimits::document();
13698 RallypointServerStatusReportConfiguration::document();
13699 RallypointServerLinkGraph::document();
13700 ExternalHealthCheckResponder::document();
13702 PeeringConfiguration::document();
13703 IgmpSnooping::document();
13704 RallypointReflector::document();
13705 RallypointUdpStreaming::document();
13706 RallypointServer::document();
13707 PlatformDiscoveredService::document();
13708 TimelineQueryParameters::document();
13709 CertStoreCertificate::document();
13710 CertStore::document();
13711 CertStoreCertificateElement::document();
13712 CertStoreDescriptor::document();
13713 CertificateDescriptor::document();
13714 BridgeCreationDetail::document();
13715 GroupConnectionDetail::document();
13716 GroupTxDetail::document();
13717 GroupCreationDetail::document();
13718 GroupReconfigurationDetail::document();
13719 GroupHealthReport::document();
13720 InboundProcessorStats::document();
13721 TrafficCounter::document();
13722 GroupStats::document();
13723 RallypointConnectionDetail::document();
13724 BridgingConfiguration::document();
13725 BridgingServerStatusReportConfiguration::document();
13726 BridgingServerInternals::document();
13727 BridgingServerConfiguration::document();
13728 EarGroupsConfiguration::document();
13729 EarServerStatusReportConfiguration::document();
13730 EarServerInternals::document();
13731 EarServerConfiguration::document();
13732 RangerPackets::document();
13733 TransportImpairment::document();
13735 EngageSemGroupsConfiguration::document();
13736 EngageSemServerStatusReportConfiguration::document();
13737 EngageSemServerInternals::document();
13738 EngageSemServerConfiguration::document();
13743 #pragma GCC diagnostic pop
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.
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
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.
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.
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.
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.
NsmConfiguration nsm
[Optional] Settings for NSM.
Internal bridging server settings.
int housekeeperIntervalMs
[Optional, Default: 1000] Interval at which to run the housekeeper thread.
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.
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.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
NsmConfiguration nsm
[Optional] Settings for NSM.
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....
NsmConfiguration nsm
[Optional] Settings for NSM.
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.
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.
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.
NsmConfiguration nsm
[Optional] Settings for NSM.
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
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
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 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 FIPS140-2 crypto operation.
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.
NsmConfiguration nsm
[Optional] Settings for NSM.
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.
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).
Cursor-on-Target envelope for NSM wire payloads (optional).
std::string detailJson
Optional JSON object serialized as string for extra CoT detail elements.
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.
std::string domainName
Logical domain label for status and monitoring.
WatchdogSettings watchdog
[Optional] Settings for the node's watchdog.
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
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
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 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
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.
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
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
Details for exporting stream statistics.
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.
NsmConfiguration nsm
[Optional] Settings for NSM.
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.
int peeringConfigurationFileCheckSecs
Number of seconds between checks to see if the peering configuration has been updated....
Tls tls
Details concerning Transport Layer Security.
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.
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
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 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.