Engage Engine API  1.263.9103
Real-time tactical communications engine API
Loading...
Searching...
No Matches
ConfigurationObjects.h
Go to the documentation of this file.
1//
2// Copyright (c) 2019 Rally Tactical Systems, Inc.
3// All rights reserved.
4//
5
20#ifndef ConfigurationObjects_h
21#define ConfigurationObjects_h
22
23#include "Platform.h"
24#include "EngageConstants.h"
25
26#include <iostream>
27#include <cstddef>
28#include <cstdint>
29#include <chrono>
30#include <vector>
31#include <string>
32
33#include <nlohmann/json.hpp>
34
35#ifndef WIN32
36 #pragma GCC diagnostic push
37 #pragma GCC diagnostic ignored "-Wunused-function"
38#endif
39
40#if !defined(ENGAGE_IGNORE_COMPILER_UNUSED_WARNING)
41 #if defined(__GNUC__)
42 #define ENGAGE_IGNORE_COMPILER_UNUSED_WARNING __attribute__((unused))
43 #else
44 #define ENGAGE_IGNORE_COMPILER_UNUSED_WARNING
45 #endif
46#endif // ENGAGE_IGNORE_COMPILER_UNUSED_WARNING
47
48// We'll use a different namespace depending on whether we're building the RTS core code
49// or if this is being included in an app-land project.
50#if defined(RTS_CORE_BUILD)
51namespace ConfigurationObjects
52#else
53namespace AppConfigurationObjects
54#endif
55{
56 static const char *ENGAGE_CONFIGURATION_OBJECT_ATTACHED_OBJECT = "_attached";
57
58 //-----------------------------------------------------------
59 #pragma pack(push, 1)
60 typedef struct _DataSeriesHeader_t
61 {
76 uint8_t t;
77
81 uint32_t ts;
82
95 uint8_t it;
96
105 uint8_t im;
106
110 uint8_t vt;
111
115 uint8_t ss;
117
118 typedef struct _DataElementUint8_t
119 {
120 uint8_t ofs;
121 uint8_t val;
123
125 {
126 uint8_t ofs;
127 uint16_t val;
129
131 {
132 uint8_t ofs;
133 uint32_t val;
135
137 {
138 uint8_t ofs;
139 uint64_t val;
141 #pragma pack(pop)
142
143 typedef enum
144 {
145 invalid = 0,
146 uint8 = 1,
147 uint16 = 2,
148 uint32 = 3,
149 uint64 = 4
150 } DataSeriesValueType_t;
151
157 typedef enum
158 {
159 unknown = 0,
160 heartRate = 1,
161 skinTemp = 2,
162 coreTemp = 3,
163 hydration = 4,
164 bloodOxygenation = 5,
165 fatigueLevel = 6,
166 taskEffectiveness = 7
167 } HumanBiometricsTypes_t;
168
169 //-----------------------------------------------------------
170
171 static FILE *_internalFileOpener(const char *fn, const char *mode)
172 {
173 FILE *fp = nullptr;
174
175 #ifndef WIN32
176 fp = fopen(fn, mode);
177 #else
178 if(fopen_s(&fp, fn, mode) != 0)
179 {
180 fp = nullptr;
181 }
182 #endif
183
184 return fp;
185 }
186
187 #define JSON_SERIALIZED_CLASS(_cn) \
188 class _cn; \
189 static void to_json(nlohmann::json& j, const _cn& p); \
190 static void from_json(const nlohmann::json& j, _cn& p);
191
192 #define IMPLEMENT_JSON_DOCUMENTATION(_cn) \
193 public: \
194 static void document(const char *path = nullptr) \
195 { \
196 _cn example; \
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; \
203 \
204 if(path != nullptr && path[0] != 0) \
205 { \
206 std::string fn = path; \
207 fn.append("/"); \
208 fn.append(#_cn); \
209 fn.append(".json"); \
210 \
211 FILE *fp = _internalFileOpener(fn.c_str(), "wt");\
212 \
213 if(fp != nullptr) \
214 { \
215 fputs(theJson.c_str(), fp); \
216 fclose(fp); \
217 } \
218 else \
219 { \
220 std::cout << "ERROR: Cannot write to " << fn << std::endl; \
221 } \
222 } \
223 } \
224 static const char *className() \
225 { \
226 return #_cn; \
227 }
228
229 #define IMPLEMENT_JSON_SERIALIZATION() \
230 public: \
231 bool deserialize(const char *s) \
232 { \
233 try \
234 { \
235 if(s != nullptr && s[0] != 0) \
236 { \
237 from_json(nlohmann::json::parse(s), *this); \
238 } \
239 else \
240 { \
241 return false; \
242 } \
243 } \
244 catch(...) \
245 { \
246 return false; \
247 } \
248 return true; \
249 } \
250 \
251 std::string serialize(const int indent = -1) \
252 { \
253 try \
254 { \
255 nlohmann::json j; \
256 to_json(j, *this); \
257 return j.dump(indent); \
258 } \
259 catch(...) \
260 { \
261 return std::string("{}"); \
262 } \
263 }
264
265 #define IMPLEMENT_WRAPPED_JSON_SERIALIZATION(_cn) \
266 public: \
267 std::string serializeWrapped(const int indent = -1) \
268 { \
269 try \
270 { \
271 nlohmann::json j; \
272 to_json(j, *this); \
273 \
274 std::string rc; \
275 char firstChar[2]; \
276 firstChar[0] = #_cn[0]; \
277 firstChar[1] = 0; \
278 firstChar[0] = tolower(firstChar[0]); \
279 rc.assign("{\""); \
280 rc.append(firstChar); \
281 rc.append((#_cn) + 1); \
282 rc.append("\":"); \
283 rc.append(j.dump(indent)); \
284 rc.append("}"); \
285 \
286 return rc; \
287 } \
288 catch(...) \
289 { \
290 return std::string("{}"); \
291 } \
292 }
293
294 #define TOJSON_IMPL(__var) \
295 {#__var, p.__var}
296
297 #define FROMJSON_IMPL_SIMPLE(__var) \
298 getOptional(#__var, p.__var, j)
299
300 #define FROMJSON_IMPL(__var, __type, __default) \
301 getOptional<__type>(#__var, p.__var, j, __default)
302
303 #define TOJSON_BASE_IMPL() \
304 to_json(j, (ConfigurationObjectBase&)p)
305
306 #define FROMJSON_BASE_IMPL() \
307 from_json(j, (ConfigurationObjectBase&)p);
308
309
310 //-----------------------------------------------------------
311 static std::string EMPTY_STRING;
312
313 template<class T>
314 static void getOptional(const char *name, T& v, const nlohmann::json& j, T def)
315 {
316 try
317 {
318 if(j.contains(name))
319 {
320 j.at(name).get_to(v);
321 }
322 else
323 {
324 v = def;
325 }
326 }
327 catch(...)
328 {
329 v = def;
330 }
331 }
332
333 template<class T>
334 static void getOptional(const char *name, T& v, const nlohmann::json& j)
335 {
336 try
337 {
338 if(j.contains(name))
339 {
340 j.at(name).get_to(v);
341 }
342 }
343 catch(...)
344 {
345 }
346 }
347
348 template<class T>
349 static void getOptionalWithIndicator(const char *name, T& v, const nlohmann::json& j, T def, bool *wasFound)
350 {
351 try
352 {
353 if(j.contains(name))
354 {
355 j.at(name).get_to(v);
356 *wasFound = true;
357 }
358 else
359 {
360 v = def;
361 *wasFound = false;
362 }
363 }
364 catch(...)
365 {
366 v = def;
367 *wasFound = false;
368 }
369 }
370
371 template<class T>
372 static void getOptionalWithIndicator(const char *name, T& v, const nlohmann::json& j, bool *wasFound)
373 {
374 try
375 {
376 if(j.contains(name))
377 {
378 j.at(name).get_to(v);
379 *wasFound = true;
380 }
381 else
382 {
383 *wasFound = false;
384 }
385 }
386 catch(...)
387 {
388 *wasFound = false;
389 }
390 }
391
393 {
394 public:
396 {
397 _documenting = false;
398 }
399
401 {
402 }
403
404 virtual void initForDocumenting()
405 {
406 _documenting = true;
407 }
408
409 virtual std::string toString()
410 {
411 return std::string("");
412 }
413
414 inline virtual bool isDocumenting() const
415 {
416 return _documenting;
417 }
418
419 nlohmann::json _attached;
420
421 protected:
422 bool _documenting;
423 };
424
425 static void to_json(nlohmann::json& j, const ConfigurationObjectBase& p)
426 {
427 try
428 {
429 if(p._attached != nullptr)
430 {
431 j[ENGAGE_CONFIGURATION_OBJECT_ATTACHED_OBJECT] = p._attached;
432 }
433 }
434 catch(...)
435 {
436 }
437 }
438 static void from_json(const nlohmann::json& j, ConfigurationObjectBase& p)
439 {
440 try
441 {
442 if(j.contains(ENGAGE_CONFIGURATION_OBJECT_ATTACHED_OBJECT))
443 {
444 p._attached = j.at(ENGAGE_CONFIGURATION_OBJECT_ATTACHED_OBJECT);
445 }
446 }
447 catch(...)
448 {
449 }
450 }
451
452 //-----------------------------------------------------------
453 JSON_SERIALIZED_CLASS(KvPair)
461 {
462 IMPLEMENT_JSON_SERIALIZATION()
463 IMPLEMENT_JSON_DOCUMENTATION(KvPair)
464
465 public:
467 std::string key;
468
470 std::string value;
471
472 KvPair()
473 {
474 clear();
475 }
476
477 void clear()
478 {
479 key.clear();
480 value.clear();
481 }
482 };
483
484 static void to_json(nlohmann::json& j, const KvPair& p)
485 {
486 j = nlohmann::json{
487 TOJSON_IMPL(key),
488 TOJSON_IMPL(value)
489 };
490 }
491 static void from_json(const nlohmann::json& j, KvPair& p)
492 {
493 p.clear();
494 getOptional<std::string>("key", p.key, j, EMPTY_STRING);
495 getOptional<std::string>("tags", p.value, j, EMPTY_STRING);
496 }
497
498 //-----------------------------------------------------------
499 JSON_SERIALIZED_CLASS(TuningSettings)
501 {
502 IMPLEMENT_JSON_SERIALIZATION()
503 IMPLEMENT_JSON_DOCUMENTATION(TuningSettings)
504
505 public:
508
511
514
515
518
521
524
525
528
531
534
537
539 {
540 clear();
541 }
542
543 void clear()
544 {
545 maxPooledRtpMb = 0;
546 maxPooledRtpObjects = 0;
547 maxActiveRtpObjects = 0;
548
549 maxPooledBlobMb = 0;
550 maxPooledBlobObjects = 0;
551 maxActiveBlobObjects = 0;
552
553 maxPooledBufferMb = 0;
554 maxPooledBufferObjects = 0;
555 maxActiveBufferObjects = 0;
556
557 maxActiveRtpProcessors = 0;
558 }
559
560 virtual void initForDocumenting()
561 {
562 clear();
563 }
564 };
565
566 static void to_json(nlohmann::json& j, const TuningSettings& p)
567 {
568 j = nlohmann::json{
569 TOJSON_IMPL(maxPooledRtpMb),
570 TOJSON_IMPL(maxPooledRtpObjects),
571 TOJSON_IMPL(maxActiveRtpObjects),
572
573 TOJSON_IMPL(maxPooledBlobMb),
574 TOJSON_IMPL(maxPooledBlobObjects),
575 TOJSON_IMPL(maxActiveBlobObjects),
576
577 TOJSON_IMPL(maxPooledBufferMb),
578 TOJSON_IMPL(maxPooledBufferObjects),
579 TOJSON_IMPL(maxActiveBufferObjects),
580
581 TOJSON_IMPL(maxActiveRtpProcessors)
582 };
583 }
584 static void from_json(const nlohmann::json& j, TuningSettings& p)
585 {
586 p.clear();
587 FROMJSON_IMPL(maxPooledRtpMb, uint32_t, 0);
588 FROMJSON_IMPL(maxPooledRtpObjects, uint32_t, 0);
589 FROMJSON_IMPL(maxActiveRtpObjects, uint32_t, 0);
590
591 FROMJSON_IMPL(maxPooledBlobMb, uint32_t, 0);
592 FROMJSON_IMPL(maxPooledBlobObjects, uint32_t, 0);
593 FROMJSON_IMPL(maxActiveBlobObjects, uint32_t, 0);
594
595 FROMJSON_IMPL(maxPooledBufferMb, uint32_t, 0);
596 FROMJSON_IMPL(maxPooledBufferObjects, uint32_t, 0);
597 FROMJSON_IMPL(maxActiveBufferObjects, uint32_t, 0);
598
599 FROMJSON_IMPL(maxActiveRtpProcessors, uint32_t, 0);
600 }
601
602
603 //-----------------------------------------------------------
604 JSON_SERIALIZED_CLASS(FipsCryptoSettings)
606 {
607 IMPLEMENT_JSON_SERIALIZATION()
608 IMPLEMENT_JSON_DOCUMENTATION(FipsCryptoSettings)
609
610 public:
613
615 std::string path;
616
618 bool debug;
619
621 std::string curves;
622
624 std::string ciphers;
625
627 {
628 clear();
629 }
630
631 void clear()
632 {
633 enabled = false;
634 path.clear();
635 debug = false;
636 curves.clear();
637 ciphers.clear();
638 }
639
640 virtual void initForDocumenting()
641 {
642 clear();
643 }
644 };
645
646 static void to_json(nlohmann::json& j, const FipsCryptoSettings& p)
647 {
648 j = nlohmann::json{
649 TOJSON_IMPL(enabled),
650 TOJSON_IMPL(path),
651 TOJSON_IMPL(debug),
652 TOJSON_IMPL(curves),
653 TOJSON_IMPL(ciphers)
654 };
655 }
656 static void from_json(const nlohmann::json& j, FipsCryptoSettings& p)
657 {
658 p.clear();
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);
664 }
665
666
667 //-----------------------------------------------------------
668 JSON_SERIALIZED_CLASS(WatchdogSettings)
670 {
671 IMPLEMENT_JSON_SERIALIZATION()
672 IMPLEMENT_JSON_DOCUMENTATION(WatchdogSettings)
673
674 public:
677
680
683
686
689
691 {
692 clear();
693 }
694
695 void clear()
696 {
697 enabled = true;
698 intervalMs = 5000;
699 hangDetectionMs = 2000;
700 abortOnHang = true;
701 slowExecutionThresholdMs = 100;
702 }
703
704 virtual void initForDocumenting()
705 {
706 clear();
707 }
708 };
709
710 static void to_json(nlohmann::json& j, const WatchdogSettings& p)
711 {
712 j = nlohmann::json{
713 TOJSON_IMPL(enabled),
714 TOJSON_IMPL(intervalMs),
715 TOJSON_IMPL(hangDetectionMs),
716 TOJSON_IMPL(abortOnHang),
717 TOJSON_IMPL(slowExecutionThresholdMs)
718 };
719 }
720 static void from_json(const nlohmann::json& j, WatchdogSettings& p)
721 {
722 p.clear();
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);
728 }
729
730
731 //-----------------------------------------------------------
732 JSON_SERIALIZED_CLASS(FileRecordingRequest)
734 {
735 IMPLEMENT_JSON_SERIALIZATION()
736 IMPLEMENT_JSON_DOCUMENTATION(FileRecordingRequest)
737
738 public:
739 std::string id;
740 std::string fileName;
741 uint32_t maxMs;
742
744 {
745 clear();
746 }
747
748 void clear()
749 {
750 id.clear();
751 fileName.clear();
752 maxMs = 60000;
753 }
754
755 virtual void initForDocumenting()
756 {
757 clear();
758 id = "1-2-3-4-5-6-7-8-9";
759 fileName = "/tmp/test.wav";
760 maxMs = 10000;
761 }
762 };
763
764 static void to_json(nlohmann::json& j, const FileRecordingRequest& p)
765 {
766 j = nlohmann::json{
767 TOJSON_IMPL(id),
768 TOJSON_IMPL(fileName),
769 TOJSON_IMPL(maxMs)
770 };
771 }
772 static void from_json(const nlohmann::json& j, FileRecordingRequest& p)
773 {
774 p.clear();
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);
778 }
779
780
781 //-----------------------------------------------------------
782 JSON_SERIALIZED_CLASS(Feature)
784 {
785 IMPLEMENT_JSON_SERIALIZATION()
786 IMPLEMENT_JSON_DOCUMENTATION(Feature)
787
788 public:
789 std::string id;
790 std::string name;
791 std::string description;
792 std::string comments;
793 int count;
794 int used; // NOTE: Ignored during deserialization!
795
796 Feature()
797 {
798 clear();
799 }
800
801 void clear()
802 {
803 id.clear();
804 name.clear();
805 description.clear();
806 comments.clear();
807 count = 0;
808 used = 0;
809 }
810
811 virtual void initForDocumenting()
812 {
813 clear();
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";
818 count = 42;
819 used = 16;
820 }
821 };
822
823 static void to_json(nlohmann::json& j, const Feature& p)
824 {
825 j = nlohmann::json{
826 TOJSON_IMPL(id),
827 TOJSON_IMPL(name),
828 TOJSON_IMPL(description),
829 TOJSON_IMPL(comments),
830 TOJSON_IMPL(count),
831 TOJSON_IMPL(used)
832 };
833 }
834 static void from_json(const nlohmann::json& j, Feature& p)
835 {
836 p.clear();
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);
842
843 // NOTE: Not deserialized!
844 //getOptional("used", p.used, j, 0);
845 }
846
847
848 //-----------------------------------------------------------
849 JSON_SERIALIZED_CLASS(Featureset)
851 {
852 IMPLEMENT_JSON_SERIALIZATION()
853 IMPLEMENT_JSON_DOCUMENTATION(Featureset)
854
855 public:
856 std::string signature;
857 bool lockToDeviceId;
858 std::vector<Feature> features;
859
860 Featureset()
861 {
862 clear();
863 }
864
865 void clear()
866 {
867 signature.clear();
868 lockToDeviceId = false;
869 features.clear();
870 }
871
872 virtual void initForDocumenting()
873 {
874 clear();
875 signature = "c39df3f36c6444e686e47e70fc45cf91e6ed2d8de62d4a1e89f507d567ff48aaabb1a70e54b44377b46fc4a1a2e319e5b77e4abffc444db98f8eb55d709aad5f";
876 lockToDeviceId = false;
877 }
878 };
879
880 static void to_json(nlohmann::json& j, const Featureset& p)
881 {
882 j = nlohmann::json{
883 TOJSON_IMPL(signature),
884 TOJSON_IMPL(lockToDeviceId),
885 TOJSON_IMPL(features)
886 };
887 }
888 static void from_json(const nlohmann::json& j, Featureset& p)
889 {
890 p.clear();
891 getOptional("signature", p.signature, j);
892 getOptional<bool>("lockToDeviceId", p.lockToDeviceId, j, false);
893 getOptional<std::vector<Feature>>("features", p.features, j);
894 }
895
896
897 //-----------------------------------------------------------
898 JSON_SERIALIZED_CLASS(Agc)
908 {
909 IMPLEMENT_JSON_SERIALIZATION()
910 IMPLEMENT_JSON_DOCUMENTATION(Agc)
911
912 public:
915
918
921
924
927
930
931 Agc()
932 {
933 clear();
934 }
935
936 void clear()
937 {
938 enabled = false;
939 minLevel = 0;
940 maxLevel = 255;
941 compressionGainDb = 25;
942 enableLimiter = false;
943 targetLevelDb = 3;
944 }
945 };
946
947 static void to_json(nlohmann::json& j, const Agc& p)
948 {
949 j = nlohmann::json{
950 TOJSON_IMPL(enabled),
951 TOJSON_IMPL(minLevel),
952 TOJSON_IMPL(maxLevel),
953 TOJSON_IMPL(compressionGainDb),
954 TOJSON_IMPL(enableLimiter),
955 TOJSON_IMPL(targetLevelDb)
956 };
957 }
958 static void from_json(const nlohmann::json& j, Agc& p)
959 {
960 p.clear();
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);
967 }
968
969
970 //-----------------------------------------------------------
971 JSON_SERIALIZED_CLASS(RtpPayloadTypeTranslation)
981 {
982 IMPLEMENT_JSON_SERIALIZATION()
983 IMPLEMENT_JSON_DOCUMENTATION(RtpPayloadTypeTranslation)
984
985 public:
987 uint16_t external;
988
990 uint16_t engage;
991
993 {
994 clear();
995 }
996
997 void clear()
998 {
999 external = 0;
1000 engage = 0;
1001 }
1002
1003 bool matches(const RtpPayloadTypeTranslation& other)
1004 {
1005 return ( (external == other.external) && (engage == other.engage) );
1006 }
1007 };
1008
1009 static void to_json(nlohmann::json& j, const RtpPayloadTypeTranslation& p)
1010 {
1011 j = nlohmann::json{
1012 TOJSON_IMPL(external),
1013 TOJSON_IMPL(engage)
1014 };
1015 }
1016 static void from_json(const nlohmann::json& j, RtpPayloadTypeTranslation& p)
1017 {
1018 p.clear();
1019 getOptional<uint16_t>("external", p.external, j);
1020 getOptional<uint16_t>("engage", p.engage, j);
1021 }
1022
1023 //-----------------------------------------------------------
1024 JSON_SERIALIZED_CLASS(NetworkInterfaceDevice)
1026 {
1027 IMPLEMENT_JSON_SERIALIZATION()
1028 IMPLEMENT_JSON_DOCUMENTATION(NetworkInterfaceDevice)
1029
1030 public:
1031 std::string name;
1032 std::string friendlyName;
1033 std::string description;
1034 int family;
1035 std::string address;
1036 bool available;
1037 bool isLoopback;
1038 bool supportsMulticast;
1039 std::string hardwareAddress;
1040
1042 {
1043 clear();
1044 }
1045
1046 void clear()
1047 {
1048 name.clear();
1049 friendlyName.clear();
1050 description.clear();
1051 family = -1;
1052 address.clear();
1053 available = false;
1054 isLoopback = false;
1055 supportsMulticast = false;
1056 hardwareAddress.clear();
1057 }
1058
1059 virtual void initForDocumenting()
1060 {
1061 clear();
1062 name = "en0";
1063 friendlyName = "Wi-Fi";
1064 description = "A wi-fi adapter";
1065 family = 1;
1066 address = "127.0.0.1";
1067 available = true;
1068 isLoopback = true;
1069 supportsMulticast = false;
1070 hardwareAddress = "DE:AD:BE:EF:01:02:03";
1071 }
1072 };
1073
1074 static void to_json(nlohmann::json& j, const NetworkInterfaceDevice& p)
1075 {
1076 j = nlohmann::json{
1077 TOJSON_IMPL(name),
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)
1086 };
1087 }
1088 static void from_json(const nlohmann::json& j, NetworkInterfaceDevice& p)
1089 {
1090 p.clear();
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);
1100 }
1101
1102 //-----------------------------------------------------------
1103 JSON_SERIALIZED_CLASS(ListOfNetworkInterfaceDevice)
1105 {
1106 IMPLEMENT_JSON_SERIALIZATION()
1107 IMPLEMENT_JSON_DOCUMENTATION(ListOfNetworkInterfaceDevice)
1108
1109 public:
1110 std::vector<NetworkInterfaceDevice> list;
1111
1113 {
1114 clear();
1115 }
1116
1117 void clear()
1118 {
1119 list.clear();
1120 }
1121 };
1122
1123 static void to_json(nlohmann::json& j, const ListOfNetworkInterfaceDevice& p)
1124 {
1125 j = nlohmann::json{
1126 TOJSON_IMPL(list)
1127 };
1128 }
1129 static void from_json(const nlohmann::json& j, ListOfNetworkInterfaceDevice& p)
1130 {
1131 p.clear();
1132 getOptional<std::vector<NetworkInterfaceDevice>>("list", p.list, j);
1133 }
1134
1135
1136 //-----------------------------------------------------------
1137 JSON_SERIALIZED_CLASS(RtpHeader)
1147 {
1148 IMPLEMENT_JSON_SERIALIZATION()
1149 IMPLEMENT_JSON_DOCUMENTATION(RtpHeader)
1150
1151 public:
1152
1154 int pt;
1155
1158
1160 uint16_t seq;
1161
1163 uint32_t ssrc;
1164
1166 uint32_t ts;
1167
1168 RtpHeader()
1169 {
1170 clear();
1171 }
1172
1173 void clear()
1174 {
1175 pt = -1;
1176 marker = false;
1177 seq = 0;
1178 ssrc = 0;
1179 ts = 0;
1180 }
1181
1182 virtual void initForDocumenting()
1183 {
1184 clear();
1185 pt = 0;
1186 marker = false;
1187 seq = 123;
1188 ssrc = 12345678;
1189 ts = 87654321;
1190 }
1191 };
1192
1193 static void to_json(nlohmann::json& j, const RtpHeader& p)
1194 {
1195 if(p.pt != -1)
1196 {
1197 j = nlohmann::json{
1198 TOJSON_IMPL(pt),
1199 TOJSON_IMPL(marker),
1200 TOJSON_IMPL(seq),
1201 TOJSON_IMPL(ssrc),
1202 TOJSON_IMPL(ts)
1203 };
1204 }
1205 }
1206 static void from_json(const nlohmann::json& j, RtpHeader& p)
1207 {
1208 p.clear();
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);
1214 }
1215
1216 //-----------------------------------------------------------
1217 JSON_SERIALIZED_CLASS(Rfc4733Event)
1225 {
1226 IMPLEMENT_JSON_SERIALIZATION()
1227 IMPLEMENT_JSON_DOCUMENTATION(Rfc4733Event)
1228
1229 public:
1230
1232 int id;
1233
1235 bool end;
1236
1239
1242
1245
1246 Rfc4733Event()
1247 {
1248 clear();
1249 }
1250
1251 void clear()
1252 {
1253 id = -1;
1254 end = false;
1255 reserved = 0;
1256 volume = 0;
1257 duration = 0;
1258 }
1259
1260 virtual void initForDocumenting()
1261 {
1262 clear();
1263 id = 0;
1264 end = false;
1265 reserved = 0;
1266 volume = 0;
1267 duration = 0;
1268 }
1269 };
1270
1271 static void to_json(nlohmann::json& j, const Rfc4733Event& p)
1272 {
1273 j = nlohmann::json{
1274 TOJSON_IMPL(id),
1275 TOJSON_IMPL(end),
1276 TOJSON_IMPL(reserved),
1277 TOJSON_IMPL(volume),
1278 TOJSON_IMPL(duration)
1279 };
1280 }
1281 static void from_json(const nlohmann::json& j, Rfc4733Event& p)
1282 {
1283 p.clear();
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);
1289 }
1290
1291 //-----------------------------------------------------------
1292 JSON_SERIALIZED_CLASS(BlobInfo)
1302 {
1303 IMPLEMENT_JSON_SERIALIZATION()
1304 IMPLEMENT_JSON_DOCUMENTATION(BlobInfo)
1305
1306 public:
1310 typedef enum
1311 {
1313 bptUndefined = 0,
1314
1316 bptAppTextUtf8 = 1,
1317
1319 bptJsonTextUtf8 = 2,
1320
1322 bptAppBinary = 3,
1323
1325 bptEngageBinaryHumanBiometrics = 4,
1326
1328 bptAppMimeMessage = 5,
1329
1331 bptRfc4733Events = 6,
1332
1334 bptEngageInternal = 42
1335 } PayloadType_t;
1336
1338 size_t size;
1339
1341 std::string source;
1342
1344 std::string target;
1345
1348
1351
1353 std::string txnId;
1354
1357
1358 BlobInfo()
1359 {
1360 clear();
1361 }
1362
1363 void clear()
1364 {
1365 size = 0;
1366 source.clear();
1367 target.clear();
1368 rtpHeader.clear();
1369 payloadType = PayloadType_t::bptUndefined;
1370 txnId.clear();
1371 txnTimeoutSecs = 0;
1372 }
1373
1374 virtual void initForDocumenting()
1375 {
1376 clear();
1377 rtpHeader.initForDocumenting();
1378 }
1379 };
1380
1381 static void to_json(nlohmann::json& j, const BlobInfo& p)
1382 {
1383 j = nlohmann::json{
1384 TOJSON_IMPL(size),
1385 TOJSON_IMPL(source),
1386 TOJSON_IMPL(target),
1387 TOJSON_IMPL(rtpHeader),
1388 TOJSON_IMPL(payloadType),
1389 TOJSON_IMPL(txnId),
1390 TOJSON_IMPL(txnTimeoutSecs)
1391 };
1392 }
1393 static void from_json(const nlohmann::json& j, BlobInfo& p)
1394 {
1395 p.clear();
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);
1403 }
1404
1405
1406 //-----------------------------------------------------------
1407 JSON_SERIALIZED_CLASS(TxAudioUri)
1420 {
1421 IMPLEMENT_JSON_SERIALIZATION()
1422 IMPLEMENT_JSON_DOCUMENTATION(TxAudioUri)
1423
1424 public:
1426 std::string uri;
1427
1430
1431 TxAudioUri()
1432 {
1433 clear();
1434 }
1435
1436 void clear()
1437 {
1438 uri.clear();
1439 repeatCount = 0;
1440 }
1441
1442 virtual void initForDocumenting()
1443 {
1444 }
1445 };
1446
1447 static void to_json(nlohmann::json& j, const TxAudioUri& p)
1448 {
1449 j = nlohmann::json{
1450 TOJSON_IMPL(uri),
1451 TOJSON_IMPL(repeatCount)
1452 };
1453 }
1454 static void from_json(const nlohmann::json& j, TxAudioUri& p)
1455 {
1456 p.clear();
1457 getOptional<std::string>("uri", p.uri, j, EMPTY_STRING);
1458 getOptional<int>("repeatCount", p.repeatCount, j, 0);
1459 }
1460
1461
1462 //-----------------------------------------------------------
1463 JSON_SERIALIZED_CLASS(AdvancedTxParams)
1476 {
1477 IMPLEMENT_JSON_SERIALIZATION()
1478 IMPLEMENT_JSON_DOCUMENTATION(AdvancedTxParams)
1479
1480 public:
1481
1483 uint16_t flags;
1484
1486 uint8_t priority;
1487
1490
1493
1495 std::string alias;
1496
1498 bool muted;
1499
1501 uint32_t txId;
1502
1505
1508
1511
1514
1516 {
1517 clear();
1518 }
1519
1520 void clear()
1521 {
1522 flags = 0;
1523 priority = 0;
1524 subchannelTag = 0;
1525 includeNodeId = false;
1526 alias.clear();
1527 muted = false;
1528 txId = 0;
1529 audioUri.clear();
1530 aliasSpecializer = 0;
1531 receiverRxMuteForAliasSpecializer = false;
1532 reBegin = false;
1533 }
1534
1535 virtual void initForDocumenting()
1536 {
1537 }
1538 };
1539
1540 static void to_json(nlohmann::json& j, const AdvancedTxParams& p)
1541 {
1542 j = nlohmann::json{
1543 TOJSON_IMPL(flags),
1544 TOJSON_IMPL(priority),
1545 TOJSON_IMPL(subchannelTag),
1546 TOJSON_IMPL(includeNodeId),
1547 TOJSON_IMPL(alias),
1548 TOJSON_IMPL(muted),
1549 TOJSON_IMPL(txId),
1550 TOJSON_IMPL(audioUri),
1551 TOJSON_IMPL(aliasSpecializer),
1552 TOJSON_IMPL(receiverRxMuteForAliasSpecializer),
1553 TOJSON_IMPL(reBegin)
1554 };
1555 }
1556 static void from_json(const nlohmann::json& j, AdvancedTxParams& p)
1557 {
1558 p.clear();
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);
1570 }
1571
1572 //-----------------------------------------------------------
1573 JSON_SERIALIZED_CLASS(Identity)
1586 {
1587 IMPLEMENT_JSON_SERIALIZATION()
1588 IMPLEMENT_JSON_DOCUMENTATION(Identity)
1589
1590 public:
1598 std::string nodeId;
1599
1601 std::string userId;
1602
1604 std::string displayName;
1605
1607 std::string avatar;
1608
1609 Identity()
1610 {
1611 clear();
1612 }
1613
1614 void clear()
1615 {
1616 nodeId.clear();
1617 userId.clear();
1618 displayName.clear();
1619 avatar.clear();
1620 }
1621
1622 virtual void initForDocumenting()
1623 {
1624 }
1625 };
1626
1627 static void to_json(nlohmann::json& j, const Identity& p)
1628 {
1629 j = nlohmann::json{
1630 TOJSON_IMPL(nodeId),
1631 TOJSON_IMPL(userId),
1632 TOJSON_IMPL(displayName),
1633 TOJSON_IMPL(avatar)
1634 };
1635 }
1636 static void from_json(const nlohmann::json& j, Identity& p)
1637 {
1638 p.clear();
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);
1643 }
1644
1645
1646 //-----------------------------------------------------------
1647 JSON_SERIALIZED_CLASS(Location)
1660 {
1661 IMPLEMENT_JSON_SERIALIZATION()
1662 IMPLEMENT_JSON_DOCUMENTATION(Location)
1663
1664 public:
1665 constexpr static double INVALID_LOCATION_VALUE = -999.999;
1666
1668 uint32_t ts;
1669
1671 double latitude;
1672
1675
1677 double altitude;
1678
1681
1683 double speed;
1684
1685 Location()
1686 {
1687 clear();
1688 }
1689
1690 void clear()
1691 {
1692 ts = 0;
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;
1698 }
1699
1700 virtual void initForDocumenting()
1701 {
1702 clear();
1703
1704 ts = 123456;
1705 latitude = 123.456;
1706 longitude = 456.789;
1707 altitude = 123;
1708 direction = 1;
1709 speed = 1234;
1710 }
1711 };
1712
1713 static void to_json(nlohmann::json& j, const Location& p)
1714 {
1715 if(p.latitude != Location::INVALID_LOCATION_VALUE && p.longitude != Location::INVALID_LOCATION_VALUE)
1716 {
1717 j = nlohmann::json{
1718 TOJSON_IMPL(latitude),
1719 TOJSON_IMPL(longitude),
1720 };
1721
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;
1726 }
1727 }
1728 static void from_json(const nlohmann::json& j, Location& p)
1729 {
1730 p.clear();
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);
1737 }
1738
1739 //-----------------------------------------------------------
1740 JSON_SERIALIZED_CLASS(Power)
1751 {
1752 IMPLEMENT_JSON_SERIALIZATION()
1753 IMPLEMENT_JSON_DOCUMENTATION(Power)
1754
1755 public:
1756
1769
1783
1786
1787 Power()
1788 {
1789 clear();
1790 }
1791
1792 void clear()
1793 {
1794 source = 0;
1795 state = 0;
1796 level = 0;
1797 }
1798
1799 virtual void initForDocumenting()
1800 {
1801 }
1802 };
1803
1804 static void to_json(nlohmann::json& j, const Power& p)
1805 {
1806 if(p.source != 0 && p.state != 0 && p.level != 0)
1807 {
1808 j = nlohmann::json{
1809 TOJSON_IMPL(source),
1810 TOJSON_IMPL(state),
1811 TOJSON_IMPL(level)
1812 };
1813 }
1814 }
1815 static void from_json(const nlohmann::json& j, Power& p)
1816 {
1817 p.clear();
1818 getOptional<int>("source", p.source, j, 0);
1819 getOptional<int>("state", p.state, j, 0);
1820 getOptional<int>("level", p.level, j, 0);
1821 }
1822
1823
1824 //-----------------------------------------------------------
1825 JSON_SERIALIZED_CLASS(Connectivity)
1836 {
1837 IMPLEMENT_JSON_SERIALIZATION()
1838 IMPLEMENT_JSON_DOCUMENTATION(Connectivity)
1839
1840 public:
1854 int type;
1855
1858
1861
1862 Connectivity()
1863 {
1864 clear();
1865 }
1866
1867 void clear()
1868 {
1869 type = 0;
1870 strength = 0;
1871 rating = 0;
1872 }
1873
1874 virtual void initForDocumenting()
1875 {
1876 clear();
1877
1878 type = 1;
1879 strength = 2;
1880 rating = 3;
1881 }
1882 };
1883
1884 static void to_json(nlohmann::json& j, const Connectivity& p)
1885 {
1886 if(p.type != 0)
1887 {
1888 j = nlohmann::json{
1889 TOJSON_IMPL(type),
1890 TOJSON_IMPL(strength),
1891 TOJSON_IMPL(rating)
1892 };
1893 }
1894 }
1895 static void from_json(const nlohmann::json& j, Connectivity& p)
1896 {
1897 p.clear();
1898 getOptional<int>("type", p.type, j, 0);
1899 getOptional<int>("strength", p.strength, j, 0);
1900 getOptional<int>("rating", p.rating, j, 0);
1901 }
1902
1903
1904 //-----------------------------------------------------------
1905 JSON_SERIALIZED_CLASS(PresenceDescriptorGroupItem)
1916 {
1917 IMPLEMENT_JSON_SERIALIZATION()
1918 IMPLEMENT_JSON_DOCUMENTATION(PresenceDescriptorGroupItem)
1919
1920 public:
1922 std::string groupId;
1923
1925 std::string alias;
1926
1928 uint16_t status;
1929
1931 {
1932 clear();
1933 }
1934
1935 void clear()
1936 {
1937 groupId.clear();
1938 alias.clear();
1939 status = 0;
1940 }
1941
1942 virtual void initForDocumenting()
1943 {
1944 groupId = "{123-456}";
1945 alias = "MYALIAS";
1946 status = 0;
1947 }
1948 };
1949
1950 static void to_json(nlohmann::json& j, const PresenceDescriptorGroupItem& p)
1951 {
1952 j = nlohmann::json{
1953 TOJSON_IMPL(groupId),
1954 TOJSON_IMPL(alias),
1955 TOJSON_IMPL(status)
1956 };
1957 }
1958 static void from_json(const nlohmann::json& j, PresenceDescriptorGroupItem& p)
1959 {
1960 p.clear();
1961 getOptional<std::string>("groupId", p.groupId, j);
1962 getOptional<std::string>("alias", p.alias, j);
1963 getOptional<uint16_t>("status", p.status, j);
1964 }
1965
1966
1967 //-----------------------------------------------------------
1968 JSON_SERIALIZED_CLASS(PresenceDescriptor)
1979 {
1980 IMPLEMENT_JSON_SERIALIZATION()
1981 IMPLEMENT_JSON_DOCUMENTATION(PresenceDescriptor)
1982
1983 public:
1984
1990 bool self;
1991
1997 uint32_t ts;
1998
2004 uint32_t nextUpdate;
2005
2008
2010 std::string comment;
2011
2025 uint32_t disposition;
2026
2028 std::vector<PresenceDescriptorGroupItem> groupAliases;
2029
2032
2034 std::string custom;
2035
2038
2041
2044
2046 {
2047 clear();
2048 }
2049
2050 void clear()
2051 {
2052 self = false;
2053 ts = 0;
2054 nextUpdate = 0;
2055 identity.clear();
2056 comment.clear();
2057 disposition = 0;
2058 groupAliases.clear();
2059 location.clear();
2060 custom.clear();
2061 announceOnReceive = false;
2062 connectivity.clear();
2063 power.clear();
2064 }
2065
2066 virtual void initForDocumenting()
2067 {
2068 clear();
2069
2070 self = true;
2071 ts = 123;
2072 nextUpdate = 0;
2073 identity.initForDocumenting();
2074 comment = "This is a comment";
2075 disposition = 123;
2076
2077 PresenceDescriptorGroupItem gi;
2078 gi.initForDocumenting();
2079 groupAliases.push_back(gi);
2080
2081 location.initForDocumenting();
2082 custom = "{}";
2083 announceOnReceive = true;
2084 connectivity.initForDocumenting();
2085 power.initForDocumenting();
2086 }
2087 };
2088
2089 static void to_json(nlohmann::json& j, const PresenceDescriptor& p)
2090 {
2091 j = nlohmann::json{
2092 TOJSON_IMPL(ts),
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),
2102 TOJSON_IMPL(power)
2103 };
2104
2105 if(!p.comment.empty()) j["comment"] = p.comment;
2106 if(!p.custom.empty()) j["custom"] = p.custom;
2107
2108 if(p.self)
2109 {
2110 j["self"] = true;
2111 }
2112 }
2113 static void from_json(const nlohmann::json& j, PresenceDescriptor& p)
2114 {
2115 p.clear();
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);
2128 }
2129
2135 typedef enum
2136 {
2139
2142
2145
2147 priVoice = 3
2148 } TxPriority_t;
2149
2155 typedef enum
2156 {
2159
2162
2165
2167 arpIpv6ThenIpv4 = 64
2168 } AddressResolutionPolicy_t;
2169
2170 //-----------------------------------------------------------
2171 JSON_SERIALIZED_CLASS(NetworkTxOptions)
2184 {
2185 IMPLEMENT_JSON_SERIALIZATION()
2186 IMPLEMENT_JSON_DOCUMENTATION(NetworkTxOptions)
2187
2188 public:
2191
2197 int ttl;
2198
2200 {
2201 clear();
2202 }
2203
2204 void clear()
2205 {
2206 priority = priVoice;
2207 ttl = 1;
2208 }
2209
2210 virtual void initForDocumenting()
2211 {
2212 }
2213 };
2214
2215 static void to_json(nlohmann::json& j, const NetworkTxOptions& p)
2216 {
2217 j = nlohmann::json{
2218 TOJSON_IMPL(priority),
2219 TOJSON_IMPL(ttl)
2220 };
2221 }
2222 static void from_json(const nlohmann::json& j, NetworkTxOptions& p)
2223 {
2224 p.clear();
2225 getOptional<TxPriority_t>("priority", p.priority, j, TxPriority_t::priVoice);
2226 getOptional<int>("ttl", p.ttl, j, 1);
2227 }
2228
2229
2230 //-----------------------------------------------------------
2231 JSON_SERIALIZED_CLASS(TcpNetworkTxOptions)
2240 {
2241 IMPLEMENT_JSON_SERIALIZATION()
2242 IMPLEMENT_JSON_DOCUMENTATION(TcpNetworkTxOptions)
2243
2244 public:
2246 {
2247 clear();
2248 }
2249
2250 void clear()
2251 {
2252 priority = priVoice;
2253 ttl = -1;
2254 }
2255
2256 virtual void initForDocumenting()
2257 {
2258 }
2259 };
2260
2261 static void to_json(nlohmann::json& j, const TcpNetworkTxOptions& p)
2262 {
2263 j = nlohmann::json{
2264 TOJSON_IMPL(priority),
2265 TOJSON_IMPL(ttl)
2266 };
2267 }
2268 static void from_json(const nlohmann::json& j, TcpNetworkTxOptions& p)
2269 {
2270 p.clear();
2271 getOptional<TxPriority_t>("priority", p.priority, j, TxPriority_t::priVoice);
2272 getOptional<int>("ttl", p.ttl, j, -1);
2273 }
2274
2275 typedef enum
2276 {
2279
2282
2284 ifIp6 = 6
2285 } IpFamilyType_t;
2286
2287 //-----------------------------------------------------------
2288 JSON_SERIALIZED_CLASS(NetworkAddress)
2300 {
2301 IMPLEMENT_JSON_SERIALIZATION()
2302 IMPLEMENT_JSON_DOCUMENTATION(NetworkAddress)
2303
2304 public:
2306 std::string address;
2307
2309 int port;
2310
2312 {
2313 clear();
2314 }
2315
2316 void clear()
2317 {
2318 address.clear();
2319 port = 0;
2320 }
2321
2322 bool matches(const NetworkAddress& other)
2323 {
2324 if(address.compare(other.address) != 0)
2325 {
2326 return false;
2327 }
2328
2329 if(port != other.port)
2330 {
2331 return false;
2332 }
2333
2334 return true;
2335 }
2336 };
2337
2338 static void to_json(nlohmann::json& j, const NetworkAddress& p)
2339 {
2340 j = nlohmann::json{
2341 TOJSON_IMPL(address),
2342 TOJSON_IMPL(port)
2343 };
2344 }
2345 static void from_json(const nlohmann::json& j, NetworkAddress& p)
2346 {
2347 p.clear();
2348 getOptional<std::string>("address", p.address, j);
2349 getOptional<int>("port", p.port, j);
2350 }
2351
2352
2353 //-----------------------------------------------------------
2354 JSON_SERIALIZED_CLASS(NetworkAddressRxTx)
2366 {
2367 IMPLEMENT_JSON_SERIALIZATION()
2368 IMPLEMENT_JSON_DOCUMENTATION(NetworkAddressRxTx)
2369
2370 public:
2373
2376
2378 {
2379 clear();
2380 }
2381
2382 void clear()
2383 {
2384 rx.clear();
2385 tx.clear();
2386 }
2387 };
2388
2389 static void to_json(nlohmann::json& j, const NetworkAddressRxTx& p)
2390 {
2391 j = nlohmann::json{
2392 TOJSON_IMPL(rx),
2393 TOJSON_IMPL(tx)
2394 };
2395 }
2396 static void from_json(const nlohmann::json& j, NetworkAddressRxTx& p)
2397 {
2398 p.clear();
2399 getOptional<NetworkAddress>("rx", p.rx, j);
2400 getOptional<NetworkAddress>("tx", p.tx, j);
2401 }
2402
2404 typedef enum
2405 {
2408
2410 graptStrict = 1
2411 } GroupRestrictionAccessPolicyType_t;
2412
2413 static bool isValidGroupRestrictionAccessPolicyType(GroupRestrictionAccessPolicyType_t t)
2414 {
2415 return (t == GroupRestrictionAccessPolicyType_t::graptPermissive ||
2416 t == GroupRestrictionAccessPolicyType_t::graptStrict );
2417 }
2418
2420 typedef enum
2421 {
2424
2427
2429 rtBlacklist = 2
2430 } RestrictionType_t;
2431
2432 static bool isValidRestrictionType(RestrictionType_t t)
2433 {
2434 return (t == RestrictionType_t::rtUndefined ||
2435 t == RestrictionType_t::rtWhitelist ||
2436 t == RestrictionType_t::rtBlacklist );
2437 }
2438
2463
2464 static bool isValidRestrictionElementType(RestrictionElementType_t t)
2465 {
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);
2473 }
2474
2475
2476 //-----------------------------------------------------------
2477 JSON_SERIALIZED_CLASS(NetworkAddressRestrictionList)
2489 {
2490 IMPLEMENT_JSON_SERIALIZATION()
2491 IMPLEMENT_JSON_DOCUMENTATION(NetworkAddressRestrictionList)
2492
2493 public:
2496
2498 std::vector<NetworkAddressRxTx> elements;
2499
2501 {
2502 clear();
2503 }
2504
2505 void clear()
2506 {
2507 type = RestrictionType_t::rtUndefined;
2508 elements.clear();
2509 }
2510 };
2511
2512 static void to_json(nlohmann::json& j, const NetworkAddressRestrictionList& p)
2513 {
2514 j = nlohmann::json{
2515 TOJSON_IMPL(type),
2516 TOJSON_IMPL(elements)
2517 };
2518 }
2519 static void from_json(const nlohmann::json& j, NetworkAddressRestrictionList& p)
2520 {
2521 p.clear();
2522 getOptional<RestrictionType_t>("type", p.type, j, RestrictionType_t::rtUndefined);
2523 getOptional<std::vector<NetworkAddressRxTx>>("elements", p.elements, j);
2524 }
2525
2526 //-----------------------------------------------------------
2527 JSON_SERIALIZED_CLASS(StringRestrictionList)
2539 {
2540 IMPLEMENT_JSON_SERIALIZATION()
2541 IMPLEMENT_JSON_DOCUMENTATION(StringRestrictionList)
2542
2543 public:
2546
2549
2551 std::vector<std::string> elements;
2552
2554 {
2555 type = RestrictionType_t::rtUndefined;
2556 elementsType = RestrictionElementType_t::retGroupId;
2557 clear();
2558 }
2559
2560 void clear()
2561 {
2562 elements.clear();
2563 }
2564 };
2565
2566 static void to_json(nlohmann::json& j, const StringRestrictionList& p)
2567 {
2568 j = nlohmann::json{
2569 TOJSON_IMPL(type),
2570 TOJSON_IMPL(elementsType),
2571 TOJSON_IMPL(elements)
2572 };
2573 }
2574 static void from_json(const nlohmann::json& j, StringRestrictionList& p)
2575 {
2576 p.clear();
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);
2580 }
2581
2582
2583 //-----------------------------------------------------------
2584 JSON_SERIALIZED_CLASS(PacketCapturer)
2594 {
2595 IMPLEMENT_JSON_SERIALIZATION()
2596 IMPLEMENT_JSON_DOCUMENTATION(PacketCapturer)
2597
2598 public:
2599 bool enabled;
2600 uint32_t maxMb;
2601 std::string filePrefix;
2602
2604 {
2605 clear();
2606 }
2607
2608 void clear()
2609 {
2610 enabled = false;
2611 maxMb = 10;
2612 filePrefix.clear();
2613 }
2614 };
2615
2616 static void to_json(nlohmann::json& j, const PacketCapturer& p)
2617 {
2618 j = nlohmann::json{
2619 TOJSON_IMPL(enabled),
2620 TOJSON_IMPL(maxMb),
2621 TOJSON_IMPL(filePrefix)
2622 };
2623 }
2624 static void from_json(const nlohmann::json& j, PacketCapturer& p)
2625 {
2626 p.clear();
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);
2630 }
2631
2632
2633 //-----------------------------------------------------------
2634 JSON_SERIALIZED_CLASS(TransportImpairment)
2644 {
2645 IMPLEMENT_JSON_SERIALIZATION()
2646 IMPLEMENT_JSON_DOCUMENTATION(TransportImpairment)
2647
2648 public:
2649 int applicationPercentage;
2650 int jitterMs;
2651 int lossPercentage;
2654
2656 {
2657 clear();
2658 }
2659
2660 void clear()
2661 {
2662 applicationPercentage = 0;
2663 jitterMs = 0;
2664 lossPercentage = 0;
2665 errorPercentage = 0;
2666 }
2667 };
2668
2669 static void to_json(nlohmann::json& j, const TransportImpairment& p)
2670 {
2671 j = nlohmann::json{
2672 TOJSON_IMPL(applicationPercentage),
2673 TOJSON_IMPL(jitterMs),
2674 TOJSON_IMPL(lossPercentage),
2675 TOJSON_IMPL(errorPercentage)
2676 };
2677 }
2678 static void from_json(const nlohmann::json& j, TransportImpairment& p)
2679 {
2680 p.clear();
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);
2685 }
2686
2687 //-----------------------------------------------------------
2688 JSON_SERIALIZED_CLASS(NsmNetworking)
2701 {
2702 IMPLEMENT_JSON_SERIALIZATION()
2703 IMPLEMENT_JSON_DOCUMENTATION(NsmNetworking)
2704
2705 public:
2706 std::string address;
2707 int port;
2708 int ttl;
2709 TxPriority_t priority;
2710 int txOversend;
2711 TransportImpairment rxImpairment;
2712 TransportImpairment txImpairment;
2713 std::string cryptoPassword;
2714 int maxUdpPayloadBytes;
2715
2717 {
2718 clear();
2719 }
2720
2721 void clear()
2722 {
2723 address.clear();
2724 port = 0;
2725 ttl = 1;
2726 priority = TxPriority_t::priVoice;
2727 txOversend = 0;
2728 rxImpairment.clear();
2729 txImpairment.clear();
2730 cryptoPassword.clear();
2731 maxUdpPayloadBytes = 800;
2732 }
2733 };
2734
2735 static void to_json(nlohmann::json& j, const NsmNetworking& p)
2736 {
2737 nlohmann::json pathJson;
2738 to_json(pathJson, p.address);
2739 j = nlohmann::json{
2740 TOJSON_IMPL(port),
2741 TOJSON_IMPL(ttl),
2742 TOJSON_IMPL(priority),
2743 TOJSON_IMPL(txOversend),
2744 TOJSON_IMPL(rxImpairment),
2745 TOJSON_IMPL(txImpairment),
2746 TOJSON_IMPL(cryptoPassword),
2747 TOJSON_IMPL(maxUdpPayloadBytes)
2748 };
2749 }
2750 static void from_json(const nlohmann::json& j, NsmNetworking& p)
2751 {
2752 p.clear();
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);
2762 }
2763
2764 //-----------------------------------------------------------
2765 JSON_SERIALIZED_CLASS(NsmNodeResource)
2772 {
2773 IMPLEMENT_JSON_SERIALIZATION()
2774 IMPLEMENT_JSON_DOCUMENTATION(NsmNodeResource)
2775
2776 public:
2778 std::string id;
2781
2783 {
2784 clear();
2785 }
2786
2787 void clear()
2788 {
2789 id.clear();
2790 priority = -1;
2791 }
2792 };
2793
2794 static void to_json(nlohmann::json& j, const NsmNodeResource& p)
2795 {
2796 j = nlohmann::json{
2797 TOJSON_IMPL(id),
2798 TOJSON_IMPL(priority)
2799 };
2800 }
2801 static void from_json(const nlohmann::json& j, NsmNodeResource& p)
2802 {
2803 p.clear();
2804 getOptional<std::string>("id", p.id, j);
2805 getOptional<int>("priority", p.priority, j, -1);
2806 }
2807
2809 static void nsmConfigurationResourcesFromJson(const nlohmann::json& j, std::vector<NsmNodeResource>& out)
2810 {
2811 out.clear();
2812 if (!j.contains("resources") || !j["resources"].is_array())
2813 {
2814 return;
2815 }
2816 for (const auto& el : j["resources"])
2817 {
2818 if (!el.is_object())
2819 {
2820 continue;
2821 }
2822 NsmNodeResource nr;
2823 nr.clear();
2824 getOptional<std::string>("id", nr.id, el);
2825 getOptional<int>("priority", nr.priority, el, -1);
2826 if (!nr.id.empty())
2827 {
2828 out.push_back(nr);
2829 }
2830 }
2831 }
2832
2833
2834 //-----------------------------------------------------------
2835 JSON_SERIALIZED_CLASS(NsmConfiguration)
2845 {
2846 IMPLEMENT_JSON_SERIALIZATION()
2847 IMPLEMENT_JSON_DOCUMENTATION(NsmConfiguration)
2848
2849 public:
2850
2851 std::string id;
2852 bool favorUptime;
2853 NsmNetworking networking;
2854 std::vector<NsmNodeResource> resources;
2855 int tokenStart;
2856 int tokenEnd;
2857 int intervalSecs;
2858 int transitionSecsFactor;
2863 bool logCommandOutput;
2864
2866 {
2867 clear();
2868 }
2869
2870 void clear()
2871 {
2872 id.clear();
2873 favorUptime = false;
2874 networking.clear();
2875 resources.clear();
2876 tokenStart = 1000000;
2877 tokenEnd = 2000000;
2878 intervalSecs = 1;
2879 transitionSecsFactor = 3;
2880 internalMultiplier = 1;
2881 goingActiveRandomDelayMs = 500;
2882 logCommandOutput = false;
2883 }
2884 };
2885
2886 static void to_json(nlohmann::json& j, const NsmConfiguration& p)
2887 {
2888 j = nlohmann::json{
2889 TOJSON_IMPL(id),
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),
2900 };
2901 }
2902 static void from_json(const nlohmann::json& j, NsmConfiguration& p)
2903 {
2904 p.clear();
2905 getOptional("id", p.id, j);
2906 getOptional<bool>("favorUptime", p.favorUptime, j, false);
2907 getOptional<NsmNetworking>("networking", p.networking, j);
2908 nsmConfigurationResourcesFromJson(j, p.resources);
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);
2916 }
2917
2918
2919 //-----------------------------------------------------------
2920 JSON_SERIALIZED_CLASS(Rallypoint)
2929 {
2930 IMPLEMENT_JSON_SERIALIZATION()
2931 IMPLEMENT_JSON_DOCUMENTATION(Rallypoint)
2932
2933 public:
2938 typedef enum
2939 {
2941 rppTlsTcp = 0,
2942
2944 rppTlsWs = 1,
2945
2947 rppInvalid = -1
2948 } RpProtocol_t;
2949
2955
2967 std::string certificate;
2968
2980 std::string certificateKey;
2981
2986
2991
2995 std::vector<std::string> caCertificates;
2996
3001
3006
3009
3012
3018 std::string sni;
3019
3020
3023
3025 std::string path;
3026
3029
3030
3031 Rallypoint()
3032 {
3033 clear();
3034 }
3035
3036 void clear()
3037 {
3038 host.clear();
3039 certificate.clear();
3040 certificateKey.clear();
3041 caCertificates.clear();
3042 verifyPeer = false;
3043 transactionTimeoutMs = 0;
3044 disableMessageSigning = false;
3045 connectionTimeoutSecs = 0;
3046 tcpTxOptions.clear();
3047 sni.clear();
3048 protocol = rppTlsTcp;
3049 path.clear();
3050 additionalProtocols.clear();
3051 }
3052
3053 bool matches(const Rallypoint& other)
3054 {
3055 if(!host.matches(other.host))
3056 {
3057 return false;
3058 }
3059
3060 if(protocol != other.protocol)
3061 {
3062 return false;
3063 }
3064
3065 if(path.compare(other.path) != 0)
3066 {
3067 return false;
3068 }
3069
3070 if(certificate.compare(other.certificate) != 0)
3071 {
3072 return false;
3073 }
3074
3075 if(certificateKey.compare(other.certificateKey) != 0)
3076 {
3077 return false;
3078 }
3079
3080 if(verifyPeer != other.verifyPeer)
3081 {
3082 return false;
3083 }
3084
3085 if(allowSelfSignedCertificate != other.allowSelfSignedCertificate)
3086 {
3087 return false;
3088 }
3089
3090 if(caCertificates.size() != other.caCertificates.size())
3091 {
3092 return false;
3093 }
3094
3095 for(size_t x = 0; x < caCertificates.size(); x++)
3096 {
3097 bool found = false;
3098
3099 for(size_t y = 0; y < other.caCertificates.size(); y++)
3100 {
3101 if(caCertificates[x].compare(other.caCertificates[y]) == 0)
3102 {
3103 found = true;
3104 break;
3105 }
3106 }
3107
3108 if(!found)
3109 {
3110 return false;
3111 }
3112 }
3113
3114 if(transactionTimeoutMs != other.transactionTimeoutMs)
3115 {
3116 return false;
3117 }
3118
3119 if(disableMessageSigning != other.disableMessageSigning)
3120 {
3121 return false;
3122 }
3123 if(connectionTimeoutSecs != other.connectionTimeoutSecs)
3124 {
3125 return false;
3126 }
3127 if(tcpTxOptions.priority != other.tcpTxOptions.priority)
3128 {
3129 return false;
3130 }
3131 if(sni.compare(other.sni) != 0)
3132 {
3133 return false;
3134 }
3135
3136 return true;
3137 }
3138 };
3139
3140 static void to_json(nlohmann::json& j, const Rallypoint& p)
3141 {
3142 j = nlohmann::json{
3143 TOJSON_IMPL(host),
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),
3153 TOJSON_IMPL(sni),
3154 TOJSON_IMPL(protocol),
3155 TOJSON_IMPL(path),
3156 TOJSON_IMPL(additionalProtocols)
3157 };
3158 }
3159
3160 static void from_json(const nlohmann::json& j, Rallypoint& p)
3161 {
3162 p.clear();
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);
3177 }
3178
3179 //-----------------------------------------------------------
3180 JSON_SERIALIZED_CLASS(RallypointCluster)
3192 {
3193 IMPLEMENT_JSON_SERIALIZATION()
3194 IMPLEMENT_JSON_DOCUMENTATION(RallypointCluster)
3195
3196 public:
3202 typedef enum
3203 {
3205 csRoundRobin = 0,
3206
3208 csFailback = 1
3209 } ConnectionStrategy_t;
3210
3213
3215 std::vector<Rallypoint> rallypoints;
3216
3219
3222
3225
3227 {
3228 clear();
3229 }
3230
3231 void clear()
3232 {
3233 connectionStrategy = csRoundRobin;
3234 rallypoints.clear();
3235 rolloverSecs = 10;
3236 connectionTimeoutSecs = 5;
3237 transactionTimeoutMs = 10000;
3238 }
3239 };
3240
3241 static void to_json(nlohmann::json& j, const RallypointCluster& p)
3242 {
3243 j = nlohmann::json{
3244 TOJSON_IMPL(connectionStrategy),
3245 TOJSON_IMPL(rallypoints),
3246 TOJSON_IMPL(rolloverSecs),
3247 TOJSON_IMPL(connectionTimeoutSecs),
3248 TOJSON_IMPL(transactionTimeoutMs)
3249 };
3250 }
3251 static void from_json(const nlohmann::json& j, RallypointCluster& p)
3252 {
3253 p.clear();
3254 getOptional<RallypointCluster::ConnectionStrategy_t>("connectionStrategy", p.connectionStrategy, j, 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);
3259 }
3260
3261
3262 //-----------------------------------------------------------
3263 JSON_SERIALIZED_CLASS(NetworkDeviceDescriptor)
3274 {
3275 IMPLEMENT_JSON_SERIALIZATION()
3276 IMPLEMENT_JSON_DOCUMENTATION(NetworkDeviceDescriptor)
3277
3278 public:
3284
3286 std::string name;
3287
3289 std::string manufacturer;
3290
3292 std::string model;
3293
3295 std::string hardwareId;
3296
3298 std::string serialNumber;
3299
3301 std::string type;
3302
3304 std::string extra;
3305
3307 {
3308 clear();
3309 }
3310
3311 void clear()
3312 {
3313 deviceId = 0;
3314
3315 name.clear();
3316 manufacturer.clear();
3317 model.clear();
3318 hardwareId.clear();
3319 serialNumber.clear();
3320 type.clear();
3321 extra.clear();
3322 }
3323
3324 virtual std::string toString()
3325 {
3326 char buff[2048];
3327
3328 snprintf(buff, sizeof(buff), "deviceId=%d, name=%s, manufacturer=%s, model=%s, hardwareId=%s, serialNumber=%s, type=%s, extra=%s",
3329 deviceId,
3330 name.c_str(),
3331 manufacturer.c_str(),
3332 model.c_str(),
3333 hardwareId.c_str(),
3334 serialNumber.c_str(),
3335 type.c_str(),
3336 extra.c_str());
3337
3338 return std::string(buff);
3339 }
3340 };
3341
3342 static void to_json(nlohmann::json& j, const NetworkDeviceDescriptor& p)
3343 {
3344 j = nlohmann::json{
3345 TOJSON_IMPL(deviceId),
3346 TOJSON_IMPL(name),
3347 TOJSON_IMPL(manufacturer),
3348 TOJSON_IMPL(model),
3349 TOJSON_IMPL(hardwareId),
3350 TOJSON_IMPL(serialNumber),
3351 TOJSON_IMPL(type),
3352 TOJSON_IMPL(extra)
3353 };
3354 }
3355 static void from_json(const nlohmann::json& j, NetworkDeviceDescriptor& p)
3356 {
3357 p.clear();
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);
3366 }
3367
3368 //-----------------------------------------------------------
3369 JSON_SERIALIZED_CLASS(AudioGate)
3379 {
3380 IMPLEMENT_JSON_SERIALIZATION()
3381 IMPLEMENT_JSON_DOCUMENTATION(AudioGate)
3382
3383 public:
3386
3389
3391 uint32_t hangMs;
3392
3394 uint32_t windowMin;
3395
3397 uint32_t windowMax;
3398
3401
3402
3403 AudioGate()
3404 {
3405 clear();
3406 }
3407
3408 void clear()
3409 {
3410 enabled = false;
3411 useVad = false;
3412 hangMs = 1500;
3413 windowMin = 25;
3414 windowMax = 125;
3415 coefficient = 1.75;
3416 }
3417 };
3418
3419 static void to_json(nlohmann::json& j, const AudioGate& p)
3420 {
3421 j = nlohmann::json{
3422 TOJSON_IMPL(enabled),
3423 TOJSON_IMPL(useVad),
3424 TOJSON_IMPL(hangMs),
3425 TOJSON_IMPL(windowMin),
3426 TOJSON_IMPL(windowMax),
3427 TOJSON_IMPL(coefficient)
3428 };
3429 }
3430 static void from_json(const nlohmann::json& j, AudioGate& p)
3431 {
3432 p.clear();
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);
3439 }
3440
3441 //-----------------------------------------------------------
3442 JSON_SERIALIZED_CLASS(TxAudio)
3456 {
3457 IMPLEMENT_JSON_SERIALIZATION()
3458 IMPLEMENT_JSON_DOCUMENTATION(TxAudio)
3459
3460 public:
3466 typedef enum
3467 {
3469 ctExternal = -1,
3470
3472 ctUnknown = 0,
3473
3474 /* G.711 */
3476 ctG711ulaw = 1,
3477
3479 ctG711alaw = 2,
3480
3481
3482 /* GSM */
3484 ctGsm610 = 3,
3485
3486
3487 /* G.729 */
3489 ctG729a = 4,
3490
3491
3492 /* PCM */
3494 ctPcm = 5,
3495
3496 // AMR Narrowband */
3498 ctAmrNb4750 = 10,
3499
3501 ctAmrNb5150 = 11,
3502
3504 ctAmrNb5900 = 12,
3505
3507 ctAmrNb6700 = 13,
3508
3510 ctAmrNb7400 = 14,
3511
3513 ctAmrNb7950 = 15,
3514
3516 ctAmrNb10200 = 16,
3517
3519 ctAmrNb12200 = 17,
3520
3521
3522 /* Opus */
3524 ctOpus6000 = 20,
3525
3527 ctOpus8000 = 21,
3528
3530 ctOpus10000 = 22,
3531
3533 ctOpus12000 = 23,
3534
3536 ctOpus14000 = 24,
3537
3539 ctOpus16000 = 25,
3540
3542 ctOpus18000 = 26,
3543
3545 ctOpus20000 = 27,
3546
3548 ctOpus22000 = 28,
3549
3551 ctOpus24000 = 29,
3552
3553
3554 /* Speex */
3556 ctSpxNb2150 = 30,
3557
3559 ctSpxNb3950 = 31,
3560
3562 ctSpxNb5950 = 32,
3563
3565 ctSpxNb8000 = 33,
3566
3568 ctSpxNb11000 = 34,
3569
3571 ctSpxNb15000 = 35,
3572
3574 ctSpxNb18200 = 36,
3575
3577 ctSpxNb24600 = 37,
3578
3579
3580 /* Codec2 */
3582 ctC2450 = 40,
3583
3585 ctC2700 = 41,
3586
3588 ctC21200 = 42,
3589
3591 ctC21300 = 43,
3592
3594 ctC21400 = 44,
3595
3597 ctC21600 = 45,
3598
3600 ctC22400 = 46,
3601
3603 ctC23200 = 47,
3604
3605
3606 /* MELPe */
3608 ctMelpe600 = 50,
3609
3611 ctMelpe1200 = 51,
3612
3614 ctMelpe2400 = 52,
3615
3616 /* CVSD */
3618 ctCvsd = 60
3619 } TxCodec_t;
3620
3626 typedef enum
3627 {
3629 hetEngageStandard = 0,
3630
3632 hetNatoStanga5643 = 1
3633 } HeaderExtensionType_t;
3634
3637
3640
3642 std::string encoderName;
3643
3646
3649
3651 bool fdx;
3652
3660
3663
3670
3677
3680
3683
3686
3691
3693 uint32_t internalKey;
3694
3697
3700
3702 bool dtx;
3703
3706
3707 TxAudio()
3708 {
3709 clear();
3710 }
3711
3712 void clear()
3713 {
3714 enabled = true;
3715 encoder = TxAudio::TxCodec_t::ctUnknown;
3716 encoderName.clear();
3717 framingMs = 60;
3718 blockCount = 0;
3719 fdx = false;
3720 noHdrExt = false;
3721 maxTxSecs = 0;
3722 extensionSendInterval = 10;
3723 initialHeaderBurst = 5;
3724 trailingHeaderBurst = 5;
3725 startTxNotifications = 5;
3726 customRtpPayloadType = -1;
3727 internalKey = 0;
3728 resetRtpOnTx = true;
3729 enableSmoothing = true;
3730 dtx = false;
3731 smoothedHangTimeMs = 0;
3732 hdrExtType = HeaderExtensionType_t::hetEngageStandard;
3733 }
3734 };
3735
3736 static void to_json(nlohmann::json& j, const TxAudio& p)
3737 {
3738 j = nlohmann::json{
3739 TOJSON_IMPL(enabled),
3740 TOJSON_IMPL(encoder),
3741 TOJSON_IMPL(encoderName),
3742 TOJSON_IMPL(framingMs),
3743 TOJSON_IMPL(blockCount),
3744 TOJSON_IMPL(fdx),
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),
3754 TOJSON_IMPL(dtx),
3755 TOJSON_IMPL(smoothedHangTimeMs),
3756 TOJSON_IMPL(hdrExtType)
3757 };
3758
3759 // internalKey is not serialized
3760 }
3761 static void from_json(const nlohmann::json& j, TxAudio& p)
3762 {
3763 p.clear();
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);
3782
3783 // internalKey is not serialized
3784 }
3785
3786 //-----------------------------------------------------------
3787 JSON_SERIALIZED_CLASS(AudioRegistryDevice)
3798 {
3799 IMPLEMENT_JSON_SERIALIZATION()
3800 IMPLEMENT_JSON_DOCUMENTATION(AudioRegistryDevice)
3801
3802 public:
3804 std::string hardwareId;
3805
3808
3810 std::string name;
3811
3813 std::string manufacturer;
3814
3816 std::string model;
3817
3819 std::string serialNumber;
3820
3821
3823 std::string type;
3824
3826 std::string extra;
3827
3829 {
3830 clear();
3831 }
3832
3833 void clear()
3834 {
3835 hardwareId.clear();
3836 isDefault = false;
3837 name.clear();
3838 manufacturer.clear();
3839 model.clear();
3840 serialNumber.clear();
3841 type.clear();
3842 extra.clear();
3843 }
3844
3845 virtual std::string toString()
3846 {
3847 char buff[2048];
3848
3849 snprintf(buff, sizeof(buff), "hardwareId=%s, isDefault=%d, name=%s, manufacturer=%s, model=%s, serialNumber=%s, type=%s, extra=%s",
3850 hardwareId.c_str(),
3851 (int)isDefault,
3852 name.c_str(),
3853 manufacturer.c_str(),
3854 model.c_str(),
3855 serialNumber.c_str(),
3856 type.c_str(),
3857 extra.c_str());
3858
3859 return std::string(buff);
3860 }
3861 };
3862
3863 static void to_json(nlohmann::json& j, const AudioRegistryDevice& p)
3864 {
3865 j = nlohmann::json{
3866 TOJSON_IMPL(hardwareId),
3867 TOJSON_IMPL(isDefault),
3868 TOJSON_IMPL(name),
3869 TOJSON_IMPL(manufacturer),
3870 TOJSON_IMPL(model),
3871 TOJSON_IMPL(serialNumber),
3872 TOJSON_IMPL(type),
3873 TOJSON_IMPL(extra)
3874 };
3875 }
3876 static void from_json(const nlohmann::json& j, AudioRegistryDevice& p)
3877 {
3878 p.clear();
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);
3887 }
3888
3889
3890 //-----------------------------------------------------------
3891 JSON_SERIALIZED_CLASS(AudioRegistry)
3902 {
3903 IMPLEMENT_JSON_SERIALIZATION()
3904 IMPLEMENT_JSON_DOCUMENTATION(AudioRegistry)
3905
3906 public:
3908 std::vector<AudioRegistryDevice> inputs;
3909
3911 std::vector<AudioRegistryDevice> outputs;
3912
3914 {
3915 clear();
3916 }
3917
3918 void clear()
3919 {
3920 inputs.clear();
3921 outputs.clear();
3922 }
3923
3924 virtual std::string toString()
3925 {
3926 return std::string("");
3927 }
3928 };
3929
3930 static void to_json(nlohmann::json& j, const AudioRegistry& p)
3931 {
3932 j = nlohmann::json{
3933 TOJSON_IMPL(inputs),
3934 TOJSON_IMPL(outputs)
3935 };
3936 }
3937 static void from_json(const nlohmann::json& j, AudioRegistry& p)
3938 {
3939 p.clear();
3940 getOptional<std::vector<AudioRegistryDevice>>("inputs", p.inputs, j);
3941 getOptional<std::vector<AudioRegistryDevice>>("outputs", p.outputs, j);
3942 }
3943
3944 //-----------------------------------------------------------
3945 JSON_SERIALIZED_CLASS(AudioDeviceDescriptor)
3956 {
3957 IMPLEMENT_JSON_SERIALIZATION()
3958 IMPLEMENT_JSON_DOCUMENTATION(AudioDeviceDescriptor)
3959
3960 public:
3961
3963 typedef enum
3964 {
3966 dirUnknown = 0,
3967
3970
3973
3975 dirBoth
3976 } Direction_t;
3977
3983
3991
3999
4002
4010
4013
4015 std::string name;
4016
4018 std::string manufacturer;
4019
4021 std::string model;
4022
4024 std::string hardwareId;
4025
4027 std::string serialNumber;
4028
4031
4033 std::string type;
4034
4036 std::string extra;
4037
4040
4042 {
4043 clear();
4044 }
4045
4046 void clear()
4047 {
4048 deviceId = 0;
4049 samplingRate = 0;
4050 channels = 0;
4051 direction = dirUnknown;
4052 boostPercentage = 0;
4053 isAdad = false;
4054 isDefault = false;
4055
4056 name.clear();
4057 manufacturer.clear();
4058 model.clear();
4059 hardwareId.clear();
4060 serialNumber.clear();
4061 type.clear();
4062 extra.clear();
4063 isPresent = false;
4064 }
4065
4066 virtual std::string toString()
4067 {
4068 char buff[2048];
4069
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",
4071 deviceId,
4072 samplingRate,
4073 channels,
4074 (int)direction,
4075 boostPercentage,
4076 (int)isAdad,
4077 name.c_str(),
4078 manufacturer.c_str(),
4079 model.c_str(),
4080 hardwareId.c_str(),
4081 serialNumber.c_str(),
4082 (int)isDefault,
4083 type.c_str(),
4084 (int)isPresent,
4085 extra.c_str());
4086
4087 return std::string(buff);
4088 }
4089 };
4090
4091 static void to_json(nlohmann::json& j, const AudioDeviceDescriptor& p)
4092 {
4093 j = nlohmann::json{
4094 TOJSON_IMPL(deviceId),
4095 TOJSON_IMPL(samplingRate),
4096 TOJSON_IMPL(channels),
4097 TOJSON_IMPL(direction),
4098 TOJSON_IMPL(boostPercentage),
4099 TOJSON_IMPL(isAdad),
4100 TOJSON_IMPL(name),
4101 TOJSON_IMPL(manufacturer),
4102 TOJSON_IMPL(model),
4103 TOJSON_IMPL(hardwareId),
4104 TOJSON_IMPL(serialNumber),
4105 TOJSON_IMPL(isDefault),
4106 TOJSON_IMPL(type),
4107 TOJSON_IMPL(extra),
4108 TOJSON_IMPL(isPresent)
4109 };
4110 }
4111 static void from_json(const nlohmann::json& j, AudioDeviceDescriptor& p)
4112 {
4113 p.clear();
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);
4120
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);
4131 }
4132
4133 //-----------------------------------------------------------
4134 JSON_SERIALIZED_CLASS(ListOfAudioDeviceDescriptor)
4136 {
4137 IMPLEMENT_JSON_SERIALIZATION()
4138 IMPLEMENT_JSON_DOCUMENTATION(ListOfAudioDeviceDescriptor)
4139
4140 public:
4141 std::vector<AudioDeviceDescriptor> list;
4142
4144 {
4145 clear();
4146 }
4147
4148 void clear()
4149 {
4150 list.clear();
4151 }
4152 };
4153
4154 static void to_json(nlohmann::json& j, const ListOfAudioDeviceDescriptor& p)
4155 {
4156 j = nlohmann::json{
4157 TOJSON_IMPL(list)
4158 };
4159 }
4160 static void from_json(const nlohmann::json& j, ListOfAudioDeviceDescriptor& p)
4161 {
4162 p.clear();
4163 getOptional<std::vector<AudioDeviceDescriptor>>("list", p.list, j);
4164 }
4165
4166 //-----------------------------------------------------------
4167 JSON_SERIALIZED_CLASS(Audio)
4176 {
4177 IMPLEMENT_JSON_SERIALIZATION()
4178 IMPLEMENT_JSON_DOCUMENTATION(Audio)
4179
4180 public:
4183
4186
4188 std::string inputHardwareId;
4189
4192
4195
4197 std::string outputHardwareId;
4198
4201
4204
4207
4210
4211 Audio()
4212 {
4213 clear();
4214 }
4215
4216 void clear()
4217 {
4218 enabled = true;
4219 inputId = 0;
4220 inputHardwareId.clear();
4221 inputGain = 0;
4222 outputId = 0;
4223 outputHardwareId.clear();
4224 outputGain = 0;
4225 outputLevelLeft = 100;
4226 outputLevelRight = 100;
4227 outputMuted = false;
4228 }
4229 };
4230
4231 static void to_json(nlohmann::json& j, const Audio& p)
4232 {
4233 j = nlohmann::json{
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)
4243 };
4244 }
4245 static void from_json(const nlohmann::json& j, Audio& p)
4246 {
4247 p.clear();
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);
4258 }
4259
4260 //-----------------------------------------------------------
4261 JSON_SERIALIZED_CLASS(TalkerInformation)
4272 {
4273 IMPLEMENT_JSON_SERIALIZATION()
4274 IMPLEMENT_JSON_DOCUMENTATION(TalkerInformation)
4275
4276 public:
4280 typedef enum
4281 {
4283 matNone = 0,
4284
4286 matAnonymous = 1,
4287
4289 matSsrcGenerated = 2
4290 } ManufacturedAliasType_t;
4291
4293 std::string alias;
4294
4296 std::string nodeId;
4297
4299 uint16_t rxFlags;
4300
4303
4305 uint32_t txId;
4306
4309
4312
4315
4317 uint32_t ssrc;
4318
4321
4323 {
4324 clear();
4325 }
4326
4327 void clear()
4328 {
4329 alias.clear();
4330 nodeId.clear();
4331 rxFlags = 0;
4332 txPriority = 0;
4333 txId = 0;
4334 duplicateCount = 0;
4335 aliasSpecializer = 0;
4336 rxMuted = false;
4337 manufacturedAliasType = ManufacturedAliasType_t::matNone;
4338 ssrc = 0;
4339 }
4340 };
4341
4342 static void to_json(nlohmann::json& j, const TalkerInformation& p)
4343 {
4344 j = nlohmann::json{
4345 TOJSON_IMPL(alias),
4346 TOJSON_IMPL(nodeId),
4347 TOJSON_IMPL(rxFlags),
4348 TOJSON_IMPL(txPriority),
4349 TOJSON_IMPL(txId),
4350 TOJSON_IMPL(duplicateCount),
4351 TOJSON_IMPL(aliasSpecializer),
4352 TOJSON_IMPL(rxMuted),
4353 TOJSON_IMPL(manufacturedAliasType),
4354 TOJSON_IMPL(ssrc)
4355 };
4356 }
4357 static void from_json(const nlohmann::json& j, TalkerInformation& p)
4358 {
4359 p.clear();
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);
4370 }
4371
4372 //-----------------------------------------------------------
4373 JSON_SERIALIZED_CLASS(GroupTalkers)
4386 {
4387 IMPLEMENT_JSON_SERIALIZATION()
4388 IMPLEMENT_JSON_DOCUMENTATION(GroupTalkers)
4389
4390 public:
4392 std::vector<TalkerInformation> list;
4393
4394 GroupTalkers()
4395 {
4396 clear();
4397 }
4398
4399 void clear()
4400 {
4401 list.clear();
4402 }
4403 };
4404
4405 static void to_json(nlohmann::json& j, const GroupTalkers& p)
4406 {
4407 j = nlohmann::json{
4408 TOJSON_IMPL(list)
4409 };
4410 }
4411 static void from_json(const nlohmann::json& j, GroupTalkers& p)
4412 {
4413 p.clear();
4414 getOptional<std::vector<TalkerInformation>>("list", p.list, j);
4415 }
4416
4417 //-----------------------------------------------------------
4418 JSON_SERIALIZED_CLASS(Presence)
4429 {
4430 IMPLEMENT_JSON_SERIALIZATION()
4431 IMPLEMENT_JSON_DOCUMENTATION(Presence)
4432
4433 public:
4437 typedef enum
4438 {
4440 pfUnknown = 0,
4441
4443 pfEngage = 1,
4444
4451 pfCot = 2
4452 } Format_t;
4453
4456
4459
4462
4465
4468
4469 Presence()
4470 {
4471 clear();
4472 }
4473
4474 void clear()
4475 {
4476 format = pfUnknown;
4477 intervalSecs = 30;
4478 listenOnly = false;
4479 minIntervalSecs = 5;
4480 reduceImmediacy = false;
4481 }
4482 };
4483
4484 static void to_json(nlohmann::json& j, const Presence& p)
4485 {
4486 j = nlohmann::json{
4487 TOJSON_IMPL(format),
4488 TOJSON_IMPL(intervalSecs),
4489 TOJSON_IMPL(listenOnly),
4490 TOJSON_IMPL(minIntervalSecs),
4491 TOJSON_IMPL(reduceImmediacy)
4492 };
4493 }
4494 static void from_json(const nlohmann::json& j, Presence& p)
4495 {
4496 p.clear();
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);
4502 }
4503
4504
4505 //-----------------------------------------------------------
4506 JSON_SERIALIZED_CLASS(Advertising)
4517 {
4518 IMPLEMENT_JSON_SERIALIZATION()
4519 IMPLEMENT_JSON_DOCUMENTATION(Advertising)
4520
4521 public:
4524
4527
4530
4531 Advertising()
4532 {
4533 clear();
4534 }
4535
4536 void clear()
4537 {
4538 enabled = false;
4539 intervalMs = 20000;
4540 alwaysAdvertise = false;
4541 }
4542 };
4543
4544 static void to_json(nlohmann::json& j, const Advertising& p)
4545 {
4546 j = nlohmann::json{
4547 TOJSON_IMPL(enabled),
4548 TOJSON_IMPL(intervalMs),
4549 TOJSON_IMPL(alwaysAdvertise)
4550 };
4551 }
4552 static void from_json(const nlohmann::json& j, Advertising& p)
4553 {
4554 p.clear();
4555 getOptional("enabled", p.enabled, j, false);
4556 getOptional<int>("intervalMs", p.intervalMs, j, 20000);
4557 getOptional<bool>("alwaysAdvertise", p.alwaysAdvertise, j, false);
4558 }
4559
4560 //-----------------------------------------------------------
4561 JSON_SERIALIZED_CLASS(GroupPriorityTranslation)
4572 {
4573 IMPLEMENT_JSON_SERIALIZATION()
4574 IMPLEMENT_JSON_DOCUMENTATION(GroupPriorityTranslation)
4575
4576 public:
4579
4582
4585
4587 {
4588 clear();
4589 }
4590
4591 void clear()
4592 {
4593 rx.clear();
4594 tx.clear();
4595 priority = 0;
4596 }
4597 };
4598
4599 static void to_json(nlohmann::json& j, const GroupPriorityTranslation& p)
4600 {
4601 j = nlohmann::json{
4602 TOJSON_IMPL(rx),
4603 TOJSON_IMPL(tx),
4604 TOJSON_IMPL(priority)
4605 };
4606 }
4607 static void from_json(const nlohmann::json& j, GroupPriorityTranslation& p)
4608 {
4609 p.clear();
4610 j.at("rx").get_to(p.rx);
4611 j.at("tx").get_to(p.tx);
4612 FROMJSON_IMPL(priority, int, 0);
4613 }
4614
4615 //-----------------------------------------------------------
4616 JSON_SERIALIZED_CLASS(GroupTimeline)
4629 {
4630 IMPLEMENT_JSON_SERIALIZATION()
4631 IMPLEMENT_JSON_DOCUMENTATION(GroupTimeline)
4632
4633 public:
4636
4639 bool recordAudio;
4640
4642 {
4643 clear();
4644 }
4645
4646 void clear()
4647 {
4648 enabled = true;
4649 maxAudioTimeMs = 30000;
4650 recordAudio = true;
4651 }
4652 };
4653
4654 static void to_json(nlohmann::json& j, const GroupTimeline& p)
4655 {
4656 j = nlohmann::json{
4657 TOJSON_IMPL(enabled),
4658 TOJSON_IMPL(maxAudioTimeMs),
4659 TOJSON_IMPL(recordAudio)
4660 };
4661 }
4662 static void from_json(const nlohmann::json& j, GroupTimeline& p)
4663 {
4664 p.clear();
4665 getOptional("enabled", p.enabled, j, true);
4666 getOptional<int>("maxAudioTimeMs", p.maxAudioTimeMs, j, 30000);
4667 getOptional("recordAudio", p.recordAudio, j, true);
4668 }
4669
4677 ENGAGE_IGNORE_COMPILER_UNUSED_WARNING static const char *GROUP_SOURCE_ENGAGE_INTERNAL = "com.rallytac.engage.internal";
4679 ENGAGE_IGNORE_COMPILER_UNUSED_WARNING static const char *GROUP_SOURCE_ENGAGE_MAGELLAN_CORE = "com.rallytac.magellan.core";
4681 ENGAGE_IGNORE_COMPILER_UNUSED_WARNING static const char *GROUP_SOURCE_ENGAGE_MAGELLAN_CISTECH = "com.rallytac.engage.magellan.cistech";
4683 ENGAGE_IGNORE_COMPILER_UNUSED_WARNING static const char *GROUP_SOURCE_ENGAGE_MAGELLAN_TRELLISWARE = "com.rallytac.engage.magellan.trellisware";
4685 ENGAGE_IGNORE_COMPILER_UNUSED_WARNING static const char *GROUP_SOURCE_ENGAGE_MAGELLAN_SILVUS = "com.rallytac.engage.magellan.silvus";
4687 ENGAGE_IGNORE_COMPILER_UNUSED_WARNING static const char *GROUP_SOURCE_ENGAGE_MAGELLAN_PERSISTENT = "com.rallytac.engage.magellan.persistent";
4689 ENGAGE_IGNORE_COMPILER_UNUSED_WARNING static const char *GROUP_SOURCE_ENGAGE_MAGELLAN_DOMO = "com.rallytac.engage.magellan.domo";
4691 ENGAGE_IGNORE_COMPILER_UNUSED_WARNING static const char *GROUP_SOURCE_ENGAGE_MAGELLAN_KENWOOD = "com.rallytac.engage.magellan.kenwood";
4693 ENGAGE_IGNORE_COMPILER_UNUSED_WARNING static const char *GROUP_SOURCE_ENGAGE_MAGELLAN_TAIT = "com.rallytac.engage.magellan.tait";
4695 ENGAGE_IGNORE_COMPILER_UNUSED_WARNING static const char *GROUP_SOURCE_ENGAGE_MAGELLAN_VOCALITY = "com.rallytac.engage.magellan.vocality";
4716
4741
4757 //-----------------------------------------------------------
4758 JSON_SERIALIZED_CLASS(GroupAppTransport)
4769 {
4770 IMPLEMENT_JSON_SERIALIZATION()
4771 IMPLEMENT_JSON_DOCUMENTATION(GroupAppTransport)
4772
4773 public:
4776
4778 std::string id;
4779
4781 {
4782 clear();
4783 }
4784
4785 void clear()
4786 {
4787 enabled = false;
4788 id.clear();
4789 }
4790 };
4791
4792 static void to_json(nlohmann::json& j, const GroupAppTransport& p)
4793 {
4794 j = nlohmann::json{
4795 TOJSON_IMPL(enabled),
4796 TOJSON_IMPL(id)
4797 };
4798 }
4799 static void from_json(const nlohmann::json& j, GroupAppTransport& p)
4800 {
4801 p.clear();
4802 getOptional<bool>("enabled", p.enabled, j, false);
4803 getOptional<std::string>("id", p.id, j);
4804 }
4805
4806 //-----------------------------------------------------------
4807 JSON_SERIALIZED_CLASS(RtpProfile)
4818 {
4819 IMPLEMENT_JSON_SERIALIZATION()
4820 IMPLEMENT_JSON_DOCUMENTATION(RtpProfile)
4821
4822 public:
4828 typedef enum
4829 {
4831 jmStandard = 0,
4832
4834 jmLowLatency = 1,
4835
4837 jmReleaseOnTxEnd = 2
4838 } JitterMode_t;
4839
4842
4845
4848
4851
4854
4857
4860
4863
4866
4869
4872
4875
4878
4881
4884
4887
4891
4892 RtpProfile()
4893 {
4894 clear();
4895 }
4896
4897 void clear()
4898 {
4899 mode = jmStandard;
4900 jitterMaxMs = 10000;
4901 jitterMinMs = 100;
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);
4916 }
4917 };
4918
4919 static void to_json(nlohmann::json& j, const RtpProfile& p)
4920 {
4921 j = nlohmann::json{
4922 TOJSON_IMPL(mode),
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)
4939 };
4940 }
4941 static void from_json(const nlohmann::json& j, RtpProfile& p)
4942 {
4943 p.clear();
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));
4961 }
4962
4963 //-----------------------------------------------------------
4964 JSON_SERIALIZED_CLASS(Tls)
4975 {
4976 IMPLEMENT_JSON_SERIALIZATION()
4977 IMPLEMENT_JSON_DOCUMENTATION(Tls)
4978
4979 public:
4980
4983
4986
4988 std::vector<std::string> caCertificates;
4989
4992
4995
4997 std::vector<std::string> crlSerials;
4998
4999 Tls()
5000 {
5001 clear();
5002 }
5003
5004 void clear()
5005 {
5006 verifyPeers = true;
5007 allowSelfSignedCertificates = false;
5008 caCertificates.clear();
5009 subjectRestrictions.clear();
5010 issuerRestrictions.clear();
5011 crlSerials.clear();
5012 }
5013 };
5014
5015 static void to_json(nlohmann::json& j, const Tls& p)
5016 {
5017 j = nlohmann::json{
5018 TOJSON_IMPL(verifyPeers),
5019 TOJSON_IMPL(allowSelfSignedCertificates),
5020 TOJSON_IMPL(caCertificates),
5021 TOJSON_IMPL(subjectRestrictions),
5022 TOJSON_IMPL(issuerRestrictions),
5023 TOJSON_IMPL(crlSerials)
5024 };
5025 }
5026 static void from_json(const nlohmann::json& j, Tls& p)
5027 {
5028 p.clear();
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);
5035 }
5036
5037 //-----------------------------------------------------------
5038 JSON_SERIALIZED_CLASS(RangerPackets)
5051 {
5052 IMPLEMENT_JSON_SERIALIZATION()
5053 IMPLEMENT_JSON_DOCUMENTATION(RangerPackets)
5054
5055 public:
5058
5061
5063 {
5064 clear();
5065 }
5066
5067 void clear()
5068 {
5069 hangTimerSecs = -1;
5070 count = 5;
5071 }
5072
5073 virtual void initForDocumenting()
5074 {
5075 }
5076 };
5077
5078 static void to_json(nlohmann::json& j, const RangerPackets& p)
5079 {
5080 j = nlohmann::json{
5081 TOJSON_IMPL(hangTimerSecs),
5082 TOJSON_IMPL(count)
5083 };
5084 }
5085 static void from_json(const nlohmann::json& j, RangerPackets& p)
5086 {
5087 p.clear();
5088 getOptional<int>("hangTimerSecs", p.hangTimerSecs, j, 11);
5089 getOptional<int>("count", p.count, j, 5);
5090 }
5091
5092 //-----------------------------------------------------------
5093 JSON_SERIALIZED_CLASS(Source)
5106 {
5107 IMPLEMENT_JSON_SERIALIZATION()
5108 IMPLEMENT_JSON_DOCUMENTATION(Source)
5109
5110 public:
5112 std::string nodeId;
5113
5114 /* NOTE: Not serialized ! */
5115 uint8_t _internal_binary_nodeId[ENGAGE_MAX_NODE_ID_SIZE];
5116
5118 std::string alias;
5119
5120 /* NOTE: Not serialized ! */
5121 uint8_t _internal_binary_alias[ENGAGE_MAX_ALIAS_SIZE];
5122
5123 Source()
5124 {
5125 clear();
5126 }
5127
5128 void clear()
5129 {
5130 nodeId.clear();
5131 memset(_internal_binary_nodeId, 0, sizeof(_internal_binary_nodeId));
5132
5133 alias.clear();
5134 memset(_internal_binary_alias, 0, sizeof(_internal_binary_alias));
5135 }
5136
5137 virtual void initForDocumenting()
5138 {
5139 }
5140 };
5141
5142 static void to_json(nlohmann::json& j, const Source& p)
5143 {
5144 j = nlohmann::json{
5145 TOJSON_IMPL(nodeId),
5146 TOJSON_IMPL(alias)
5147 };
5148 }
5149 static void from_json(const nlohmann::json& j, Source& p)
5150 {
5151 p.clear();
5152 FROMJSON_IMPL_SIMPLE(nodeId);
5153 FROMJSON_IMPL_SIMPLE(alias);
5154 }
5155
5156 //-----------------------------------------------------------
5157 JSON_SERIALIZED_CLASS(GroupBridgeTargetOutputDetail)
5170 {
5171 IMPLEMENT_JSON_SERIALIZATION()
5172 IMPLEMENT_JSON_DOCUMENTATION(GroupBridgeTargetOutputDetail)
5173
5174 public:
5176 typedef enum
5177 {
5181 bomRaw = 0,
5182
5185 bomMultistream = 1,
5186
5189 bomMixedStream = 2,
5190
5192 bomNone = 3
5193 } BridgingOpMode_t;
5194
5197
5200
5202 {
5203 clear();
5204 }
5205
5206 void clear()
5207 {
5208 mode = BridgingOpMode_t::bomRaw;
5209 mixedStreamTxParams.clear();
5210 }
5211
5212 virtual void initForDocumenting()
5213 {
5214 clear();
5215 }
5216 };
5217
5218 static void to_json(nlohmann::json& j, const GroupBridgeTargetOutputDetail& p)
5219 {
5220 j = nlohmann::json{
5221 TOJSON_IMPL(mode),
5222 TOJSON_IMPL(mixedStreamTxParams)
5223 };
5224 }
5225 static void from_json(const nlohmann::json& j, GroupBridgeTargetOutputDetail& p)
5226 {
5227 p.clear();
5228 FROMJSON_IMPL_SIMPLE(mode);
5229 FROMJSON_IMPL_SIMPLE(mixedStreamTxParams);
5230 }
5231
5232 //-----------------------------------------------------------
5233 JSON_SERIALIZED_CLASS(GroupDefaultAudioPriority)
5246 {
5247 IMPLEMENT_JSON_SERIALIZATION()
5248 IMPLEMENT_JSON_DOCUMENTATION(GroupDefaultAudioPriority)
5249
5250 public:
5252 uint8_t tx;
5253
5255 uint8_t rx;
5256
5258 {
5259 clear();
5260 }
5261
5262 void clear()
5263 {
5264 tx = 0;
5265 rx = 0;
5266 }
5267
5268 virtual void initForDocumenting()
5269 {
5270 clear();
5271 }
5272 };
5273
5274 static void to_json(nlohmann::json& j, const GroupDefaultAudioPriority& p)
5275 {
5276 j = nlohmann::json{
5277 TOJSON_IMPL(tx),
5278 TOJSON_IMPL(rx)
5279 };
5280 }
5281 static void from_json(const nlohmann::json& j, GroupDefaultAudioPriority& p)
5282 {
5283 p.clear();
5284 FROMJSON_IMPL_SIMPLE(tx);
5285 FROMJSON_IMPL_SIMPLE(rx);
5286 }
5287
5288 //-----------------------------------------------------------
5289 JSON_SERIALIZED_CLASS(Group)
5301 {
5302 IMPLEMENT_JSON_SERIALIZATION()
5303 IMPLEMENT_JSON_DOCUMENTATION(Group)
5304
5305 public:
5307 typedef enum
5308 {
5310 gtUnknown = 0,
5311
5313 gtAudio = 1,
5314
5316 gtPresence = 2,
5317
5319 gtRaw = 3
5320 } Type_t;
5321
5323 typedef enum
5324 {
5326 iagpAnonymousAlias = 0,
5327
5329 iagpSsrcInHex = 1
5330 } InboundAliasGenerationPolicy_t;
5331
5334
5337
5340
5347 std::string id;
5348
5350 std::string name;
5351
5353 std::string spokenName;
5354
5356 std::string interfaceName;
5357
5360
5363
5366
5369
5372
5374 std::string cryptoPassword;
5375
5378
5380 std::vector<Rallypoint> rallypoints;
5381
5384
5387
5396
5398 std::string alias;
5399
5402
5404 std::string source;
5405
5412
5415
5418
5421
5423 std::vector<std::string> presenceGroupAffinities;
5424
5427
5430
5432 std::vector<RtpPayloadTypeTranslation> inboundRtpPayloadTypeTranslations;
5433
5436
5439
5441 std::string anonymousAlias;
5442
5445
5448
5451
5454
5457
5460
5463
5465 std::vector<uint16_t> specializerAffinities;
5466
5469
5471 std::vector<Source> ignoreSources;
5472
5474 std::string languageCode;
5475
5477 std::string synVoice;
5478
5481
5484
5487
5490
5493
5496
5497 Group()
5498 {
5499 clear();
5500 }
5501
5502 void clear()
5503 {
5504 type = gtUnknown;
5505 bridgeTargetOutputDetail.clear();
5506 defaultAudioPriority.clear();
5507 id.clear();
5508 name.clear();
5509 spokenName.clear();
5510 interfaceName.clear();
5511 rx.clear();
5512 tx.clear();
5513 txOptions.clear();
5514 txAudio.clear();
5515 presence.clear();
5516 cryptoPassword.clear();
5517
5518 alias.clear();
5519
5520 rallypoints.clear();
5521 rallypointCluster.clear();
5522
5523 audio.clear();
5524 timeline.clear();
5525
5526 blockAdvertising = false;
5527
5528 source.clear();
5529
5530 maxRxSecs = 0;
5531
5532 enableMulticastFailover = false;
5533 multicastFailoverSecs = 10;
5534
5535 rtcpPresenceRx.clear();
5536
5537 presenceGroupAffinities.clear();
5538 disablePacketEvents = false;
5539
5540 rfc4733RtpPayloadId = 0;
5541 inboundRtpPayloadTypeTranslations.clear();
5542 priorityTranslation.clear();
5543
5544 stickyTidHangSecs = 10;
5545 anonymousAlias.clear();
5546 lbCrypto = false;
5547
5548 appTransport.clear();
5549 allowLoopback = false;
5550
5551 rtpProfile.clear();
5552 rangerPackets.clear();
5553
5554 _wasDeserialized_rtpProfile = false;
5555
5556 txImpairment.clear();
5557 rxImpairment.clear();
5558
5559 specializerAffinities.clear();
5560
5561 securityLevel = 0;
5562
5563 ignoreSources.clear();
5564
5565 languageCode.clear();
5566 synVoice.clear();
5567
5568 rxCapture.clear();
5569 txCapture.clear();
5570
5571 blobRtpPayloadType = ENGAGE_DEFAULT_BLOB_RTP_PAYLOAD_TYPE;
5572 inboundAliasGenerationPolicy = iagpAnonymousAlias;
5573 gateIn.clear();
5574
5575 ignoreAudioTraffic = false;
5576 }
5577 };
5578
5579 static void to_json(nlohmann::json& j, const Group& p)
5580 {
5581 j = nlohmann::json{
5582 TOJSON_IMPL(type),
5583 TOJSON_IMPL(bridgeTargetOutputDetail),
5584 TOJSON_IMPL(defaultAudioPriority),
5585 TOJSON_IMPL(id),
5586 TOJSON_IMPL(name),
5587 TOJSON_IMPL(spokenName),
5588 TOJSON_IMPL(interfaceName),
5589 TOJSON_IMPL(rx),
5590 TOJSON_IMPL(tx),
5591 TOJSON_IMPL(txOptions),
5592 TOJSON_IMPL(txAudio),
5593 TOJSON_IMPL(presence),
5594 TOJSON_IMPL(cryptoPassword),
5595 TOJSON_IMPL(alias),
5596
5597 // See below
5598 //TOJSON_IMPL(rallypoints),
5599 //TOJSON_IMPL(rallypointCluster),
5600
5601 TOJSON_IMPL(alias),
5602 TOJSON_IMPL(audio),
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),
5621
5622 TOJSON_IMPL(txImpairment),
5623 TOJSON_IMPL(rxImpairment),
5624
5625 TOJSON_IMPL(specializerAffinities),
5626
5627 TOJSON_IMPL(securityLevel),
5628
5629 TOJSON_IMPL(ignoreSources),
5630
5631 TOJSON_IMPL(languageCode),
5632 TOJSON_IMPL(synVoice),
5633
5634 TOJSON_IMPL(rxCapture),
5635 TOJSON_IMPL(txCapture),
5636
5637 TOJSON_IMPL(blobRtpPayloadType),
5638
5639 TOJSON_IMPL(inboundAliasGenerationPolicy),
5640
5641 TOJSON_IMPL(gateIn),
5642
5643 TOJSON_IMPL(ignoreAudioTraffic)
5644 };
5645
5646 TOJSON_BASE_IMPL();
5647
5648 // TODO: need a better way to indicate whether rtpProfile is present
5649 if(p._wasDeserialized_rtpProfile || p.isDocumenting())
5650 {
5651 j["rtpProfile"] = p.rtpProfile;
5652 }
5653
5654 if(p.isDocumenting())
5655 {
5656 j["rallypointCluster"] = p.rallypointCluster;
5657 j["rallypoints"] = p.rallypoints;
5658 }
5659 else
5660 {
5661 // rallypointCluster takes precedence if it has elements
5662 if(!p.rallypointCluster.rallypoints.empty())
5663 {
5664 j["rallypointCluster"] = p.rallypointCluster;
5665 }
5666 else if(!p.rallypoints.empty())
5667 {
5668 j["rallypoints"] = p.rallypoints;
5669 }
5670 }
5671 }
5672 static void from_json(const nlohmann::json& j, Group& p)
5673 {
5674 p.clear();
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);
5718
5719 getOptional<PacketCapturer>("rxCapture", p.rxCapture, j);
5720 getOptional<PacketCapturer>("txCapture", p.txCapture, j);
5721
5722 getOptional<uint16_t>("blobRtpPayloadType", p.blobRtpPayloadType, j, ENGAGE_DEFAULT_BLOB_RTP_PAYLOAD_TYPE);
5723
5724 getOptional<Group::InboundAliasGenerationPolicy_t>("inboundAliasGenerationPolicy", p.inboundAliasGenerationPolicy, j, Group::InboundAliasGenerationPolicy_t::iagpAnonymousAlias);
5725
5726 getOptional<AudioGate>("gateIn", p.gateIn, j);
5727
5728 getOptional<bool>("ignoreAudioTraffic", p.ignoreAudioTraffic, j, false);
5729
5730 FROMJSON_BASE_IMPL();
5731 }
5732
5733
5734 //-----------------------------------------------------------
5735 JSON_SERIALIZED_CLASS(Mission)
5737 {
5738 IMPLEMENT_JSON_SERIALIZATION()
5739 IMPLEMENT_JSON_DOCUMENTATION(Mission)
5740
5741 public:
5742 std::string id;
5743 std::string name;
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;
5749 Rallypoint rallypoint;
5750
5751 void clear()
5752 {
5753 id.clear();
5754 name.clear();
5755 groups.clear();
5756 certStoreId.clear();
5757 multicastFailoverPolicy = 0;
5758 rallypoint.clear();
5759 }
5760 };
5761
5762 static void to_json(nlohmann::json& j, const Mission& p)
5763 {
5764 j = nlohmann::json{
5765 TOJSON_IMPL(id),
5766 TOJSON_IMPL(name),
5767 TOJSON_IMPL(groups),
5768 TOJSON_IMPL(certStoreId),
5769 TOJSON_IMPL(multicastFailoverPolicy),
5770 TOJSON_IMPL(rallypoint)
5771 };
5772 }
5773
5774 static void from_json(const nlohmann::json& j, Mission& p)
5775 {
5776 p.clear();
5777 j.at("id").get_to(p.id);
5778 j.at("name").get_to(p.name);
5779
5780 // Groups are optional
5781 try
5782 {
5783 j.at("groups").get_to(p.groups);
5784 }
5785 catch(...)
5786 {
5787 p.groups.clear();
5788 }
5789
5790 FROMJSON_IMPL(certStoreId, std::string, EMPTY_STRING);
5791 FROMJSON_IMPL(multicastFailoverPolicy, int, 0);
5792 getOptional<Rallypoint>("rallypoint", p.rallypoint, j);
5793 }
5794
5795 //-----------------------------------------------------------
5796 JSON_SERIALIZED_CLASS(LicenseDescriptor)
5807 {
5808 IMPLEMENT_JSON_SERIALIZATION()
5809 IMPLEMENT_JSON_DOCUMENTATION(LicenseDescriptor)
5810
5811 public:
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;
5846 std::string entitlement;
5847
5854 std::string key;
5855
5857 std::string activationCode;
5858
5860 std::string deviceId;
5861
5863 int type;
5864
5866 time_t expires;
5867
5869 std::string expiresFormatted;
5870
5875 uint32_t flags;
5876
5878 std::string cargo;
5879
5881 uint8_t cargoFlags;
5882
5888
5890 std::string manufacturerId;
5891
5893 std::string activationHmac;
5894
5896 {
5897 clear();
5898 }
5899
5900 void clear()
5901 {
5902 entitlement.clear();
5903 key.clear();
5904 activationCode.clear();
5905 type = 0;
5906 expires = 0;
5907 expiresFormatted.clear();
5908 flags = 0;
5909 cargo.clear();
5910 cargoFlags = 0;
5911 deviceId.clear();
5912 status = ERR_NOT_INITIALIZED;
5913 manufacturerId.clear();
5914 activationHmac.clear();
5915 }
5916 };
5917
5918 static void to_json(nlohmann::json& j, const LicenseDescriptor& p)
5919 {
5920 j = nlohmann::json{
5921 //TOJSON_IMPL(entitlement),
5922 {"entitlement", "*entitlement*"},
5923 TOJSON_IMPL(key),
5924 TOJSON_IMPL(activationCode),
5925 TOJSON_IMPL(type),
5926 TOJSON_IMPL(expires),
5927 TOJSON_IMPL(expiresFormatted),
5928 TOJSON_IMPL(flags),
5929 TOJSON_IMPL(deviceId),
5930 TOJSON_IMPL(status),
5931 //TOJSON_IMPL(manufacturerId),
5932 {"manufacturerId", "*manufacturerId*"},
5933 TOJSON_IMPL(cargo),
5934 TOJSON_IMPL(cargoFlags),
5935 TOJSON_IMPL(activationHmac)
5936 };
5937 }
5938
5939 static void from_json(const nlohmann::json& j, LicenseDescriptor& p)
5940 {
5941 p.clear();
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);
5955 }
5956
5957
5958 //-----------------------------------------------------------
5959 JSON_SERIALIZED_CLASS(EngineNetworkingRpUdpStreaming)
5972 {
5973 IMPLEMENT_JSON_SERIALIZATION()
5974 IMPLEMENT_JSON_DOCUMENTATION(EngineNetworkingRpUdpStreaming)
5975
5976 public:
5979
5981 int port;
5982
5985
5988
5990 int ttl;
5991
5993 {
5994 clear();
5995 }
5996
5997 void clear()
5998 {
5999 enabled = false;
6000 port = 0;
6001 keepaliveIntervalSecs = 15;
6002 priority = TxPriority_t::priVoice;
6003 ttl = 64;
6004 }
6005
6006 virtual void initForDocumenting()
6007 {
6008 }
6009 };
6010
6011 static void to_json(nlohmann::json& j, const EngineNetworkingRpUdpStreaming& p)
6012 {
6013 j = nlohmann::json{
6014 TOJSON_IMPL(enabled),
6015 TOJSON_IMPL(port),
6016 TOJSON_IMPL(keepaliveIntervalSecs),
6017 TOJSON_IMPL(priority),
6018 TOJSON_IMPL(ttl)
6019 };
6020 }
6021 static void from_json(const nlohmann::json& j, EngineNetworkingRpUdpStreaming& p)
6022 {
6023 p.clear();
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);
6029 }
6030
6031 //-----------------------------------------------------------
6032 JSON_SERIALIZED_CLASS(EnginePolicyNetworking)
6042 {
6043 IMPLEMENT_JSON_SERIALIZATION()
6044 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicyNetworking)
6045
6046 public:
6048 std::string defaultNic;
6049
6052
6055
6058
6061
6064
6067
6070
6073
6075 {
6076 clear();
6077 }
6078
6079 void clear()
6080 {
6081 defaultNic.clear();
6082 multicastRejoinSecs = 8;
6083 rallypointRtTestIntervalMs = 60000;
6084 logRtpJitterBufferStats = false;
6085 preventMulticastFailover = false;
6086 addressResolutionPolicy = AddressResolutionPolicy_t::arpIpv6ThenIpv4;
6087 requireMulticast = true;
6088 rpUdpStreaming.clear();
6089 rtpProfile.clear();
6090 }
6091 };
6092
6093 static void to_json(nlohmann::json& j, const EnginePolicyNetworking& p)
6094 {
6095 j = nlohmann::json{
6096 TOJSON_IMPL(defaultNic),
6097 TOJSON_IMPL(multicastRejoinSecs),
6098
6099 TOJSON_IMPL(rallypointRtTestIntervalMs),
6100 TOJSON_IMPL(logRtpJitterBufferStats),
6101 TOJSON_IMPL(preventMulticastFailover),
6102 TOJSON_IMPL(requireMulticast),
6103 TOJSON_IMPL(rpUdpStreaming),
6104 TOJSON_IMPL(rtpProfile),
6105 TOJSON_IMPL(addressResolutionPolicy)
6106 };
6107 }
6108 static void from_json(const nlohmann::json& j, EnginePolicyNetworking& p)
6109 {
6110 p.clear();
6111 FROMJSON_IMPL(defaultNic, std::string, EMPTY_STRING);
6112 FROMJSON_IMPL(multicastRejoinSecs, int, 8);
6113 FROMJSON_IMPL(rallypointRtTestIntervalMs, int, 60000);
6114 FROMJSON_IMPL(logRtpJitterBufferStats, bool, false);
6115 FROMJSON_IMPL(preventMulticastFailover, bool, false);
6116 FROMJSON_IMPL(requireMulticast, bool, true);
6117 getOptional<EngineNetworkingRpUdpStreaming>("rpUdpStreaming", p.rpUdpStreaming, j);
6118 getOptional<RtpProfile>("rtpProfile", p.rtpProfile, j);
6119 getOptional<AddressResolutionPolicy_t>("addressResolutionPolicy", p.addressResolutionPolicy, j, AddressResolutionPolicy_t::arpIpv6ThenIpv4);
6120 }
6121
6122 //-----------------------------------------------------------
6123 JSON_SERIALIZED_CLASS(Aec)
6134 {
6135 IMPLEMENT_JSON_SERIALIZATION()
6136 IMPLEMENT_JSON_DOCUMENTATION(Aec)
6137
6138 public:
6144 typedef enum
6145 {
6147 aecmDefault = 0,
6148
6150 aecmLow = 1,
6151
6153 aecmMedium = 2,
6154
6156 aecmHigh = 3,
6157
6159 aecmVeryHigh = 4,
6160
6162 aecmHighest = 5
6163 } Mode_t;
6164
6167
6170
6173
6175 bool cng;
6176
6177 Aec()
6178 {
6179 clear();
6180 }
6181
6182 void clear()
6183 {
6184 enabled = false;
6185 mode = aecmDefault;
6186 speakerTailMs = 60;
6187 cng = true;
6188 }
6189 };
6190
6191 static void to_json(nlohmann::json& j, const Aec& p)
6192 {
6193 j = nlohmann::json{
6194 TOJSON_IMPL(enabled),
6195 TOJSON_IMPL(mode),
6196 TOJSON_IMPL(speakerTailMs),
6197 TOJSON_IMPL(cng)
6198 };
6199 }
6200 static void from_json(const nlohmann::json& j, Aec& p)
6201 {
6202 p.clear();
6203 FROMJSON_IMPL(enabled, bool, false);
6204 FROMJSON_IMPL(mode, Aec::Mode_t, Aec::Mode_t::aecmDefault);
6205 FROMJSON_IMPL(speakerTailMs, int, 60);
6206 FROMJSON_IMPL(cng, bool, true);
6207 }
6208
6209 //-----------------------------------------------------------
6210 JSON_SERIALIZED_CLASS(Vad)
6221 {
6222 IMPLEMENT_JSON_SERIALIZATION()
6223 IMPLEMENT_JSON_DOCUMENTATION(Vad)
6224
6225 public:
6231 typedef enum
6232 {
6234 vamDefault = 0,
6235
6237 vamLowBitRate = 1,
6238
6240 vamAggressive = 2,
6241
6243 vamVeryAggressive = 3
6244 } Mode_t;
6245
6248
6251
6252 Vad()
6253 {
6254 clear();
6255 }
6256
6257 void clear()
6258 {
6259 enabled = false;
6260 mode = vamDefault;
6261 }
6262 };
6263
6264 static void to_json(nlohmann::json& j, const Vad& p)
6265 {
6266 j = nlohmann::json{
6267 TOJSON_IMPL(enabled),
6268 TOJSON_IMPL(mode)
6269 };
6270 }
6271 static void from_json(const nlohmann::json& j, Vad& p)
6272 {
6273 p.clear();
6274 FROMJSON_IMPL(enabled, bool, false);
6275 FROMJSON_IMPL(mode, Vad::Mode_t, Vad::Mode_t::vamDefault);
6276 }
6277
6278 //-----------------------------------------------------------
6279 JSON_SERIALIZED_CLASS(Bridge)
6290 {
6291 IMPLEMENT_JSON_SERIALIZATION()
6292 IMPLEMENT_JSON_DOCUMENTATION(Bridge)
6293
6294 public:
6296 std::string id;
6297
6299 std::string name;
6300
6302 std::vector<std::string> groups;
6303
6308
6311
6312
6313 Bridge()
6314 {
6315 clear();
6316 }
6317
6318 void clear()
6319 {
6320 id.clear();
6321 name.clear();
6322 groups.clear();
6323 enabled = true;
6324 active = true;
6325 }
6326 };
6327
6328 static void to_json(nlohmann::json& j, const Bridge& p)
6329 {
6330 j = nlohmann::json{
6331 TOJSON_IMPL(id),
6332 TOJSON_IMPL(name),
6333 TOJSON_IMPL(groups),
6334 TOJSON_IMPL(enabled),
6335 TOJSON_IMPL(active)
6336 };
6337 }
6338 static void from_json(const nlohmann::json& j, Bridge& p)
6339 {
6340 p.clear();
6341 FROMJSON_IMPL(id, std::string, EMPTY_STRING);
6342 FROMJSON_IMPL(name, std::string, EMPTY_STRING);
6343 getOptional<std::vector<std::string>>("groups", p.groups, j);
6344 FROMJSON_IMPL(enabled, bool, true);
6345 FROMJSON_IMPL(active, bool, true);
6346 }
6347
6348 //-----------------------------------------------------------
6349 JSON_SERIALIZED_CLASS(AndroidAudio)
6360 {
6361 IMPLEMENT_JSON_SERIALIZATION()
6362 IMPLEMENT_JSON_DOCUMENTATION(AndroidAudio)
6363
6364 public:
6365 constexpr static int INVALID_SESSION_ID = -9999;
6366
6368 int api;
6369
6372
6375
6391
6399
6409
6412
6415
6416
6417 AndroidAudio()
6418 {
6419 clear();
6420 }
6421
6422 void clear()
6423 {
6424 api = 0;
6425 sharingMode = 0;
6426 performanceMode = 12;
6427 usage = 2;
6428 contentType = 1;
6429 inputPreset = 7;
6430 sessionId = AndroidAudio::INVALID_SESSION_ID;
6431 engineMode = 0;
6432 }
6433 };
6434
6435 static void to_json(nlohmann::json& j, const AndroidAudio& p)
6436 {
6437 j = nlohmann::json{
6438 TOJSON_IMPL(api),
6439 TOJSON_IMPL(sharingMode),
6440 TOJSON_IMPL(performanceMode),
6441 TOJSON_IMPL(usage),
6442 TOJSON_IMPL(contentType),
6443 TOJSON_IMPL(inputPreset),
6444 TOJSON_IMPL(sessionId),
6445 TOJSON_IMPL(engineMode)
6446 };
6447 }
6448 static void from_json(const nlohmann::json& j, AndroidAudio& p)
6449 {
6450 p.clear();
6451 FROMJSON_IMPL(api, int, 0);
6452 FROMJSON_IMPL(sharingMode, int, 0);
6453 FROMJSON_IMPL(performanceMode, int, 12);
6454 FROMJSON_IMPL(usage, int, 2);
6455 FROMJSON_IMPL(contentType, int, 1);
6456 FROMJSON_IMPL(inputPreset, int, 7);
6457 FROMJSON_IMPL(sessionId, int, AndroidAudio::INVALID_SESSION_ID);
6458 FROMJSON_IMPL(engineMode, int, 0);
6459 }
6460
6461 //-----------------------------------------------------------
6462 JSON_SERIALIZED_CLASS(EnginePolicyAudio)
6473 {
6474 IMPLEMENT_JSON_SERIALIZATION()
6475 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicyAudio)
6476
6477 public:
6480
6483
6486
6489
6492
6495
6498
6501
6504
6507
6510
6513
6516
6519
6522
6523
6525 {
6526 clear();
6527 }
6528
6529 void clear()
6530 {
6531 enabled = true;
6532 hardwareEnabled = true;
6533 internalRate = 16000;
6534 internalChannels = 2;
6535 muteTxOnTx = false;
6536 aec.clear();
6537 vad.clear();
6538 android.clear();
6539 inputAgc.clear();
6540 outputAgc.clear();
6541 denoiseInput = false;
6542 denoiseOutput = false;
6543 saveInputPcm = false;
6544 saveOutputPcm = false;
6545 registry.clear();
6546 }
6547 };
6548
6549 static void to_json(nlohmann::json& j, const EnginePolicyAudio& p)
6550 {
6551 j = nlohmann::json{
6552 TOJSON_IMPL(enabled),
6553 TOJSON_IMPL(hardwareEnabled),
6554 TOJSON_IMPL(internalRate),
6555 TOJSON_IMPL(internalChannels),
6556 TOJSON_IMPL(muteTxOnTx),
6557 TOJSON_IMPL(aec),
6558 TOJSON_IMPL(vad),
6559 TOJSON_IMPL(android),
6560 TOJSON_IMPL(inputAgc),
6561 TOJSON_IMPL(outputAgc),
6562 TOJSON_IMPL(denoiseInput),
6563 TOJSON_IMPL(denoiseOutput),
6564 TOJSON_IMPL(saveInputPcm),
6565 TOJSON_IMPL(saveOutputPcm),
6566 TOJSON_IMPL(registry)
6567 };
6568 }
6569 static void from_json(const nlohmann::json& j, EnginePolicyAudio& p)
6570 {
6571 p.clear();
6572 getOptional<bool>("enabled", p.enabled, j, true);
6573 getOptional<bool>("hardwareEnabled", p.hardwareEnabled, j, true);
6574 FROMJSON_IMPL(internalRate, int, 16000);
6575 FROMJSON_IMPL(internalChannels, int, 2);
6576
6577 FROMJSON_IMPL(muteTxOnTx, bool, false);
6578 getOptional<Aec>("aec", p.aec, j);
6579 getOptional<Vad>("vad", p.vad, j);
6580 getOptional<AndroidAudio>("android", p.android, j);
6581 getOptional<Agc>("inputAgc", p.inputAgc, j);
6582 getOptional<Agc>("outputAgc", p.outputAgc, j);
6583 FROMJSON_IMPL(denoiseInput, bool, false);
6584 FROMJSON_IMPL(denoiseOutput, bool, false);
6585 FROMJSON_IMPL(saveInputPcm, bool, false);
6586 FROMJSON_IMPL(saveOutputPcm, bool, false);
6587 getOptional<AudioRegistry>("registry", p.registry, j);
6588 }
6589
6590 //-----------------------------------------------------------
6591 JSON_SERIALIZED_CLASS(SecurityCertificate)
6602 {
6603 IMPLEMENT_JSON_SERIALIZATION()
6604 IMPLEMENT_JSON_DOCUMENTATION(SecurityCertificate)
6605
6606 public:
6607
6613 std::string certificate;
6614
6616 std::string key;
6617
6619 {
6620 clear();
6621 }
6622
6623 void clear()
6624 {
6625 certificate.clear();
6626 key.clear();
6627 }
6628 };
6629
6630 static void to_json(nlohmann::json& j, const SecurityCertificate& p)
6631 {
6632 j = nlohmann::json{
6633 TOJSON_IMPL(certificate),
6634 TOJSON_IMPL(key)
6635 };
6636 }
6637 static void from_json(const nlohmann::json& j, SecurityCertificate& p)
6638 {
6639 p.clear();
6640 FROMJSON_IMPL(certificate, std::string, EMPTY_STRING);
6641 FROMJSON_IMPL(key, std::string, EMPTY_STRING);
6642 }
6643
6644 // This is where spell checking stops
6645 //-----------------------------------------------------------
6646 JSON_SERIALIZED_CLASS(EnginePolicySecurity)
6647
6648
6658 {
6659 IMPLEMENT_JSON_SERIALIZATION()
6660 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicySecurity)
6661
6662 public:
6663
6675
6683 std::vector<std::string> caCertificates;
6684
6686 {
6687 clear();
6688 }
6689
6690 void clear()
6691 {
6692 certificate.clear();
6693 caCertificates.clear();
6694 }
6695 };
6696
6697 static void to_json(nlohmann::json& j, const EnginePolicySecurity& p)
6698 {
6699 j = nlohmann::json{
6700 TOJSON_IMPL(certificate),
6701 TOJSON_IMPL(caCertificates)
6702 };
6703 }
6704 static void from_json(const nlohmann::json& j, EnginePolicySecurity& p)
6705 {
6706 p.clear();
6707 getOptional("certificate", p.certificate, j);
6708 getOptional<std::vector<std::string>>("caCertificates", p.caCertificates, j);
6709 }
6710
6711 //-----------------------------------------------------------
6712 JSON_SERIALIZED_CLASS(EnginePolicyLogging)
6723 {
6724 IMPLEMENT_JSON_SERIALIZATION()
6725 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicyLogging)
6726
6727 public:
6728
6745
6748
6750 {
6751 clear();
6752 }
6753
6754 void clear()
6755 {
6756 maxLevel = 4; // ILogger::Level::debug
6757 enableSyslog = false;
6758 }
6759 };
6760
6761 static void to_json(nlohmann::json& j, const EnginePolicyLogging& p)
6762 {
6763 j = nlohmann::json{
6764 TOJSON_IMPL(maxLevel),
6765 TOJSON_IMPL(enableSyslog)
6766 };
6767 }
6768 static void from_json(const nlohmann::json& j, EnginePolicyLogging& p)
6769 {
6770 p.clear();
6771 getOptional("maxLevel", p.maxLevel, j, 4); // ILogger::Level::debug
6772 getOptional("enableSyslog", p.enableSyslog, j);
6773 }
6774
6775
6776 //-----------------------------------------------------------
6777 JSON_SERIALIZED_CLASS(EnginePolicyDatabase)
6779 {
6780 IMPLEMENT_JSON_SERIALIZATION()
6781 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicyDatabase)
6782
6783 public:
6784 typedef enum
6785 {
6786 dbtFixedMemory = 0,
6787 dbtPagedMemory = 1,
6788 dbtFixedFile = 2
6789 } DatabaseType_t;
6790
6791 DatabaseType_t type;
6792 std::string fixedFileName;
6793 bool forceMaintenance;
6794 bool reclaimSpace;
6795
6797 {
6798 clear();
6799 }
6800
6801 void clear()
6802 {
6803 type = DatabaseType_t::dbtFixedMemory;
6804 fixedFileName.clear();
6805 forceMaintenance = false;
6806 reclaimSpace = false;
6807 }
6808 };
6809
6810 static void to_json(nlohmann::json& j, const EnginePolicyDatabase& p)
6811 {
6812 j = nlohmann::json{
6813 TOJSON_IMPL(type),
6814 TOJSON_IMPL(fixedFileName),
6815 TOJSON_IMPL(forceMaintenance),
6816 TOJSON_IMPL(reclaimSpace)
6817 };
6818 }
6819 static void from_json(const nlohmann::json& j, EnginePolicyDatabase& p)
6820 {
6821 p.clear();
6822 FROMJSON_IMPL(type, EnginePolicyDatabase::DatabaseType_t, EnginePolicyDatabase::DatabaseType_t::dbtFixedMemory);
6823 FROMJSON_IMPL(fixedFileName, std::string, EMPTY_STRING);
6824 FROMJSON_IMPL(forceMaintenance, bool, false);
6825 FROMJSON_IMPL(reclaimSpace, bool, false);
6826 }
6827
6828
6829 //-----------------------------------------------------------
6830 JSON_SERIALIZED_CLASS(SecureSignature)
6839 {
6840 IMPLEMENT_JSON_SERIALIZATION()
6841 IMPLEMENT_JSON_DOCUMENTATION(SecureSignature)
6842
6843 public:
6844
6846 std::string certificate;
6847
6848 // /** @brief Contains the PEM-formatted text of the certificate's public key */
6849 //std::string publicKey;
6850
6852 std::string signature;
6853
6855 {
6856 clear();
6857 }
6858
6859 void clear()
6860 {
6861 certificate.clear();
6862 //publicKey.clear();
6863 signature.clear();
6864 }
6865 };
6866
6867 static void to_json(nlohmann::json& j, const SecureSignature& p)
6868 {
6869 j = nlohmann::json{
6870 TOJSON_IMPL(certificate),
6871 //TOJSON_IMPL(publicKey),
6872 TOJSON_IMPL(signature)
6873 };
6874 }
6875 static void from_json(const nlohmann::json& j, SecureSignature& p)
6876 {
6877 p.clear();
6878 FROMJSON_IMPL(certificate, std::string, EMPTY_STRING);
6879 //FROMJSON_IMPL(publicKey, std::string, EMPTY_STRING);
6880 FROMJSON_IMPL(signature, std::string, EMPTY_STRING);
6881 }
6882
6883 //-----------------------------------------------------------
6884 JSON_SERIALIZED_CLASS(NamedAudioDevice)
6886 {
6887 IMPLEMENT_JSON_SERIALIZATION()
6888 IMPLEMENT_JSON_DOCUMENTATION(NamedAudioDevice)
6889
6890 public:
6891 std::string name;
6892 std::string manufacturer;
6893 std::string model;
6894 std::string id;
6895 std::string serialNumber;
6896 std::string type;
6897 std::string extra;
6898 bool isDefault;
6899
6901 {
6902 clear();
6903 }
6904
6905 void clear()
6906 {
6907 name.clear();
6908 manufacturer.clear();
6909 model.clear();
6910 id.clear();
6911 serialNumber.clear();
6912 type.clear();
6913 extra.clear();
6914 isDefault = false;
6915 }
6916 };
6917
6918 static void to_json(nlohmann::json& j, const NamedAudioDevice& p)
6919 {
6920 j = nlohmann::json{
6921 TOJSON_IMPL(name),
6922 TOJSON_IMPL(manufacturer),
6923 TOJSON_IMPL(model),
6924 TOJSON_IMPL(id),
6925 TOJSON_IMPL(serialNumber),
6926 TOJSON_IMPL(type),
6927 TOJSON_IMPL(extra),
6928 TOJSON_IMPL(isDefault),
6929 };
6930 }
6931 static void from_json(const nlohmann::json& j, NamedAudioDevice& p)
6932 {
6933 p.clear();
6934 getOptional<std::string>("name", p.name, j, EMPTY_STRING);
6935 getOptional<std::string>("manufacturer", p.manufacturer, j, EMPTY_STRING);
6936 getOptional<std::string>("model", p.model, j, EMPTY_STRING);
6937 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
6938 getOptional<std::string>("serialNumber", p.serialNumber, j, EMPTY_STRING);
6939 getOptional<std::string>("type", p.type, j, EMPTY_STRING);
6940 getOptional<std::string>("extra", p.extra, j, EMPTY_STRING);
6941 getOptional<bool>("isDefault", p.isDefault, j, false);
6942 }
6943
6944
6945 //-----------------------------------------------------------
6946 JSON_SERIALIZED_CLASS(EnginePolicyNamedAudioDevices)
6948 {
6949 IMPLEMENT_JSON_SERIALIZATION()
6950 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicyNamedAudioDevices)
6951
6952 public:
6953 std::vector<NamedAudioDevice> inputs;
6954 std::vector<NamedAudioDevice> outputs;
6955
6957 {
6958 clear();
6959 }
6960
6961 void clear()
6962 {
6963 inputs.clear();
6964 outputs.clear();
6965 }
6966 };
6967
6968 static void to_json(nlohmann::json& j, const EnginePolicyNamedAudioDevices& p)
6969 {
6970 j = nlohmann::json{
6971 TOJSON_IMPL(inputs),
6972 TOJSON_IMPL(outputs)
6973 };
6974 }
6975 static void from_json(const nlohmann::json& j, EnginePolicyNamedAudioDevices& p)
6976 {
6977 p.clear();
6978 getOptional<std::vector<NamedAudioDevice>>("inputs", p.inputs, j);
6979 getOptional<std::vector<NamedAudioDevice>>("outputs", p.outputs, j);
6980 }
6981
6982 //-----------------------------------------------------------
6983 JSON_SERIALIZED_CLASS(Licensing)
6996 {
6997 IMPLEMENT_JSON_SERIALIZATION()
6998 IMPLEMENT_JSON_DOCUMENTATION(Licensing)
6999
7000 public:
7001
7003 std::string entitlement;
7004
7006 std::string key;
7007
7009 std::string activationCode;
7010
7012 std::string deviceId;
7013
7015 std::string manufacturerId;
7016
7017 Licensing()
7018 {
7019 clear();
7020 }
7021
7022 void clear()
7023 {
7024 entitlement.clear();
7025 key.clear();
7026 activationCode.clear();
7027 deviceId.clear();
7028 manufacturerId.clear();
7029 }
7030 };
7031
7032 static void to_json(nlohmann::json& j, const Licensing& p)
7033 {
7034 j = nlohmann::json{
7035 TOJSON_IMPL(entitlement),
7036 TOJSON_IMPL(key),
7037 TOJSON_IMPL(activationCode),
7038 TOJSON_IMPL(deviceId),
7039 TOJSON_IMPL(manufacturerId)
7040 };
7041 }
7042 static void from_json(const nlohmann::json& j, Licensing& p)
7043 {
7044 p.clear();
7045 FROMJSON_IMPL(entitlement, std::string, EMPTY_STRING);
7046 FROMJSON_IMPL(key, std::string, EMPTY_STRING);
7047 FROMJSON_IMPL(activationCode, std::string, EMPTY_STRING);
7048 FROMJSON_IMPL(deviceId, std::string, EMPTY_STRING);
7049 FROMJSON_IMPL(manufacturerId, std::string, EMPTY_STRING);
7050 }
7051
7052 //-----------------------------------------------------------
7053 JSON_SERIALIZED_CLASS(DiscoveryMagellan)
7064 {
7065 IMPLEMENT_JSON_SERIALIZATION()
7066 IMPLEMENT_JSON_DOCUMENTATION(DiscoveryMagellan)
7067
7068 public:
7069
7072
7074 std::string interfaceName;
7075
7078
7081
7083 {
7084 clear();
7085 }
7086
7087 void clear()
7088 {
7089 enabled = false;
7090 interfaceName.clear();
7091 security.clear();
7092 tls.clear();
7093 }
7094 };
7095
7096 static void to_json(nlohmann::json& j, const DiscoveryMagellan& p)
7097 {
7098 j = nlohmann::json{
7099 TOJSON_IMPL(enabled),
7100 TOJSON_IMPL(interfaceName),
7101 TOJSON_IMPL(security),
7102 TOJSON_IMPL(tls)
7103 };
7104 }
7105 static void from_json(const nlohmann::json& j, DiscoveryMagellan& p)
7106 {
7107 p.clear();
7108 getOptional("enabled", p.enabled, j, false);
7109 getOptional<Tls>("tls", p.tls, j);
7110 getOptional<SecurityCertificate>("security", p.security, j);
7111 FROMJSON_IMPL(interfaceName, std::string, EMPTY_STRING);
7112 }
7113
7114 //-----------------------------------------------------------
7115 JSON_SERIALIZED_CLASS(DiscoverySsdp)
7126 {
7127 IMPLEMENT_JSON_SERIALIZATION()
7128 IMPLEMENT_JSON_DOCUMENTATION(DiscoverySsdp)
7129
7130 public:
7131
7134
7136 std::string interfaceName;
7137
7140
7142 std::vector<std::string> searchTerms;
7143
7146
7149
7151 {
7152 clear();
7153 }
7154
7155 void clear()
7156 {
7157 enabled = false;
7158 interfaceName.clear();
7159 address.clear();
7160 searchTerms.clear();
7161 ageTimeoutMs = 30000;
7162 advertising.clear();
7163 }
7164 };
7165
7166 static void to_json(nlohmann::json& j, const DiscoverySsdp& p)
7167 {
7168 j = nlohmann::json{
7169 TOJSON_IMPL(enabled),
7170 TOJSON_IMPL(interfaceName),
7171 TOJSON_IMPL(address),
7172 TOJSON_IMPL(searchTerms),
7173 TOJSON_IMPL(ageTimeoutMs),
7174 TOJSON_IMPL(advertising)
7175 };
7176 }
7177 static void from_json(const nlohmann::json& j, DiscoverySsdp& p)
7178 {
7179 p.clear();
7180 getOptional("enabled", p.enabled, j, false);
7181 getOptional<std::string>("interfaceName", p.interfaceName, j);
7182
7183 getOptional<NetworkAddress>("address", p.address, j);
7184 if(p.address.address.empty())
7185 {
7186 p.address.address = "255.255.255.255";
7187 }
7188 if(p.address.port <= 0)
7189 {
7190 p.address.port = 1900;
7191 }
7192
7193 getOptional<std::vector<std::string>>("searchTerms", p.searchTerms, j);
7194 getOptional<int>("ageTimeoutMs", p.ageTimeoutMs, j, 30000);
7195 getOptional<Advertising>("advertising", p.advertising, j);
7196 }
7197
7198 //-----------------------------------------------------------
7199 JSON_SERIALIZED_CLASS(DiscoverySap)
7210 {
7211 IMPLEMENT_JSON_SERIALIZATION()
7212 IMPLEMENT_JSON_DOCUMENTATION(DiscoverySap)
7213
7214 public:
7217
7219 std::string interfaceName;
7220
7223
7226
7229
7230 DiscoverySap()
7231 {
7232 clear();
7233 }
7234
7235 void clear()
7236 {
7237 enabled = false;
7238 interfaceName.clear();
7239 address.clear();
7240 ageTimeoutMs = 30000;
7241 advertising.clear();
7242 }
7243 };
7244
7245 static void to_json(nlohmann::json& j, const DiscoverySap& p)
7246 {
7247 j = nlohmann::json{
7248 TOJSON_IMPL(enabled),
7249 TOJSON_IMPL(interfaceName),
7250 TOJSON_IMPL(address),
7251 TOJSON_IMPL(ageTimeoutMs),
7252 TOJSON_IMPL(advertising)
7253 };
7254 }
7255 static void from_json(const nlohmann::json& j, DiscoverySap& p)
7256 {
7257 p.clear();
7258 getOptional("enabled", p.enabled, j, false);
7259 getOptional<std::string>("interfaceName", p.interfaceName, j);
7260 getOptional<NetworkAddress>("address", p.address, j);
7261 if(p.address.address.empty())
7262 {
7263 p.address.address = "224.2.127.254";
7264 }
7265 if(p.address.port <= 0)
7266 {
7267 p.address.port = 9875;
7268 }
7269
7270 getOptional<int>("ageTimeoutMs", p.ageTimeoutMs, j, 30000);
7271 getOptional<Advertising>("advertising", p.advertising, j);
7272 }
7273
7274 //-----------------------------------------------------------
7275 JSON_SERIALIZED_CLASS(DiscoveryCistech)
7288 {
7289 IMPLEMENT_JSON_SERIALIZATION()
7290 IMPLEMENT_JSON_DOCUMENTATION(DiscoveryCistech)
7291
7292 public:
7293 bool enabled;
7294 std::string interfaceName;
7295 NetworkAddress address;
7296 int ageTimeoutMs;
7297
7299 {
7300 clear();
7301 }
7302
7303 void clear()
7304 {
7305 enabled = false;
7306 interfaceName.clear();
7307 address.clear();
7308 ageTimeoutMs = 30000;
7309 }
7310 };
7311
7312 static void to_json(nlohmann::json& j, const DiscoveryCistech& p)
7313 {
7314 j = nlohmann::json{
7315 TOJSON_IMPL(enabled),
7316 TOJSON_IMPL(interfaceName),
7317 TOJSON_IMPL(address),
7318 TOJSON_IMPL(ageTimeoutMs)
7319 };
7320 }
7321 static void from_json(const nlohmann::json& j, DiscoveryCistech& p)
7322 {
7323 p.clear();
7324 getOptional("enabled", p.enabled, j, false);
7325 getOptional<std::string>("interfaceName", p.interfaceName, j);
7326 getOptional<NetworkAddress>("address", p.address, j);
7327 getOptional<int>("ageTimeoutMs", p.ageTimeoutMs, j, 30000);
7328 }
7329
7330
7331 //-----------------------------------------------------------
7332 JSON_SERIALIZED_CLASS(DiscoveryTrellisware)
7343 {
7344 IMPLEMENT_JSON_SERIALIZATION()
7345 IMPLEMENT_JSON_DOCUMENTATION(DiscoveryTrellisware)
7346
7347 public:
7348
7351
7354
7356 {
7357 clear();
7358 }
7359
7360 void clear()
7361 {
7362 enabled = false;
7363 security.clear();
7364 }
7365 };
7366
7367 static void to_json(nlohmann::json& j, const DiscoveryTrellisware& p)
7368 {
7369 j = nlohmann::json{
7370 TOJSON_IMPL(enabled),
7371 TOJSON_IMPL(security)
7372 };
7373 }
7374 static void from_json(const nlohmann::json& j, DiscoveryTrellisware& p)
7375 {
7376 p.clear();
7377 getOptional("enabled", p.enabled, j, false);
7378 getOptional<SecurityCertificate>("security", p.security, j);
7379 }
7380
7381 //-----------------------------------------------------------
7382 JSON_SERIALIZED_CLASS(DiscoveryConfiguration)
7393 {
7394 IMPLEMENT_JSON_SERIALIZATION()
7395 IMPLEMENT_JSON_DOCUMENTATION(DiscoveryConfiguration)
7396
7397 public:
7400
7403
7406
7409
7412
7414 {
7415 clear();
7416 }
7417
7418 void clear()
7419 {
7420 magellan.clear();
7421 ssdp.clear();
7422 sap.clear();
7423 cistech.clear();
7424 }
7425 };
7426
7427 static void to_json(nlohmann::json& j, const DiscoveryConfiguration& p)
7428 {
7429 j = nlohmann::json{
7430 TOJSON_IMPL(magellan),
7431 TOJSON_IMPL(ssdp),
7432 TOJSON_IMPL(sap),
7433 TOJSON_IMPL(cistech),
7434 TOJSON_IMPL(trellisware)
7435 };
7436 }
7437 static void from_json(const nlohmann::json& j, DiscoveryConfiguration& p)
7438 {
7439 p.clear();
7440 getOptional<DiscoveryMagellan>("magellan", p.magellan, j);
7441 getOptional<DiscoverySsdp>("ssdp", p.ssdp, j);
7442 getOptional<DiscoverySap>("sap", p.sap, j);
7443 getOptional<DiscoveryCistech>("cistech", p.cistech, j);
7444 getOptional<DiscoveryTrellisware>("trellisware", p.trellisware, j);
7445 }
7446
7447
7448 //-----------------------------------------------------------
7449 JSON_SERIALIZED_CLASS(EnginePolicyInternals)
7462 {
7463 IMPLEMENT_JSON_SERIALIZATION()
7464 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicyInternals)
7465
7466 public:
7469
7472
7475
7476 int maxRxSecs;
7477
7478 int logTaskQueueStatsIntervalMs;
7479
7480 bool enableLazySpeakerClosure;
7481
7484
7487
7490
7493
7496
7499
7502
7505
7508
7510 {
7511 clear();
7512 }
7513
7514 void clear()
7515 {
7516 watchdog.clear();
7517 housekeeperIntervalMs = 1000;
7518 logTaskQueueStatsIntervalMs = 0;
7519 maxTxSecs = 30;
7520 maxRxSecs = 0;
7521 enableLazySpeakerClosure = false;
7522 rpClusterStrategy = RallypointCluster::ConnectionStrategy_t::csRoundRobin;
7523 rpClusterRolloverSecs = 10;
7524 rtpExpirationCheckIntervalMs = 250;
7525 rpConnectionTimeoutSecs = 0;
7526 rpTransactionTimeoutMs = 0;
7527 stickyTidHangSecs = 10;
7528 uriStreamingIntervalMs = 60;
7529 delayedMicrophoneClosureSecs = 15;
7530 tuning.clear();
7531 }
7532 };
7533
7534 static void to_json(nlohmann::json& j, const EnginePolicyInternals& p)
7535 {
7536 j = nlohmann::json{
7537 TOJSON_IMPL(watchdog),
7538 TOJSON_IMPL(housekeeperIntervalMs),
7539 TOJSON_IMPL(logTaskQueueStatsIntervalMs),
7540 TOJSON_IMPL(maxTxSecs),
7541 TOJSON_IMPL(maxRxSecs),
7542 TOJSON_IMPL(enableLazySpeakerClosure),
7543 TOJSON_IMPL(rpClusterStrategy),
7544 TOJSON_IMPL(rpClusterRolloverSecs),
7545 TOJSON_IMPL(rtpExpirationCheckIntervalMs),
7546 TOJSON_IMPL(rpConnectionTimeoutSecs),
7547 TOJSON_IMPL(rpTransactionTimeoutMs),
7548 TOJSON_IMPL(stickyTidHangSecs),
7549 TOJSON_IMPL(uriStreamingIntervalMs),
7550 TOJSON_IMPL(delayedMicrophoneClosureSecs),
7551 TOJSON_IMPL(tuning)
7552 };
7553 }
7554 static void from_json(const nlohmann::json& j, EnginePolicyInternals& p)
7555 {
7556 p.clear();
7557 getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
7558 getOptional<int>("housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
7559 getOptional<int>("logTaskQueueStatsIntervalMs", p.logTaskQueueStatsIntervalMs, j, 0);
7560 getOptional<int>("maxTxSecs", p.maxTxSecs, j, 30);
7561 getOptional<int>("maxRxSecs", p.maxRxSecs, j, 0);
7562 getOptional<bool>("enableLazySpeakerClosure", p.enableLazySpeakerClosure, j, false);
7563 getOptional<RallypointCluster::ConnectionStrategy_t>("rpClusterStrategy", p.rpClusterStrategy, j, RallypointCluster::ConnectionStrategy_t::csRoundRobin);
7564 getOptional<int>("rpClusterRolloverSecs", p.rpClusterRolloverSecs, j, 10);
7565 getOptional<int>("rtpExpirationCheckIntervalMs", p.rtpExpirationCheckIntervalMs, j, 250);
7566 getOptional<int>("rpConnectionTimeoutSecs", p.rpConnectionTimeoutSecs, j, 0);
7567 getOptional<int>("rpTransactionTimeoutMs", p.rpTransactionTimeoutMs, j, 0);
7568 getOptional<int>("stickyTidHangSecs", p.stickyTidHangSecs, j, 10);
7569 getOptional<int>("uriStreamingIntervalMs", p.uriStreamingIntervalMs, j, 60);
7570 getOptional<int>("delayedMicrophoneClosureSecs", p.delayedMicrophoneClosureSecs, j, 15);
7571 getOptional<TuningSettings>("tuning", p.tuning, j);
7572 }
7573
7574 //-----------------------------------------------------------
7575 JSON_SERIALIZED_CLASS(EnginePolicyTimelines)
7588 {
7589 IMPLEMENT_JSON_SERIALIZATION()
7590 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicyTimelines)
7591
7592 public:
7593
7600
7602 std::string storageRoot;
7603
7606
7609
7612
7615
7618
7621
7624
7633
7636
7639
7642
7644 {
7645 clear();
7646 }
7647
7648 void clear()
7649 {
7650 enabled = true;
7651 storageRoot.clear();
7652 maxStorageMb = 1024; // 1 Gigabyte
7653 maxMemMb = maxStorageMb;
7654 maxAudioEventMemMb = maxMemMb;
7655 maxDiskMb = maxStorageMb;
7656 maxEventAgeSecs = (86400 * 30); // 30 days
7657 groomingIntervalSecs = (60 * 30); // 30 minutes
7658 maxEvents = 1000;
7659 autosaveIntervalSecs = 5;
7660 security.clear();
7661 disableSigningAndVerification = false;
7662 ephemeral = false;
7663 }
7664 };
7665
7666 static void to_json(nlohmann::json& j, const EnginePolicyTimelines& p)
7667 {
7668 j = nlohmann::json{
7669 TOJSON_IMPL(enabled),
7670 TOJSON_IMPL(storageRoot),
7671 TOJSON_IMPL(maxMemMb),
7672 TOJSON_IMPL(maxAudioEventMemMb),
7673 TOJSON_IMPL(maxDiskMb),
7674 TOJSON_IMPL(maxEventAgeSecs),
7675 TOJSON_IMPL(maxEvents),
7676 TOJSON_IMPL(groomingIntervalSecs),
7677 TOJSON_IMPL(autosaveIntervalSecs),
7678 TOJSON_IMPL(security),
7679 TOJSON_IMPL(disableSigningAndVerification),
7680 TOJSON_IMPL(ephemeral)
7681 };
7682 }
7683 static void from_json(const nlohmann::json& j, EnginePolicyTimelines& p)
7684 {
7685 p.clear();
7686 getOptional<bool>("enabled", p.enabled, j, true);
7687 getOptional<std::string>("storageRoot", p.storageRoot, j, EMPTY_STRING);
7688
7689 getOptional<int>("maxStorageMb", p.maxStorageMb, j, 1024);
7690 getOptional<int>("maxMemMb", p.maxMemMb, j, p.maxStorageMb);
7691 getOptional<int>("maxAudioEventMemMb", p.maxAudioEventMemMb, j, p.maxMemMb);
7692 getOptional<int>("maxDiskMb", p.maxDiskMb, j, p.maxStorageMb);
7693 getOptional<long>("maxEventAgeSecs", p.maxEventAgeSecs, j, (86400 * 30));
7694 getOptional<long>("groomingIntervalSecs", p.groomingIntervalSecs, j, (60 * 30));
7695 getOptional<long>("autosaveIntervalSecs", p.autosaveIntervalSecs, j, 5);
7696 getOptional<int>("maxEvents", p.maxEvents, j, 1000);
7697 getOptional<SecurityCertificate>("security", p.security, j);
7698 getOptional<bool>("disableSigningAndVerification", p.disableSigningAndVerification, j, false);
7699 getOptional<bool>("ephemeral", p.ephemeral, j, false);
7700 }
7701
7702
7703 //-----------------------------------------------------------
7704 JSON_SERIALIZED_CLASS(RtpMapEntry)
7715 {
7716 IMPLEMENT_JSON_SERIALIZATION()
7717 IMPLEMENT_JSON_DOCUMENTATION(RtpMapEntry)
7718
7719 public:
7721 std::string name;
7722
7725
7728
7729 RtpMapEntry()
7730 {
7731 clear();
7732 }
7733
7734 void clear()
7735 {
7736 name.clear();
7737 engageType = -1;
7738 rtpPayloadType = -1;
7739 }
7740 };
7741
7742 static void to_json(nlohmann::json& j, const RtpMapEntry& p)
7743 {
7744 j = nlohmann::json{
7745 TOJSON_IMPL(name),
7746 TOJSON_IMPL(engageType),
7747 TOJSON_IMPL(rtpPayloadType)
7748 };
7749 }
7750 static void from_json(const nlohmann::json& j, RtpMapEntry& p)
7751 {
7752 p.clear();
7753 getOptional<std::string>("name", p.name, j, EMPTY_STRING);
7754 getOptional<int>("engageType", p.engageType, j, -1);
7755 getOptional<int>("rtpPayloadType", p.rtpPayloadType, j, -1);
7756 }
7757
7758 //-----------------------------------------------------------
7759 JSON_SERIALIZED_CLASS(ExternalModule)
7770 {
7771 IMPLEMENT_JSON_SERIALIZATION()
7772 IMPLEMENT_JSON_DOCUMENTATION(ExternalModule)
7773
7774 public:
7776 std::string name;
7777
7779 std::string file;
7780
7782 nlohmann::json configuration;
7783
7785 {
7786 clear();
7787 }
7788
7789 void clear()
7790 {
7791 name.clear();
7792 file.clear();
7793 configuration.clear();
7794 }
7795 };
7796
7797 static void to_json(nlohmann::json& j, const ExternalModule& p)
7798 {
7799 j = nlohmann::json{
7800 TOJSON_IMPL(name),
7801 TOJSON_IMPL(file)
7802 };
7803
7804 if(!p.configuration.empty())
7805 {
7806 j["configuration"] = p.configuration;
7807 }
7808 }
7809 static void from_json(const nlohmann::json& j, ExternalModule& p)
7810 {
7811 p.clear();
7812 getOptional<std::string>("name", p.name, j, EMPTY_STRING);
7813 getOptional<std::string>("file", p.file, j, EMPTY_STRING);
7814
7815 try
7816 {
7817 p.configuration = j.at("configuration");
7818 }
7819 catch(...)
7820 {
7821 p.configuration.clear();
7822 }
7823 }
7824
7825
7826 //-----------------------------------------------------------
7827 JSON_SERIALIZED_CLASS(ExternalCodecDescriptor)
7838 {
7839 IMPLEMENT_JSON_SERIALIZATION()
7840 IMPLEMENT_JSON_DOCUMENTATION(ExternalCodecDescriptor)
7841
7842 public:
7845
7848
7851
7854
7856 {
7857 clear();
7858 }
7859
7860 void clear()
7861 {
7862 rtpPayloadType = -1;
7863 samplingRate = -1;
7864 channels = -1;
7865 rtpTsMultiplier = 0;
7866 }
7867 };
7868
7869 static void to_json(nlohmann::json& j, const ExternalCodecDescriptor& p)
7870 {
7871 j = nlohmann::json{
7872 TOJSON_IMPL(rtpPayloadType),
7873 TOJSON_IMPL(samplingRate),
7874 TOJSON_IMPL(channels),
7875 TOJSON_IMPL(rtpTsMultiplier)
7876 };
7877 }
7878 static void from_json(const nlohmann::json& j, ExternalCodecDescriptor& p)
7879 {
7880 p.clear();
7881
7882 getOptional<int>("rtpPayloadType", p.rtpPayloadType, j, -1);
7883 getOptional<int>("samplingRate", p.samplingRate, j, -1);
7884 getOptional<int>("channels", p.channels, j, -1);
7885 getOptional<int>("rtpTsMultiplier", p.rtpTsMultiplier, j, -1);
7886 }
7887
7888 //-----------------------------------------------------------
7889 JSON_SERIALIZED_CLASS(EngineStatusReportConfiguration)
7900 {
7901 IMPLEMENT_JSON_SERIALIZATION()
7902 IMPLEMENT_JSON_DOCUMENTATION(EngineStatusReportConfiguration)
7903
7904 public:
7906 std::string fileName;
7907
7910
7913
7915 std::string runCmd;
7916
7919
7922
7924 {
7925 clear();
7926 }
7927
7928 void clear()
7929 {
7930 fileName.clear();
7931 intervalSecs = 60;
7932 enabled = false;
7933 includeMemoryDetail = false;
7934 includeTaskQueueDetail = false;
7935 runCmd.clear();
7936 }
7937 };
7938
7939 static void to_json(nlohmann::json& j, const EngineStatusReportConfiguration& p)
7940 {
7941 j = nlohmann::json{
7942 TOJSON_IMPL(fileName),
7943 TOJSON_IMPL(intervalSecs),
7944 TOJSON_IMPL(enabled),
7945 TOJSON_IMPL(includeMemoryDetail),
7946 TOJSON_IMPL(includeTaskQueueDetail),
7947 TOJSON_IMPL(runCmd)
7948 };
7949 }
7950 static void from_json(const nlohmann::json& j, EngineStatusReportConfiguration& p)
7951 {
7952 p.clear();
7953 getOptional<std::string>("fileName", p.fileName, j);
7954 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
7955 getOptional<bool>("enabled", p.enabled, j, false);
7956 getOptional<std::string>("runCmd", p.runCmd, j);
7957 getOptional<bool>("includeMemoryDetail", p.includeMemoryDetail, j, false);
7958 getOptional<bool>("includeTaskQueueDetail", p.includeTaskQueueDetail, j, false);
7959 }
7960
7961 //-----------------------------------------------------------
7962 JSON_SERIALIZED_CLASS(EnginePolicy)
7975 {
7976 IMPLEMENT_JSON_SERIALIZATION()
7977 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicy)
7978
7979 public:
7980
7982 std::string dataDirectory;
7983
7986
7989
7992
7995
7998
8001
8004
8007
8010
8013
8016
8018 std::vector<ExternalModule> externalCodecs;
8019
8021 std::vector<RtpMapEntry> rtpMap;
8022
8025
8026 EnginePolicy()
8027 {
8028 clear();
8029 }
8030
8031 void clear()
8032 {
8033 dataDirectory.clear();
8034 licensing.clear();
8035 security.clear();
8036 networking.clear();
8037 audio.clear();
8038 discovery.clear();
8039 logging.clear();
8040 internals.clear();
8041 timelines.clear();
8042 database.clear();
8043 featureset.clear();
8044 namedAudioDevices.clear();
8045 externalCodecs.clear();
8046 rtpMap.clear();
8047 statusReport.clear();
8048 }
8049 };
8050
8051 static void to_json(nlohmann::json& j, const EnginePolicy& p)
8052 {
8053 j = nlohmann::json{
8054 TOJSON_IMPL(dataDirectory),
8055 TOJSON_IMPL(licensing),
8056 TOJSON_IMPL(security),
8057 TOJSON_IMPL(networking),
8058 TOJSON_IMPL(audio),
8059 TOJSON_IMPL(discovery),
8060 TOJSON_IMPL(logging),
8061 TOJSON_IMPL(internals),
8062 TOJSON_IMPL(timelines),
8063 TOJSON_IMPL(database),
8064 TOJSON_IMPL(featureset),
8065 TOJSON_IMPL(namedAudioDevices),
8066 TOJSON_IMPL(externalCodecs),
8067 TOJSON_IMPL(rtpMap),
8068 TOJSON_IMPL(statusReport)
8069 };
8070 }
8071 static void from_json(const nlohmann::json& j, EnginePolicy& p)
8072 {
8073 p.clear();
8074 FROMJSON_IMPL_SIMPLE(dataDirectory);
8075 FROMJSON_IMPL_SIMPLE(licensing);
8076 FROMJSON_IMPL_SIMPLE(security);
8077 FROMJSON_IMPL_SIMPLE(networking);
8078 FROMJSON_IMPL_SIMPLE(audio);
8079 FROMJSON_IMPL_SIMPLE(discovery);
8080 FROMJSON_IMPL_SIMPLE(logging);
8081 FROMJSON_IMPL_SIMPLE(internals);
8082 FROMJSON_IMPL_SIMPLE(timelines);
8083 FROMJSON_IMPL_SIMPLE(database);
8084 FROMJSON_IMPL_SIMPLE(featureset);
8085 FROMJSON_IMPL_SIMPLE(namedAudioDevices);
8086 FROMJSON_IMPL_SIMPLE(externalCodecs);
8087 FROMJSON_IMPL_SIMPLE(rtpMap);
8088 FROMJSON_IMPL_SIMPLE(statusReport);
8089 }
8090
8091
8092 //-----------------------------------------------------------
8093 JSON_SERIALIZED_CLASS(TalkgroupAsset)
8104 {
8105 IMPLEMENT_JSON_SERIALIZATION()
8106 IMPLEMENT_JSON_DOCUMENTATION(TalkgroupAsset)
8107
8108 public:
8109
8111 std::string nodeId;
8112
8115
8117 {
8118 clear();
8119 }
8120
8121 void clear()
8122 {
8123 nodeId.clear();
8124 group.clear();
8125 }
8126 };
8127
8128 static void to_json(nlohmann::json& j, const TalkgroupAsset& p)
8129 {
8130 j = nlohmann::json{
8131 TOJSON_IMPL(nodeId),
8132 TOJSON_IMPL(group)
8133 };
8134 }
8135 static void from_json(const nlohmann::json& j, TalkgroupAsset& p)
8136 {
8137 p.clear();
8138 getOptional<std::string>("nodeId", p.nodeId, j);
8139 getOptional<Group>("group", p.group, j);
8140 }
8141
8142 //-----------------------------------------------------------
8143 JSON_SERIALIZED_CLASS(EngageDiscoveredGroup)
8152 {
8153 IMPLEMENT_JSON_SERIALIZATION()
8154 IMPLEMENT_JSON_DOCUMENTATION(EngageDiscoveredGroup)
8155
8156 public:
8158 std::string id;
8159
8161 int type;
8162
8165
8168
8170 {
8171 clear();
8172 }
8173
8174 void clear()
8175 {
8176 id.clear();
8177 type = 0;
8178 rx.clear();
8179 tx.clear();
8180 }
8181 };
8182
8183 static void to_json(nlohmann::json& j, const EngageDiscoveredGroup& p)
8184 {
8185 j = nlohmann::json{
8186 TOJSON_IMPL(id),
8187 TOJSON_IMPL(type),
8188 TOJSON_IMPL(rx),
8189 TOJSON_IMPL(tx)
8190 };
8191 }
8192 static void from_json(const nlohmann::json& j, EngageDiscoveredGroup& p)
8193 {
8194 p.clear();
8195 getOptional<std::string>("id", p.id, j);
8196 getOptional<int>("type", p.type, j, 0);
8197 getOptional<NetworkAddress>("rx", p.rx, j);
8198 getOptional<NetworkAddress>("tx", p.tx, j);
8199 }
8200
8201 //-----------------------------------------------------------
8202 JSON_SERIALIZED_CLASS(RallypointPeer)
8213 {
8214 IMPLEMENT_JSON_SERIALIZATION()
8215 IMPLEMENT_JSON_DOCUMENTATION(RallypointPeer)
8216
8217 public:
8218 typedef enum
8219 {
8221 olpUseRpConfiguration = 0,
8222
8224 olpIsMeshLeaf = 1,
8225
8227 olpNotMeshLeaf = 2
8228 } OutboundLeafPolicy_t;
8229
8230 typedef enum
8231 {
8233 olpUseRpWebSocketTlsConfiguration = 0,
8234
8236 olpUseTlsForWebSocket = 1,
8237
8239 olpDoNotUseTlsForWebSocket = 2
8240 } OutboundWebSocketTlsPolicy_t;
8241
8243 std::string id;
8244
8247
8250
8253
8256
8259
8260 OutboundLeafPolicy_t outboundLeafPolicy;
8261
8264
8266 std::string path;
8267
8270
8273
8275 {
8276 clear();
8277 }
8278
8279 void clear()
8280 {
8281 id.clear();
8282 enabled = true;
8283 host.clear();
8284 certificate.clear();
8285 connectionTimeoutSecs = 0;
8286 forceIsMeshLeaf = false;
8287 outboundLeafPolicy = OutboundLeafPolicy_t::olpUseRpConfiguration;
8288 protocol = Rallypoint::RpProtocol_t::rppTlsTcp;
8289 path.clear();
8290 additionalProtocols.clear();
8291 outboundWebSocketTlsPolicy = OutboundWebSocketTlsPolicy_t::olpUseRpWebSocketTlsConfiguration;
8292 }
8293 };
8294
8295 static void to_json(nlohmann::json& j, const RallypointPeer& p)
8296 {
8297 j = nlohmann::json{
8298 TOJSON_IMPL(id),
8299 TOJSON_IMPL(enabled),
8300 TOJSON_IMPL(host),
8301 TOJSON_IMPL(certificate),
8302 TOJSON_IMPL(connectionTimeoutSecs),
8303 TOJSON_IMPL(forceIsMeshLeaf),
8304 TOJSON_IMPL(outboundLeafPolicy),
8305 TOJSON_IMPL(protocol),
8306 TOJSON_IMPL(path),
8307 TOJSON_IMPL(additionalProtocols),
8308 TOJSON_IMPL(outboundWebSocketTlsPolicy)
8309 };
8310 }
8311 static void from_json(const nlohmann::json& j, RallypointPeer& p)
8312 {
8313 p.clear();
8314 j.at("id").get_to(p.id);
8315 getOptional<bool>("enabled", p.enabled, j, true);
8316 getOptional<NetworkAddress>("host", p.host, j);
8317 getOptional<SecurityCertificate>("certificate", p.certificate, j);
8318 getOptional<int>("connectionTimeoutSecs", p.connectionTimeoutSecs, j, 0);
8319 getOptional<bool>("forceIsMeshLeaf", p.forceIsMeshLeaf, j, false);
8320 getOptional<RallypointPeer::OutboundLeafPolicy_t>("outboundLeafPolicy", p.outboundLeafPolicy, j, RallypointPeer::OutboundLeafPolicy_t::olpUseRpConfiguration);
8321 getOptional<Rallypoint::RpProtocol_t>("protocol", p.protocol, j, Rallypoint::RpProtocol_t::rppTlsTcp);
8322 getOptional<std::string>("path", p.path, j);
8323 getOptional<std::string>("additionalProtocols", p.additionalProtocols, j);
8324 getOptional<RallypointPeer::OutboundWebSocketTlsPolicy_t>("outboundWebSocketTlsPolicy", p.outboundWebSocketTlsPolicy, j, RallypointPeer::OutboundWebSocketTlsPolicy_t::olpUseRpWebSocketTlsConfiguration);
8325 }
8326
8327 //-----------------------------------------------------------
8328 JSON_SERIALIZED_CLASS(RallypointServerLimits)
8339 {
8340 IMPLEMENT_JSON_SERIALIZATION()
8341 IMPLEMENT_JSON_DOCUMENTATION(RallypointServerLimits)
8342
8343 public:
8345 uint32_t maxClients;
8346
8348 uint32_t maxPeers;
8349
8352
8355
8358
8361
8364
8367
8370
8373
8376
8379
8382
8385
8388
8390 {
8391 clear();
8392 }
8393
8394 void clear()
8395 {
8396 maxClients = 0;
8397 maxPeers = 0;
8398 maxMulticastReflectors = 0;
8399 maxRegisteredStreams = 0;
8400 maxStreamPaths = 0;
8401 maxRxPacketsPerSec = 0;
8402 maxTxPacketsPerSec = 0;
8403 maxRxBytesPerSec = 0;
8404 maxTxBytesPerSec = 0;
8405 maxQOpsPerSec = 0;
8406 maxInboundBacklog = 64;
8407 lowPriorityQueueThreshold = 64;
8408 normalPriorityQueueThreshold = 256;
8409 denyNewConnectionCpuThreshold = 75;
8410 warnAtCpuThreshold = 65;
8411 }
8412 };
8413
8414 static void to_json(nlohmann::json& j, const RallypointServerLimits& p)
8415 {
8416 j = nlohmann::json{
8417 TOJSON_IMPL(maxClients),
8418 TOJSON_IMPL(maxPeers),
8419 TOJSON_IMPL(maxMulticastReflectors),
8420 TOJSON_IMPL(maxRegisteredStreams),
8421 TOJSON_IMPL(maxStreamPaths),
8422 TOJSON_IMPL(maxRxPacketsPerSec),
8423 TOJSON_IMPL(maxTxPacketsPerSec),
8424 TOJSON_IMPL(maxRxBytesPerSec),
8425 TOJSON_IMPL(maxTxBytesPerSec),
8426 TOJSON_IMPL(maxQOpsPerSec),
8427 TOJSON_IMPL(maxInboundBacklog),
8428 TOJSON_IMPL(lowPriorityQueueThreshold),
8429 TOJSON_IMPL(normalPriorityQueueThreshold),
8430 TOJSON_IMPL(denyNewConnectionCpuThreshold),
8431 TOJSON_IMPL(warnAtCpuThreshold)
8432 };
8433 }
8434 static void from_json(const nlohmann::json& j, RallypointServerLimits& p)
8435 {
8436 p.clear();
8437 getOptional<uint32_t>("maxClients", p.maxClients, j, 0);
8438 getOptional<uint32_t>("maxPeers", p.maxPeers, j, 0);
8439 getOptional<uint32_t>("maxMulticastReflectors", p.maxMulticastReflectors, j, 0);
8440 getOptional<uint32_t>("maxRegisteredStreams", p.maxRegisteredStreams, j, 0);
8441 getOptional<uint32_t>("maxStreamPaths", p.maxStreamPaths, j, 0);
8442 getOptional<uint32_t>("maxRxPacketsPerSec", p.maxRxPacketsPerSec, j, 0);
8443 getOptional<uint32_t>("maxTxPacketsPerSec", p.maxTxPacketsPerSec, j, 0);
8444 getOptional<uint32_t>("maxRxBytesPerSec", p.maxRxBytesPerSec, j, 0);
8445 getOptional<uint32_t>("maxTxBytesPerSec", p.maxTxBytesPerSec, j, 0);
8446 getOptional<uint32_t>("maxQOpsPerSec", p.maxQOpsPerSec, j, 0);
8447 getOptional<uint32_t>("maxInboundBacklog", p.maxInboundBacklog, j, 64);
8448 getOptional<uint32_t>("lowPriorityQueueThreshold", p.lowPriorityQueueThreshold, j, 64);
8449 getOptional<uint32_t>("normalPriorityQueueThreshold", p.normalPriorityQueueThreshold, j, 256);
8450 getOptional<uint32_t>("denyNewConnectionCpuThreshold", p.denyNewConnectionCpuThreshold, j, 75);
8451 getOptional<uint32_t>("warnAtCpuThreshold", p.warnAtCpuThreshold, j, 65);
8452 }
8453
8454 //-----------------------------------------------------------
8455 JSON_SERIALIZED_CLASS(RallypointServerStatusReportConfiguration)
8466 {
8467 IMPLEMENT_JSON_SERIALIZATION()
8468 IMPLEMENT_JSON_DOCUMENTATION(RallypointServerStatusReportConfiguration)
8469
8470 public:
8472 std::string fileName;
8473
8476
8479
8482
8485
8488
8490 std::string runCmd;
8491
8493 {
8494 clear();
8495 }
8496
8497 void clear()
8498 {
8499 fileName.clear();
8500 intervalSecs = 60;
8501 enabled = false;
8502 includeLinks = false;
8503 includePeerLinkDetails = false;
8504 includeClientLinkDetails = false;
8505 runCmd.clear();
8506 }
8507 };
8508
8509 static void to_json(nlohmann::json& j, const RallypointServerStatusReportConfiguration& p)
8510 {
8511 j = nlohmann::json{
8512 TOJSON_IMPL(fileName),
8513 TOJSON_IMPL(intervalSecs),
8514 TOJSON_IMPL(enabled),
8515 TOJSON_IMPL(includeLinks),
8516 TOJSON_IMPL(includePeerLinkDetails),
8517 TOJSON_IMPL(includeClientLinkDetails),
8518 TOJSON_IMPL(runCmd)
8519 };
8520 }
8521 static void from_json(const nlohmann::json& j, RallypointServerStatusReportConfiguration& p)
8522 {
8523 p.clear();
8524 getOptional<std::string>("fileName", p.fileName, j);
8525 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
8526 getOptional<bool>("enabled", p.enabled, j, false);
8527 getOptional<bool>("includeLinks", p.includeLinks, j, false);
8528 getOptional<bool>("includePeerLinkDetails", p.includePeerLinkDetails, j, false);
8529 getOptional<bool>("includeClientLinkDetails", p.includeClientLinkDetails, j, false);
8530 getOptional<std::string>("runCmd", p.runCmd, j);
8531 }
8532
8533 //-----------------------------------------------------------
8534 JSON_SERIALIZED_CLASS(RallypointServerLinkGraph)
8536 {
8537 IMPLEMENT_JSON_SERIALIZATION()
8538 IMPLEMENT_JSON_DOCUMENTATION(RallypointServerLinkGraph)
8539
8540 public:
8542 std::string fileName;
8543
8546
8549
8552
8557
8559 std::string coreRpStyling;
8560
8562 std::string leafRpStyling;
8563
8565 std::string clientStyling;
8566
8568 std::string runCmd;
8569
8571 {
8572 clear();
8573 }
8574
8575 void clear()
8576 {
8577 fileName.clear();
8578 minRefreshSecs = 5;
8579 enabled = false;
8580 includeDigraphEnclosure = true;
8581 includeClients = false;
8582 coreRpStyling = "[shape=hexagon color=firebrick style=filled]";
8583 leafRpStyling = "[shape=box color=gray style=filled]";
8584 clientStyling.clear();
8585 runCmd.clear();
8586 }
8587 };
8588
8589 static void to_json(nlohmann::json& j, const RallypointServerLinkGraph& p)
8590 {
8591 j = nlohmann::json{
8592 TOJSON_IMPL(fileName),
8593 TOJSON_IMPL(minRefreshSecs),
8594 TOJSON_IMPL(enabled),
8595 TOJSON_IMPL(includeDigraphEnclosure),
8596 TOJSON_IMPL(includeClients),
8597 TOJSON_IMPL(coreRpStyling),
8598 TOJSON_IMPL(leafRpStyling),
8599 TOJSON_IMPL(clientStyling),
8600 TOJSON_IMPL(runCmd)
8601 };
8602 }
8603 static void from_json(const nlohmann::json& j, RallypointServerLinkGraph& p)
8604 {
8605 p.clear();
8606 getOptional<std::string>("fileName", p.fileName, j);
8607 getOptional<int>("minRefreshSecs", p.minRefreshSecs, j, 5);
8608 getOptional<bool>("enabled", p.enabled, j, false);
8609 getOptional<bool>("includeDigraphEnclosure", p.includeDigraphEnclosure, j, true);
8610 getOptional<bool>("includeClients", p.includeClients, j, false);
8611 getOptional<std::string>("coreRpStyling", p.coreRpStyling, j, "[shape=hexagon color=firebrick style=filled]");
8612 getOptional<std::string>("leafRpStyling", p.leafRpStyling, j, "[shape=box color=gray style=filled]");
8613 getOptional<std::string>("clientStyling", p.clientStyling, j);
8614 getOptional<std::string>("runCmd", p.runCmd, j);
8615 }
8616
8617
8618 //-----------------------------------------------------------
8619 JSON_SERIALIZED_CLASS(RallypointServerStreamStatsExport)
8628 {
8629 IMPLEMENT_JSON_SERIALIZATION()
8630 IMPLEMENT_JSON_DOCUMENTATION(RallypointServerStreamStatsExport)
8631
8632 public:
8634 typedef enum
8635 {
8637 fmtCsv = 0,
8638
8640 fmtJson = 1
8641 } ExportFormat_t;
8642
8644 std::string fileName;
8645
8648
8651
8654
8656 std::string runCmd;
8657
8660
8661
8663 {
8664 clear();
8665 }
8666
8667 void clear()
8668 {
8669 fileName.clear();
8670 intervalSecs = 60;
8671 enabled = false;
8672 resetCountersAfterExport = false;
8673 runCmd.clear();
8674 format = fmtJson;
8675 }
8676 };
8677
8678 static void to_json(nlohmann::json& j, const RallypointServerStreamStatsExport& p)
8679 {
8680 j = nlohmann::json{
8681 TOJSON_IMPL(fileName),
8682 TOJSON_IMPL(intervalSecs),
8683 TOJSON_IMPL(enabled),
8684 TOJSON_IMPL(resetCountersAfterExport),
8685 TOJSON_IMPL(runCmd),
8686 TOJSON_IMPL(format)
8687 };
8688 }
8689 static void from_json(const nlohmann::json& j, RallypointServerStreamStatsExport& p)
8690 {
8691 p.clear();
8692 getOptional<std::string>("fileName", p.fileName, j);
8693 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
8694 getOptional<bool>("enabled", p.enabled, j, false);
8695 getOptional<bool>("resetCountersAfterExport", p.resetCountersAfterExport, j, false);
8696 getOptional<std::string>("runCmd", p.runCmd, j);
8697 getOptional<RallypointServerStreamStatsExport::ExportFormat_t>("format", p.format, j, RallypointServerStreamStatsExport::ExportFormat_t::fmtCsv);
8698 }
8699
8700 //-----------------------------------------------------------
8701 JSON_SERIALIZED_CLASS(RallypointServerRouteMap)
8703 {
8704 IMPLEMENT_JSON_SERIALIZATION()
8705 IMPLEMENT_JSON_DOCUMENTATION(RallypointServerRouteMap)
8706
8707 public:
8709 std::string fileName;
8710
8713
8716
8718 std::string runCmd;
8719
8721 {
8722 clear();
8723 }
8724
8725 void clear()
8726 {
8727 fileName.clear();
8728 minRefreshSecs = 5;
8729 enabled = false;
8730 }
8731 };
8732
8733 static void to_json(nlohmann::json& j, const RallypointServerRouteMap& p)
8734 {
8735 j = nlohmann::json{
8736 TOJSON_IMPL(fileName),
8737 TOJSON_IMPL(minRefreshSecs),
8738 TOJSON_IMPL(enabled),
8739 TOJSON_IMPL(runCmd)
8740 };
8741 }
8742 static void from_json(const nlohmann::json& j, RallypointServerRouteMap& p)
8743 {
8744 p.clear();
8745 getOptional<std::string>("fileName", p.fileName, j);
8746 getOptional<int>("minRefreshSecs", p.minRefreshSecs, j, 5);
8747 getOptional<bool>("enabled", p.enabled, j, false);
8748 getOptional<std::string>("runCmd", p.runCmd, j);
8749 }
8750
8751
8752 //-----------------------------------------------------------
8753 JSON_SERIALIZED_CLASS(ExternalHealthCheckResponder)
8764 {
8765 IMPLEMENT_JSON_SERIALIZATION()
8766 IMPLEMENT_JSON_DOCUMENTATION(ExternalHealthCheckResponder)
8767
8768 public:
8769
8772
8775
8777 {
8778 clear();
8779 }
8780
8781 void clear()
8782 {
8783 listenPort = 0;
8784 immediateClose = true;
8785 }
8786 };
8787
8788 static void to_json(nlohmann::json& j, const ExternalHealthCheckResponder& p)
8789 {
8790 j = nlohmann::json{
8791 TOJSON_IMPL(listenPort),
8792 TOJSON_IMPL(immediateClose)
8793 };
8794 }
8795 static void from_json(const nlohmann::json& j, ExternalHealthCheckResponder& p)
8796 {
8797 p.clear();
8798 getOptional<int>("listenPort", p.listenPort, j, 0);
8799 getOptional<bool>("immediateClose", p.immediateClose, j, true);
8800 }
8801
8802
8803 //-----------------------------------------------------------
8804 JSON_SERIALIZED_CLASS(PeeringConfiguration)
8813 {
8814 IMPLEMENT_JSON_SERIALIZATION()
8815 IMPLEMENT_JSON_DOCUMENTATION(PeeringConfiguration)
8816
8817 public:
8818
8820 std::string id;
8821
8824
8826 std::string comments;
8827
8829 std::vector<RallypointPeer> peers;
8830
8832 {
8833 clear();
8834 }
8835
8836 void clear()
8837 {
8838 id.clear();
8839 version = 0;
8840 comments.clear();
8841 }
8842 };
8843
8844 static void to_json(nlohmann::json& j, const PeeringConfiguration& p)
8845 {
8846 j = nlohmann::json{
8847 TOJSON_IMPL(id),
8848 TOJSON_IMPL(version),
8849 TOJSON_IMPL(comments),
8850 TOJSON_IMPL(peers)
8851 };
8852 }
8853 static void from_json(const nlohmann::json& j, PeeringConfiguration& p)
8854 {
8855 p.clear();
8856 getOptional<std::string>("id", p.id, j);
8857 getOptional<int>("version", p.version, j, 0);
8858 getOptional<std::string>("comments", p.comments, j);
8859 getOptional<std::vector<RallypointPeer>>("peers", p.peers, j);
8860 }
8861
8862 //-----------------------------------------------------------
8863 JSON_SERIALIZED_CLASS(IgmpSnooping)
8872 {
8873 IMPLEMENT_JSON_SERIALIZATION()
8874 IMPLEMENT_JSON_DOCUMENTATION(IgmpSnooping)
8875
8876 public:
8877
8880
8883
8886
8887
8888 IgmpSnooping()
8889 {
8890 clear();
8891 }
8892
8893 void clear()
8894 {
8895 enabled = false;
8896 queryIntervalMs = 125000;
8897 subscriptionTimeoutMs = 0;
8898 }
8899 };
8900
8901 static void to_json(nlohmann::json& j, const IgmpSnooping& p)
8902 {
8903 j = nlohmann::json{
8904 TOJSON_IMPL(enabled),
8905 TOJSON_IMPL(queryIntervalMs),
8906 TOJSON_IMPL(subscriptionTimeoutMs)
8907 };
8908 }
8909 static void from_json(const nlohmann::json& j, IgmpSnooping& p)
8910 {
8911 p.clear();
8912 getOptional<bool>("enabled", p.enabled, j);
8913 getOptional<int>("queryIntervalMs", p.queryIntervalMs, j, 125000);
8914 getOptional<int>("subscriptionTimeoutMs", p.subscriptionTimeoutMs, j, 0);
8915 }
8916
8917
8918 //-----------------------------------------------------------
8919 JSON_SERIALIZED_CLASS(RallypointReflector)
8927 {
8928 IMPLEMENT_JSON_SERIALIZATION()
8929 IMPLEMENT_JSON_DOCUMENTATION(RallypointReflector)
8930
8931 public:
8933 typedef enum
8934 {
8936 drNone = 0,
8937
8939 drRxOnly = 1,
8940
8942 drTxOnly = 2
8943 } DirectionRestriction_t;
8944
8948 std::string id;
8949
8952
8955
8958
8960 std::vector<NetworkAddress> additionalTx;
8961
8964
8966 {
8967 clear();
8968 }
8969
8970 void clear()
8971 {
8972 id.clear();
8973 rx.clear();
8974 tx.clear();
8975 multicastInterfaceName.clear();
8976 additionalTx.clear();
8977 directionRestriction = drNone;
8978 }
8979 };
8980
8981 static void to_json(nlohmann::json& j, const RallypointReflector& p)
8982 {
8983 j = nlohmann::json{
8984 TOJSON_IMPL(id),
8985 TOJSON_IMPL(rx),
8986 TOJSON_IMPL(tx),
8987 TOJSON_IMPL(multicastInterfaceName),
8988 TOJSON_IMPL(additionalTx),
8989 TOJSON_IMPL(directionRestriction)
8990 };
8991 }
8992 static void from_json(const nlohmann::json& j, RallypointReflector& p)
8993 {
8994 p.clear();
8995 j.at("id").get_to(p.id);
8996 j.at("rx").get_to(p.rx);
8997 j.at("tx").get_to(p.tx);
8998 getOptional<std::string>("multicastInterfaceName", p.multicastInterfaceName, j);
8999 getOptional<std::vector<NetworkAddress>>("additionalTx", p.additionalTx, j);
9000 getOptional<RallypointReflector::DirectionRestriction_t>("directionRestriction", p.directionRestriction, j, RallypointReflector::DirectionRestriction_t::drNone);
9001 }
9002
9003
9004 //-----------------------------------------------------------
9005 JSON_SERIALIZED_CLASS(RallypointUdpStreamingIpvX)
9013 {
9014 IMPLEMENT_JSON_SERIALIZATION()
9015 IMPLEMENT_JSON_DOCUMENTATION(RallypointUdpStreamingIpvX)
9016
9017 public:
9020
9023
9025 {
9026 clear();
9027 }
9028
9029 void clear()
9030 {
9031 enabled = true;
9032 external.clear();
9033 }
9034 };
9035
9036 static void to_json(nlohmann::json& j, const RallypointUdpStreamingIpvX& p)
9037 {
9038 j = nlohmann::json{
9039 TOJSON_IMPL(enabled),
9040 TOJSON_IMPL(external)
9041 };
9042 }
9043 static void from_json(const nlohmann::json& j, RallypointUdpStreamingIpvX& p)
9044 {
9045 p.clear();
9046 getOptional<bool>("enabled", p.enabled, j, true);
9047 getOptional<NetworkAddress>("external", p.external, j);
9048 }
9049
9050 //-----------------------------------------------------------
9051 JSON_SERIALIZED_CLASS(RallypointUdpStreaming)
9059 {
9060 IMPLEMENT_JSON_SERIALIZATION()
9061 IMPLEMENT_JSON_DOCUMENTATION(RallypointUdpStreaming)
9062
9063 public:
9065 typedef enum
9066 {
9068 ctUnknown = 0,
9069
9071 ctSharedKeyAes256FullIv = 1,
9072
9074 ctSharedKeyAes256IdxIv = 2,
9075
9077 ctSharedKeyChaCha20FullIv = 3,
9078
9080 ctSharedKeyChaCha20IdxIv = 4
9081 } CryptoType_t;
9082
9085
9088
9091
9094
9097
9100
9103
9105 int ttl;
9106
9107
9109 {
9110 clear();
9111 }
9112
9113 void clear()
9114 {
9115 enabled = true;
9116 cryptoType = CryptoType_t::ctSharedKeyAes256FullIv;
9117 listenPort = 7444;
9118 ipv4.clear();
9119 ipv6.clear();
9120 keepaliveIntervalSecs = 15;
9121 priority = TxPriority_t::priVoice;
9122 ttl = 64;
9123 }
9124 };
9125
9126 static void to_json(nlohmann::json& j, const RallypointUdpStreaming& p)
9127 {
9128 j = nlohmann::json{
9129 TOJSON_IMPL(enabled),
9130 TOJSON_IMPL(cryptoType),
9131 TOJSON_IMPL(listenPort),
9132 TOJSON_IMPL(keepaliveIntervalSecs),
9133 TOJSON_IMPL(ipv4),
9134 TOJSON_IMPL(ipv6),
9135 TOJSON_IMPL(priority),
9136 TOJSON_IMPL(ttl)
9137 };
9138 }
9139 static void from_json(const nlohmann::json& j, RallypointUdpStreaming& p)
9140 {
9141 p.clear();
9142 getOptional<bool>("enabled", p.enabled, j, true);
9143 getOptional<RallypointUdpStreaming::CryptoType_t>("cryptoType", p.cryptoType, j, RallypointUdpStreaming::CryptoType_t::ctSharedKeyAes256FullIv);
9144 getOptional<int>("listenPort", p.listenPort, j, 7444);
9145 getOptional<int>("keepaliveIntervalSecs", p.keepaliveIntervalSecs, j, 15);
9146 getOptional<RallypointUdpStreamingIpvX>("ipv4", p.ipv4, j);
9147 getOptional<RallypointUdpStreamingIpvX>("ipv6", p.ipv6, j);
9148 getOptional<TxPriority_t>("priority", p.priority, j, TxPriority_t::priVoice);
9149 getOptional<int>("ttl", p.ttl, j, 64);
9150 }
9151
9152 //-----------------------------------------------------------
9153 JSON_SERIALIZED_CLASS(RallypointRpRtTimingBehavior)
9161 {
9162 IMPLEMENT_JSON_SERIALIZATION()
9163 IMPLEMENT_JSON_DOCUMENTATION(RallypointRpRtTimingBehavior)
9164
9165 public:
9167 typedef enum
9168 {
9171
9174
9177
9180
9182 btDrop = 99
9183 } BehaviorType_t;
9184
9187
9189 uint32_t atOrAboveMs;
9190
9192 std::string runCmd;
9193
9195 {
9196 clear();
9197 }
9198
9199 void clear()
9200 {
9201 behavior = btNone;
9202 atOrAboveMs = 0;
9203 runCmd.clear();
9204 }
9205 };
9206
9207 static void to_json(nlohmann::json& j, const RallypointRpRtTimingBehavior& p)
9208 {
9209 j = nlohmann::json{
9210 TOJSON_IMPL(behavior),
9211 TOJSON_IMPL(atOrAboveMs),
9212 TOJSON_IMPL(runCmd)
9213 };
9214 }
9215 static void from_json(const nlohmann::json& j, RallypointRpRtTimingBehavior& p)
9216 {
9217 p.clear();
9218 getOptional<RallypointRpRtTimingBehavior::BehaviorType_t>("behavior", p.behavior, j, RallypointRpRtTimingBehavior::BehaviorType_t::btNone);
9219 getOptional<uint32_t>("atOrAboveMs", p.atOrAboveMs, j, 0);
9220 getOptional<std::string>("runCmd", p.runCmd, j);
9221 }
9222
9223
9224 //-----------------------------------------------------------
9225 JSON_SERIALIZED_CLASS(RallypointWebsocketSettings)
9233 {
9234 IMPLEMENT_JSON_SERIALIZATION()
9235 IMPLEMENT_JSON_DOCUMENTATION(RallypointWebsocketSettings)
9236
9237 public:
9240
9243
9246
9249
9252
9254 {
9255 clear();
9256 }
9257
9258 void clear()
9259 {
9260 enabled = false;
9261 listenPort = 8443;
9262 certificate.clear();
9263 requireClientCertificate = false;
9264 requireTls = true;
9265 }
9266 };
9267
9268 static void to_json(nlohmann::json& j, const RallypointWebsocketSettings& p)
9269 {
9270 j = nlohmann::json{
9271 TOJSON_IMPL(enabled),
9272 TOJSON_IMPL(listenPort),
9273 TOJSON_IMPL(certificate),
9274 TOJSON_IMPL(requireClientCertificate),
9275 TOJSON_IMPL(requireTls)
9276 };
9277 }
9278 static void from_json(const nlohmann::json& j, RallypointWebsocketSettings& p)
9279 {
9280 p.clear();
9281 getOptional<bool>("enabled", p.enabled, j, false);
9282 getOptional<int>("listenPort", p.listenPort, j, 8443);
9283 getOptional<SecurityCertificate>("certificate", p.certificate, j);
9284 getOptional<bool>("requireClientCertificate", p.requireClientCertificate, j, false);
9285 getOptional<bool>("requireTls", p.requireTls, j, true);
9286 }
9287
9288
9289
9290 //-----------------------------------------------------------
9291 JSON_SERIALIZED_CLASS(RallypointAdvertisingSettings)
9299 {
9300 IMPLEMENT_JSON_SERIALIZATION()
9301 IMPLEMENT_JSON_DOCUMENTATION(RallypointAdvertisingSettings)
9302
9303 public:
9306
9308 std::string hostName;
9309
9311 std::string serviceName;
9312
9314 std::string interfaceName;
9315
9317 int port;
9318
9320 int ttl;
9321
9323 {
9324 clear();
9325 }
9326
9327 void clear()
9328 {
9329 enabled = false;
9330 hostName.clear();
9331 serviceName = "_rallypoint._tcp.local.";
9332 interfaceName.clear();
9333 port = 0;
9334 ttl = 60;
9335 }
9336 };
9337
9338 static void to_json(nlohmann::json& j, const RallypointAdvertisingSettings& p)
9339 {
9340 j = nlohmann::json{
9341 TOJSON_IMPL(enabled),
9342 TOJSON_IMPL(hostName),
9343 TOJSON_IMPL(serviceName),
9344 TOJSON_IMPL(interfaceName),
9345 TOJSON_IMPL(port),
9346 TOJSON_IMPL(ttl)
9347 };
9348 }
9349 static void from_json(const nlohmann::json& j, RallypointAdvertisingSettings& p)
9350 {
9351 p.clear();
9352 getOptional<bool>("enabled", p.enabled, j, false);
9353 getOptional<std::string>("hostName", p.hostName, j);
9354 getOptional<std::string>("serviceName", p.serviceName, j, "_rallypoint._tcp.local.");
9355 getOptional<std::string>("interfaceName", p.interfaceName, j);
9356
9357 getOptional<int>("port", p.port, j, 0);
9358 getOptional<int>("ttl", p.ttl, j, 60);
9359 }
9360
9361
9362
9363
9364 //-----------------------------------------------------------
9365 JSON_SERIALIZED_CLASS(NamedIdentity)
9373 {
9374 IMPLEMENT_JSON_SERIALIZATION()
9375 IMPLEMENT_JSON_DOCUMENTATION(NamedIdentity)
9376
9377 public:
9379 std::string name;
9380
9383
9385 {
9386 clear();
9387 }
9388
9389 void clear()
9390 {
9391 name.clear();
9392 certificate.clear();
9393 }
9394 };
9395
9396 static void to_json(nlohmann::json& j, const NamedIdentity& p)
9397 {
9398 j = nlohmann::json{
9399 TOJSON_IMPL(name),
9400 TOJSON_IMPL(certificate)
9401 };
9402 }
9403 static void from_json(const nlohmann::json& j, NamedIdentity& p)
9404 {
9405 p.clear();
9406 getOptional<std::string>("name", p.name, j);
9407 getOptional<SecurityCertificate>("certificate", p.certificate, j);
9408 }
9409
9410 //-----------------------------------------------------------
9411 JSON_SERIALIZED_CLASS(RallypointExtendedGroupRestriction)
9419 {
9420 IMPLEMENT_JSON_SERIALIZATION()
9421 IMPLEMENT_JSON_DOCUMENTATION(RallypointExtendedGroupRestriction)
9422
9423 public:
9425 std::string id;
9426
9428 std::vector<StringRestrictionList> restrictions;
9429
9431 {
9432 clear();
9433 }
9434
9435 void clear()
9436 {
9437 id.clear();
9438 restrictions.clear();
9439 }
9440 };
9441
9442 static void to_json(nlohmann::json& j, const RallypointExtendedGroupRestriction& p)
9443 {
9444 j = nlohmann::json{
9445 TOJSON_IMPL(id),
9446 TOJSON_IMPL(restrictions)
9447 };
9448 }
9449 static void from_json(const nlohmann::json& j, RallypointExtendedGroupRestriction& p)
9450 {
9451 p.clear();
9452 getOptional<std::string>("id", p.id, j);
9453 getOptional<std::vector<StringRestrictionList>>("restrictions", p.restrictions, j);
9454 }
9455
9456 //-----------------------------------------------------------
9457 JSON_SERIALIZED_CLASS(RtiCloudSettings)
9464 {
9465 IMPLEMENT_JSON_SERIALIZATION()
9466 IMPLEMENT_JSON_DOCUMENTATION(RtiCloudSettings)
9467
9468 public:
9471
9473 std::string enrollmentCode;
9474
9477
9479 {
9480 clear();
9481 }
9482
9483 void clear()
9484 {
9485 enabled = false;
9486 enrollmentCode.clear();
9487 serviceBaseUrlPrefix = "prod.com";
9488 }
9489 };
9490
9491 static void to_json(nlohmann::json& j, const RtiCloudSettings& p)
9492 {
9493 j = nlohmann::json{
9494 TOJSON_IMPL(enabled),
9495 TOJSON_IMPL(enrollmentCode),
9496 TOJSON_IMPL(serviceBaseUrlPrefix)
9497 };
9498 }
9499 static void from_json(const nlohmann::json& j, RtiCloudSettings& p)
9500 {
9501 p.clear();
9502 getOptional<bool>("enabled", p.enabled, j, false);
9503 getOptional<std::string>("enrollmentCode", p.enrollmentCode, j);
9504 getOptional<std::string>("serviceBaseUrlPrefix", p.serviceBaseUrlPrefix, j, "prod.com");
9505 }
9506
9507 //-----------------------------------------------------------
9508 JSON_SERIALIZED_CLASS(NsmNodeScripts)
9515 {
9516 IMPLEMENT_JSON_SERIALIZATION()
9517 IMPLEMENT_JSON_DOCUMENTATION(NsmNodeScripts)
9518
9519 public:
9520 std::string onIdle;
9521 std::string beforeGoingActive;
9522 std::string onGoingActive;
9523 std::string beforeActive;
9524 std::string onActive;
9525 std::string inDashboard;
9526 std::string onStatusReport;
9527
9529 {
9530 clear();
9531 }
9532
9533 void clear()
9534 {
9535 onIdle.clear();
9536 beforeGoingActive.clear();
9537 onGoingActive.clear();
9538 beforeActive.clear();
9539 onActive.clear();
9540 inDashboard.clear();
9541 onStatusReport.clear();
9542 }
9543 };
9544
9545 static void to_json(nlohmann::json& j, const NsmNodeScripts& p)
9546 {
9547 j = nlohmann::json{
9548 TOJSON_IMPL(onIdle),
9549 TOJSON_IMPL(beforeGoingActive),
9550 TOJSON_IMPL(onGoingActive),
9551 TOJSON_IMPL(beforeActive),
9552 TOJSON_IMPL(onActive),
9553 TOJSON_IMPL(inDashboard),
9554 TOJSON_IMPL(onStatusReport)
9555 };
9556 }
9557 static void from_json(const nlohmann::json& j, NsmNodeScripts& p)
9558 {
9559 p.clear();
9560 getOptional<std::string>("onIdle", p.onIdle, j);
9561 getOptional<std::string>("beforeGoingActive", p.beforeGoingActive, j);
9562 getOptional<std::string>("onGoingActive", p.onGoingActive, j);
9563 getOptional<std::string>("beforeActive", p.beforeActive, j);
9564 getOptional<std::string>("onActive", p.onActive, j);
9565 getOptional<std::string>("inDashboard", p.inDashboard, j);
9566 getOptional<std::string>("onStatusReport", p.onStatusReport, j);
9567 }
9568
9569 //-----------------------------------------------------------
9570 JSON_SERIALIZED_CLASS(NsmNodeLogging)
9577 {
9578 IMPLEMENT_JSON_SERIALIZATION()
9579 IMPLEMENT_JSON_DOCUMENTATION(NsmNodeLogging)
9580
9581 public:
9586 bool logCommandOutput;
9587 bool logResourceStates;
9588
9590 {
9591 clear();
9592 }
9593
9594 void clear()
9595 {
9596 level = 3;
9597 dashboard = false;
9598 logCommandOutput = false;
9599 logResourceStates = false;
9600 }
9601 };
9602
9603 static void to_json(nlohmann::json& j, const NsmNodeLogging& p)
9604 {
9605 j = nlohmann::json{
9606 TOJSON_IMPL(level),
9607 TOJSON_IMPL(dashboard),
9608 TOJSON_IMPL(logCommandOutput),
9609 TOJSON_IMPL(logResourceStates)
9610 };
9611 }
9612 static void from_json(const nlohmann::json& j, NsmNodeLogging& p)
9613 {
9614 p.clear();
9615 getOptional<int>("level", p.level, j, 3);
9616 getOptional<bool>("dashboard", p.dashboard, j, false);
9617 getOptional<bool>("logCommandOutput", p.logCommandOutput, j, false);
9618 getOptional<bool>("logResourceStates", p.logResourceStates, j, false);
9619 }
9620
9621 //-----------------------------------------------------------
9622 JSON_SERIALIZED_CLASS(NsmNodePeriodic)
9629 {
9630 IMPLEMENT_JSON_SERIALIZATION()
9631 IMPLEMENT_JSON_DOCUMENTATION(NsmNodePeriodic)
9632
9633 public:
9634 std::string id;
9635 int intervalSecs;
9636 std::string command;
9637
9639 {
9640 clear();
9641 }
9642
9643 void clear()
9644 {
9645 id.clear();
9646 intervalSecs = 1;
9647 command.clear();
9648 }
9649 };
9650
9651 static void to_json(nlohmann::json& j, const NsmNodePeriodic& p)
9652 {
9653 j = nlohmann::json{
9654 TOJSON_IMPL(id),
9655 TOJSON_IMPL(intervalSecs),
9656 TOJSON_IMPL(command)
9657 };
9658 }
9659 static void from_json(const nlohmann::json& j, NsmNodePeriodic& p)
9660 {
9661 p.clear();
9662 getOptional<std::string>("id", p.id, j);
9663 getOptional<int>("intervalSecs", p.intervalSecs, j, 1);
9664 getOptional<std::string>("command", p.command, j);
9665 }
9666
9667 //-----------------------------------------------------------
9668 JSON_SERIALIZED_CLASS(NsmNodeCotLocationPollSettings)
9678 {
9679 IMPLEMENT_JSON_SERIALIZATION()
9680 IMPLEMENT_JSON_DOCUMENTATION(NsmNodeCotLocationPollSettings)
9681
9682 public:
9686 std::string runCmd;
9691
9693 {
9694 clear();
9695 }
9696
9697 void clear()
9698 {
9699 enabled = false;
9700 runCmd.clear();
9701 intervalSecs = 10;
9702 failClosed = true;
9703 }
9704 };
9705
9706 static void to_json(nlohmann::json& j, const NsmNodeCotLocationPollSettings& p)
9707 {
9708 j = nlohmann::json{
9709 TOJSON_IMPL(enabled),
9710 TOJSON_IMPL(runCmd),
9711 TOJSON_IMPL(intervalSecs),
9712 TOJSON_IMPL(failClosed)
9713 };
9714 }
9715 static void from_json(const nlohmann::json& j, NsmNodeCotLocationPollSettings& p)
9716 {
9717 p.clear();
9718 getOptional<bool>("enabled", p.enabled, j, false);
9719 getOptional<std::string>("runCmd", p.runCmd, j);
9720 getOptional<int>("intervalSecs", p.intervalSecs, j, 10);
9721 getOptional<bool>("failClosed", p.failClosed, j, true);
9722 }
9723
9724 //-----------------------------------------------------------
9725 JSON_SERIALIZED_CLASS(NsmNodeCotSettings)
9732 {
9733 IMPLEMENT_JSON_SERIALIZATION()
9734 IMPLEMENT_JSON_DOCUMENTATION(NsmNodeCotSettings)
9735
9736 public:
9737 bool useCot;
9738 std::string uid;
9739 std::string type;
9740 std::string how;
9741 std::string lat;
9742 std::string lon;
9743 std::string ce;
9744 std::string hae;
9745 std::string le;
9747 std::string callsign;
9749 std::string detailJson;
9756
9758 {
9759 clear();
9760 }
9761
9762 void clear()
9763 {
9764 useCot = false;
9765 uid.clear();
9766 type.clear();
9767 how.clear();
9768 lat.clear();
9769 lon.clear();
9770 ce.clear();
9771 hae.clear();
9772 le.clear();
9773 callsign.clear();
9774 detailJson.clear();
9775 announceWhenIdle = false;
9776 idleIntervalSecs = 30;
9777 locationPoll.clear();
9778 }
9779 };
9780
9781 static void to_json(nlohmann::json& j, const NsmNodeCotSettings& p)
9782 {
9783 j = nlohmann::json{
9784 TOJSON_IMPL(useCot),
9785 TOJSON_IMPL(uid),
9786 TOJSON_IMPL(type),
9787 TOJSON_IMPL(how),
9788 TOJSON_IMPL(lat),
9789 TOJSON_IMPL(lon),
9790 TOJSON_IMPL(ce),
9791 TOJSON_IMPL(hae),
9792 TOJSON_IMPL(le),
9793 TOJSON_IMPL(callsign),
9794 TOJSON_IMPL(detailJson),
9795 TOJSON_IMPL(announceWhenIdle),
9796 TOJSON_IMPL(idleIntervalSecs),
9797 TOJSON_IMPL(locationPoll)
9798 };
9799 }
9800 static void from_json(const nlohmann::json& j, NsmNodeCotSettings& p)
9801 {
9802 p.clear();
9803 getOptional<bool>("useCot", p.useCot, j, false);
9804 getOptional<std::string>("uid", p.uid, j);
9805 getOptional<std::string>("type", p.type, j);
9806 getOptional<std::string>("how", p.how, j);
9807 getOptional<std::string>("lat", p.lat, j);
9808 getOptional<std::string>("lon", p.lon, j);
9809 getOptional<std::string>("ce", p.ce, j);
9810 getOptional<std::string>("hae", p.hae, j);
9811 getOptional<std::string>("le", p.le, j);
9812 getOptional<std::string>("callsign", p.callsign, j);
9813 getOptional<std::string>("detailJson", p.detailJson, j);
9814 getOptional<bool>("announceWhenIdle", p.announceWhenIdle, j, false);
9815 getOptional<int>("idleIntervalSecs", p.idleIntervalSecs, j, 30);
9816 getOptional<NsmNodeCotLocationPollSettings>("locationPoll", p.locationPoll, j);
9817 }
9818
9819 //-----------------------------------------------------------
9820 JSON_SERIALIZED_CLASS(NsmNodeStatusReportConfiguration)
9831 {
9832 IMPLEMENT_JSON_SERIALIZATION()
9833 IMPLEMENT_JSON_DOCUMENTATION(NsmNodeStatusReportConfiguration)
9834
9835 public:
9837 std::string fileName;
9838
9841
9844
9846 std::string runCmd;
9847
9850
9852 {
9853 clear();
9854 }
9855
9856 void clear()
9857 {
9858 fileName.clear();
9859 intervalSecs = 60;
9860 enabled = false;
9861 includeResourceDetail = false;
9862 runCmd.clear();
9863 }
9864 };
9865
9866 static void to_json(nlohmann::json& j, const NsmNodeStatusReportConfiguration& p)
9867 {
9868 j = nlohmann::json{
9869 TOJSON_IMPL(fileName),
9870 TOJSON_IMPL(intervalSecs),
9871 TOJSON_IMPL(enabled),
9872 TOJSON_IMPL(includeResourceDetail),
9873 TOJSON_IMPL(runCmd)
9874 };
9875 }
9876 static void from_json(const nlohmann::json& j, NsmNodeStatusReportConfiguration& p)
9877 {
9878 p.clear();
9879 getOptional<std::string>("fileName", p.fileName, j);
9880 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
9881 getOptional<bool>("enabled", p.enabled, j, false);
9882 getOptional<std::string>("runCmd", p.runCmd, j);
9883 getOptional<bool>("includeResourceDetail", p.includeResourceDetail, j, false);
9884 }
9885
9886 //-----------------------------------------------------------
9887 JSON_SERIALIZED_CLASS(NsmNodeElectionGateSettings)
9898 {
9899 IMPLEMENT_JSON_SERIALIZATION()
9900 IMPLEMENT_JSON_DOCUMENTATION(NsmNodeElectionGateSettings)
9901
9902 public:
9906 std::string runCmd;
9911
9913 {
9914 clear();
9915 }
9916
9917 void clear()
9918 {
9919 enabled = false;
9920 runCmd.clear();
9921 intervalSecs = 2;
9922 failClosed = true;
9923 }
9924 };
9925
9926 static void to_json(nlohmann::json& j, const NsmNodeElectionGateSettings& p)
9927 {
9928 j = nlohmann::json{
9929 TOJSON_IMPL(enabled),
9930 TOJSON_IMPL(runCmd),
9931 TOJSON_IMPL(intervalSecs),
9932 TOJSON_IMPL(failClosed)
9933 };
9934 }
9935 static void from_json(const nlohmann::json& j, NsmNodeElectionGateSettings& p)
9936 {
9937 p.clear();
9938 getOptional<bool>("enabled", p.enabled, j, false);
9939 getOptional<std::string>("runCmd", p.runCmd, j);
9940 getOptional<int>("intervalSecs", p.intervalSecs, j, 2);
9941 getOptional<bool>("failClosed", p.failClosed, j, true);
9942 }
9943
9944 //-----------------------------------------------------------
9945 JSON_SERIALIZED_CLASS(NsmNode)
9955 {
9956 IMPLEMENT_JSON_SERIALIZATION()
9957 IMPLEMENT_JSON_DOCUMENTATION(NsmNode)
9958
9959 public:
9960
9963
9966
9968 std::string id;
9969
9971 std::string name;
9972
9974 std::string domainName;
9975
9978
9981
9984
9987
9990
9993
9996
9999
10002
10004 std::vector<NsmNodePeriodic> periodics;
10005
10008
10011
10014
10017
10020
10023
10026
10029
10030 NsmNode()
10031 {
10032 clear();
10033 }
10034
10035 void clear()
10036 {
10037 fipsCrypto.clear();
10038 watchdog.clear();
10039 id.clear();
10040 name.clear();
10041 domainName.clear();
10042 multicastInterfaceName.clear();
10043 stateMachine.clear();
10044 defaultPriority = 0;
10045 fixedToken = -1;
10046 dashboardToken = false;
10047 scripts.clear();
10048 logging.clear();
10049 cot.clear();
10050 periodics.clear();
10051 electionGate.clear();
10052 statusReport.clear();
10053 configurationCheckSignalName = "rts.7b392d1.${id}";
10054 licensing.clear();
10055 featureset.clear();
10056 rxCapture.clear();
10057 txCapture.clear();
10058 tuning.clear();
10059 ipFamily = IpFamilyType_t::ifIp4;
10060 }
10061 };
10062
10063 static void to_json(nlohmann::json& j, const NsmNode& p)
10064 {
10065 j = nlohmann::json{
10066 TOJSON_IMPL(fipsCrypto),
10067 TOJSON_IMPL(watchdog),
10068 TOJSON_IMPL(id),
10069 TOJSON_IMPL(name),
10070 TOJSON_IMPL(domainName),
10071 TOJSON_IMPL(multicastInterfaceName),
10072 TOJSON_IMPL(stateMachine),
10073 TOJSON_IMPL(defaultPriority),
10074 TOJSON_IMPL(fixedToken),
10075 TOJSON_IMPL(dashboardToken),
10076 TOJSON_IMPL(scripts),
10077 TOJSON_IMPL(logging),
10078 TOJSON_IMPL(cot),
10079 TOJSON_IMPL(periodics),
10080 TOJSON_IMPL(electionGate),
10081 TOJSON_IMPL(statusReport),
10082 TOJSON_IMPL(configurationCheckSignalName),
10083 TOJSON_IMPL(featureset),
10084 TOJSON_IMPL(licensing),
10085 TOJSON_IMPL(ipFamily),
10086 TOJSON_IMPL(rxCapture),
10087 TOJSON_IMPL(txCapture),
10088 TOJSON_IMPL(tuning)
10089 };
10090 }
10091 static void from_json(const nlohmann::json& j, NsmNode& p)
10092 {
10093 p.clear();
10094 getOptional<FipsCryptoSettings>("fipsCrypto", p.fipsCrypto, j);
10095 getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
10096 getOptional<std::string>("id", p.id, j);
10097 getOptional<std::string>("name", p.name, j);
10098 getOptional<std::string>("domainName", p.domainName, j);
10099 getOptional<std::string>("multicastInterfaceName", p.multicastInterfaceName, j);
10100 getOptional<NsmConfiguration>("stateMachine", p.stateMachine, j);
10101 getOptional<int>("defaultPriority", p.defaultPriority, j, 0);
10102 getOptional<int>("fixedToken", p.fixedToken, j, -1);
10103 getOptional<bool>("dashboardToken", p.dashboardToken, j, false);
10104 getOptional<NsmNodeScripts>("scripts", p.scripts, j);
10105 getOptional<NsmNodeLogging>("logging", p.logging, j);
10106 getOptional<NsmNodeCotSettings>("cot", p.cot, j);
10107 getOptional<std::vector<NsmNodePeriodic>>("periodics", p.periodics, j);
10108 getOptional<NsmNodeElectionGateSettings>("electionGate", p.electionGate, j);
10109 getOptional<NsmNodeStatusReportConfiguration>("statusReport", p.statusReport, j);
10110 getOptional<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.7b392d1.${id}");
10111 getOptional<Licensing>("licensing", p.licensing, j);
10112 getOptional<Featureset>("featureset", p.featureset, j);
10113 getOptional<PacketCapturer>("rxCapture", p.rxCapture, j);
10114 getOptional<PacketCapturer>("txCapture", p.txCapture, j);
10115 getOptional<TuningSettings>("tuning", p.tuning, j);
10116 getOptional<IpFamilyType_t>("ipFamily", p.ipFamily, j, IpFamilyType_t::ifIp4);
10117 }
10118
10120 static inline void nsmNodeFromEmbeddedServerJson(const nlohmann::json &j, const char *key, NsmNode &node)
10121 {
10122 node.clear();
10123 if (!j.contains(key))
10124 {
10125 return;
10126 }
10127
10128 const nlohmann::json &nj = j.at(key);
10129 if (!nj.is_object())
10130 {
10131 return;
10132 }
10133
10134 if (nj.contains("stateMachine") || nj.contains("cot") || nj.contains("scripts")
10135 || nj.contains("periodics") || nj.contains("electionGate") || nj.contains("statusReport")
10136 || nj.contains("multicastInterfaceName"))
10137 {
10138 nj.get_to(node);
10139 return;
10140 }
10141
10142 nj.get_to(node.stateMachine);
10143 }
10144 //-----------------------------------------------------------
10145 JSON_SERIALIZED_CLASS(RallypointServer)
10155 {
10156 IMPLEMENT_JSON_SERIALIZATION()
10157 IMPLEMENT_JSON_DOCUMENTATION(RallypointServer)
10158
10159 public:
10160 typedef enum
10161 {
10162 sptDefault = 0,
10163 sptCertificate = 1,
10164 sptCertPublicKey = 2,
10165 sptCertSubject = 3,
10166 sptCertIssuer = 4,
10167 sptCertFingerprint = 5,
10168 sptCertSerial = 6,
10169 sptSubjectC = 7,
10170 sptSubjectST = 8,
10171 sptSubjectL = 9,
10172 sptSubjectO = 10,
10173 sptSubjectOU = 11,
10174 sptSubjectCN = 12,
10175 sptIssuerC = 13,
10176 sptIssuerST = 14,
10177 sptIssuerL = 15,
10178 sptIssuerO = 16,
10179 sptIssuerOU = 17,
10180 sptIssuerCN = 18
10181 } StreamIdPrivacyType_t;
10182
10184 StreamIdPrivacyType_t streamIdPrivacyType;
10185
10188
10191
10193 std::string id;
10194
10196 std::string name;
10197
10200
10203
10205 std::string interfaceName;
10206
10209
10212
10215
10218
10221
10224
10227
10230
10233
10236
10239
10242
10245
10248
10251
10254
10256 PeeringConfiguration peeringConfiguration; // NOTE: This is NOT serialized
10257
10260
10263
10266
10269
10271 std::vector<RallypointReflector> staticReflectors;
10272
10275
10278
10281
10284
10287
10290
10292 std::vector<RallypointExtendedGroupRestriction> extendedGroupRestrictions;
10293
10296
10299
10302
10305
10307 uint32_t sysFlags;
10308
10311
10314
10317
10320
10323
10326
10329
10332
10334 std::vector<RallypointRpRtTimingBehavior> peerRtBehaviors;
10335
10338
10341
10344
10347
10350
10353
10355 std::string domainName;
10356
10358 std::vector<std::string> allowedDomains;
10359
10361 std::vector<std::string> blockedDomains;
10362
10364 std::vector<std::string> extraDomains;
10365
10368
10370 std::vector<NamedIdentity> additionalIdentities;
10371
10373 {
10374 clear();
10375 }
10376
10377 void clear()
10378 {
10379 fipsCrypto.clear();
10380 watchdog.clear();
10381 id.clear();
10382 name.clear();
10383 listenPort = 7443;
10384 interfaceName.clear();
10385 certificate.clear();
10386 allowMulticastForwarding = false;
10387 peeringConfiguration.clear();
10388 peeringConfigurationFileName.clear();
10389 peeringConfigurationFileCommand.clear();
10390 peeringConfigurationFileCheckSecs = 60;
10391 ioPools = -1;
10392 statusReport.clear();
10393 limits.clear();
10394 linkGraph.clear();
10395 externalHealthCheckResponder.clear();
10396 allowPeerForwarding = false;
10397 multicastInterfaceName.clear();
10398 tls.clear();
10399 discovery.clear();
10400 forwardDiscoveredGroups = false;
10401 forwardMulticastAddressing = false;
10402 isMeshLeaf = false;
10403 disableMessageSigning = false;
10404 multicastRestrictions.clear();
10405 igmpSnooping.clear();
10406 staticReflectors.clear();
10407 tcpTxOptions.clear();
10408 multicastTxOptions.clear();
10409 certStoreFileName.clear();
10410 certStorePasswordHex.clear();
10411 groupRestrictions.clear();
10412 configurationCheckSignalName = "rts.7b392d1.${id}";
10413 licensing.clear();
10414 featureset.clear();
10415 udpStreaming.clear();
10416 sysFlags = 0;
10417 normalTaskQueueBias = 0;
10418 enableLeafReflectionReverseSubscription = false;
10419 disableLoopDetection = false;
10420 maxSecurityLevel = 0;
10421 routeMap.clear();
10422 streamStatsExport.clear();
10423 maxOutboundPeerConnectionIntervalDeltaSecs = 15;
10424 peerRtTestIntervalMs = 60000;
10425 peerRtBehaviors.clear();
10426 websocket.clear();
10427 nsm.clear();
10428 advertising.clear();
10429 rtiCloud.clear();
10430 extendedGroupRestrictions.clear();
10431 groupRestrictionAccessPolicyType = GroupRestrictionAccessPolicyType_t::graptPermissive;
10432 ipFamily = IpFamilyType_t::ifIp4;
10433 rxCapture.clear();
10434 txCapture.clear();
10435 domainName.clear();
10436 allowedDomains.clear();
10437 blockedDomains.clear();
10438 extraDomains.clear();
10439 tuning.clear();
10440 additionalIdentities.clear();
10441 streamIdPrivacyType = StreamIdPrivacyType_t::sptDefault;
10442 }
10443 };
10444
10445 static void to_json(nlohmann::json& j, const RallypointServer& p)
10446 {
10447 j = nlohmann::json{
10448 TOJSON_IMPL(fipsCrypto),
10449 TOJSON_IMPL(watchdog),
10450 TOJSON_IMPL(id),
10451 TOJSON_IMPL(name),
10452 TOJSON_IMPL(listenPort),
10453 TOJSON_IMPL(interfaceName),
10454 TOJSON_IMPL(certificate),
10455 TOJSON_IMPL(allowMulticastForwarding),
10456 // TOJSON_IMPL(peeringConfiguration), // NOTE: Not serialized!
10457 TOJSON_IMPL(peeringConfigurationFileName),
10458 TOJSON_IMPL(peeringConfigurationFileCommand),
10459 TOJSON_IMPL(peeringConfigurationFileCheckSecs),
10460 TOJSON_IMPL(ioPools),
10461 TOJSON_IMPL(statusReport),
10462 TOJSON_IMPL(limits),
10463 TOJSON_IMPL(linkGraph),
10464 TOJSON_IMPL(externalHealthCheckResponder),
10465 TOJSON_IMPL(allowPeerForwarding),
10466 TOJSON_IMPL(multicastInterfaceName),
10467 TOJSON_IMPL(tls),
10468 TOJSON_IMPL(discovery),
10469 TOJSON_IMPL(forwardDiscoveredGroups),
10470 TOJSON_IMPL(forwardMulticastAddressing),
10471 TOJSON_IMPL(isMeshLeaf),
10472 TOJSON_IMPL(disableMessageSigning),
10473 TOJSON_IMPL(multicastRestrictions),
10474 TOJSON_IMPL(igmpSnooping),
10475 TOJSON_IMPL(staticReflectors),
10476 TOJSON_IMPL(tcpTxOptions),
10477 TOJSON_IMPL(multicastTxOptions),
10478 TOJSON_IMPL(certStoreFileName),
10479 TOJSON_IMPL(certStorePasswordHex),
10480 TOJSON_IMPL(groupRestrictions),
10481 TOJSON_IMPL(configurationCheckSignalName),
10482 TOJSON_IMPL(featureset),
10483 TOJSON_IMPL(licensing),
10484 TOJSON_IMPL(udpStreaming),
10485 TOJSON_IMPL(sysFlags),
10486 TOJSON_IMPL(normalTaskQueueBias),
10487 TOJSON_IMPL(enableLeafReflectionReverseSubscription),
10488 TOJSON_IMPL(disableLoopDetection),
10489 TOJSON_IMPL(maxSecurityLevel),
10490 TOJSON_IMPL(routeMap),
10491 TOJSON_IMPL(streamStatsExport),
10492 TOJSON_IMPL(maxOutboundPeerConnectionIntervalDeltaSecs),
10493 TOJSON_IMPL(peerRtTestIntervalMs),
10494 TOJSON_IMPL(peerRtBehaviors),
10495 TOJSON_IMPL(websocket),
10496 TOJSON_IMPL(nsm),
10497 TOJSON_IMPL(advertising),
10498 TOJSON_IMPL(rtiCloud),
10499 TOJSON_IMPL(extendedGroupRestrictions),
10500 TOJSON_IMPL(groupRestrictionAccessPolicyType),
10501 TOJSON_IMPL(ipFamily),
10502 TOJSON_IMPL(rxCapture),
10503 TOJSON_IMPL(txCapture),
10504 TOJSON_IMPL(domainName),
10505 TOJSON_IMPL(allowedDomains),
10506 TOJSON_IMPL(blockedDomains),
10507 TOJSON_IMPL(extraDomains),
10508 TOJSON_IMPL(tuning),
10509 TOJSON_IMPL(additionalIdentities),
10510 TOJSON_IMPL(streamIdPrivacyType)
10511 };
10512 }
10513 static void from_json(const nlohmann::json& j, RallypointServer& p)
10514 {
10515 p.clear();
10516 getOptional<FipsCryptoSettings>("fipsCrypto", p.fipsCrypto, j);
10517 getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
10518 getOptional<std::string>("id", p.id, j);
10519 getOptional<std::string>("name", p.name, j);
10520 getOptional<SecurityCertificate>("certificate", p.certificate, j);
10521 getOptional<std::string>("interfaceName", p.interfaceName, j);
10522 getOptional<int>("listenPort", p.listenPort, j, 7443);
10523 getOptional<bool>("allowMulticastForwarding", p.allowMulticastForwarding, j, false);
10524 //getOptional<PeeringConfiguration>("peeringConfiguration", p.peeringConfiguration, j); // NOTE: Not serialized!
10525 getOptional<std::string>("peeringConfigurationFileName", p.peeringConfigurationFileName, j);
10526 getOptional<std::string>("peeringConfigurationFileCommand", p.peeringConfigurationFileCommand, j);
10527 getOptional<int>("peeringConfigurationFileCheckSecs", p.peeringConfigurationFileCheckSecs, j, 60);
10528 getOptional<int>("ioPools", p.ioPools, j, -1);
10529 getOptional<RallypointServerStatusReportConfiguration>("statusReport", p.statusReport, j);
10530 getOptional<RallypointServerLimits>("limits", p.limits, j);
10531 getOptional<RallypointServerLinkGraph>("linkGraph", p.linkGraph, j);
10532 getOptional<ExternalHealthCheckResponder>("externalHealthCheckResponder", p.externalHealthCheckResponder, j);
10533 getOptional<bool>("allowPeerForwarding", p.allowPeerForwarding, j, false);
10534 getOptional<std::string>("multicastInterfaceName", p.multicastInterfaceName, j);
10535 getOptional<Tls>("tls", p.tls, j);
10536 getOptional<DiscoveryConfiguration>("discovery", p.discovery, j);
10537 getOptional<bool>("forwardDiscoveredGroups", p.forwardDiscoveredGroups, j, false);
10538 getOptional<bool>("forwardMulticastAddressing", p.forwardMulticastAddressing, j, false);
10539 getOptional<bool>("isMeshLeaf", p.isMeshLeaf, j, false);
10540 getOptional<bool>("disableMessageSigning", p.disableMessageSigning, j, false);
10541 getOptional<NetworkAddressRestrictionList>("multicastRestrictions", p.multicastRestrictions, j);
10542 getOptional<IgmpSnooping>("igmpSnooping", p.igmpSnooping, j);
10543 getOptional<std::vector<RallypointReflector>>("staticReflectors", p.staticReflectors, j);
10544 getOptional<TcpNetworkTxOptions>("tcpTxOptions", p.tcpTxOptions, j);
10545 getOptional<NetworkTxOptions>("multicastTxOptions", p.multicastTxOptions, j);
10546 getOptional<std::string>("certStoreFileName", p.certStoreFileName, j);
10547 getOptional<std::string>("certStorePasswordHex", p.certStorePasswordHex, j);
10548 getOptional<StringRestrictionList>("groupRestrictions", p.groupRestrictions, j);
10549 getOptional<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.7b392d1.${id}");
10550 getOptional<Licensing>("licensing", p.licensing, j);
10551 getOptional<Featureset>("featureset", p.featureset, j);
10552 getOptional<RallypointUdpStreaming>("udpStreaming", p.udpStreaming, j);
10553 getOptional<uint32_t>("sysFlags", p.sysFlags, j, 0);
10554 getOptional<uint32_t>("normalTaskQueueBias", p.normalTaskQueueBias, j, 0);
10555 getOptional<bool>("enableLeafReflectionReverseSubscription", p.enableLeafReflectionReverseSubscription, j, false);
10556 getOptional<bool>("disableLoopDetection", p.disableLoopDetection, j, false);
10557 getOptional<uint32_t>("maxSecurityLevel", p.maxSecurityLevel, j, 0);
10558 getOptional<RallypointServerRouteMap>("routeMap", p.routeMap, j);
10559 getOptional<RallypointServerStreamStatsExport>("streamStatsExport", p.streamStatsExport, j);
10560 getOptional<uint32_t>("maxOutboundPeerConnectionIntervalDeltaSecs", p.maxOutboundPeerConnectionIntervalDeltaSecs, j, 15);
10561 getOptional<int>("peerRtTestIntervalMs", p.peerRtTestIntervalMs, j, 60000);
10562 getOptional<std::vector<RallypointRpRtTimingBehavior>>("peerRtBehaviors", p.peerRtBehaviors, j);
10563 getOptional<RallypointWebsocketSettings>("websocket", p.websocket, j);
10564 nsmNodeFromEmbeddedServerJson(j, "nsm", p.nsm);
10565 getOptional<RallypointAdvertisingSettings>("advertising", p.advertising, j);
10566 getOptional<RtiCloudSettings>("rtiCloud", p.rtiCloud, j);
10567 getOptional<std::vector<RallypointExtendedGroupRestriction>>("extendedGroupRestrictions", p.extendedGroupRestrictions, j);
10568 getOptional<GroupRestrictionAccessPolicyType_t>("groupRestrictionAccessPolicyType", p.groupRestrictionAccessPolicyType, j, GroupRestrictionAccessPolicyType_t::graptPermissive);
10569 getOptional<IpFamilyType_t>("ipFamily", p.ipFamily, j, IpFamilyType_t::ifIp4);
10570 getOptional<PacketCapturer>("rxCapture", p.rxCapture, j);
10571 getOptional<PacketCapturer>("txCapture", p.txCapture, j);
10572 getOptional<std::string>("domainName", p.domainName, j);
10573 getOptional<std::vector<std::string>>("allowedDomains", p.allowedDomains, j);
10574 getOptional<std::vector<std::string>>("blockedDomains", p.blockedDomains, j);
10575 getOptional<std::vector<std::string>>("extraDomains", p.extraDomains, j);
10576 getOptional<TuningSettings>("tuning", p.tuning, j);
10577 getOptional<std::vector<NamedIdentity>>("additionalIdentities", p.additionalIdentities, j);
10578 getOptional<RallypointServer::StreamIdPrivacyType_t>("streamIdPrivacyType", p.streamIdPrivacyType, j, RallypointServer::StreamIdPrivacyType_t::sptDefault);
10579 }
10580
10581
10582 //-----------------------------------------------------------
10583 JSON_SERIALIZED_CLASS(PlatformDiscoveredService)
10594 {
10595 IMPLEMENT_JSON_SERIALIZATION()
10596 IMPLEMENT_JSON_DOCUMENTATION(PlatformDiscoveredService)
10597
10598 public:
10599
10601 std::string id;
10602
10604 std::string type;
10605
10607 std::string name;
10608
10611
10613 std::string uri;
10614
10617
10619 {
10620 clear();
10621 }
10622
10623 void clear()
10624 {
10625 id.clear();
10626 type.clear();
10627 name.clear();
10628 address.clear();
10629 uri.clear();
10630 configurationVersion = 0;
10631 }
10632 };
10633
10634 static void to_json(nlohmann::json& j, const PlatformDiscoveredService& p)
10635 {
10636 j = nlohmann::json{
10637 TOJSON_IMPL(id),
10638 TOJSON_IMPL(type),
10639 TOJSON_IMPL(name),
10640 TOJSON_IMPL(address),
10641 TOJSON_IMPL(uri),
10642 TOJSON_IMPL(configurationVersion)
10643 };
10644 }
10645 static void from_json(const nlohmann::json& j, PlatformDiscoveredService& p)
10646 {
10647 p.clear();
10648 getOptional<std::string>("id", p.id, j);
10649 getOptional<std::string>("type", p.type, j);
10650 getOptional<std::string>("name", p.name, j);
10651 getOptional<NetworkAddress>("address", p.address, j);
10652 getOptional<std::string>("uri", p.uri, j);
10653 getOptional<uint32_t>("configurationVersion", p.configurationVersion, j, 0);
10654 }
10655
10656
10657 //-----------------------------------------------------------
10659 {
10660 public:
10661 typedef enum
10662 {
10663 etUndefined = 0,
10664 etAudio = 1,
10665 etLocation = 2,
10666 etUser = 3
10667 } EventType_t;
10668
10669 typedef enum
10670 {
10671 dNone = 0,
10672 dInbound = 1,
10673 dOutbound = 2,
10674 dBoth = 3,
10675 dUndefined = 4,
10676 } Direction_t;
10677 };
10678
10679
10680 //-----------------------------------------------------------
10681 JSON_SERIALIZED_CLASS(TimelineQueryParameters)
10692 {
10693 IMPLEMENT_JSON_SERIALIZATION()
10694 IMPLEMENT_JSON_DOCUMENTATION(TimelineQueryParameters)
10695
10696 public:
10697
10700
10703
10706
10709
10712
10715
10718
10720 std::string onlyAlias;
10721
10723 std::string onlyNodeId;
10724
10727
10729 std::string sql;
10730
10732 {
10733 clear();
10734 }
10735
10736 void clear()
10737 {
10738 maxCount = 50;
10739 mostRecentFirst = true;
10740 startedOnOrAfter = 0;
10741 endedOnOrBefore = 0;
10742 onlyDirection = 0;
10743 onlyType = 0;
10744 onlyCommitted = true;
10745 onlyAlias.clear();
10746 onlyNodeId.clear();
10747 sql.clear();
10748 onlyTxId = 0;
10749 }
10750 };
10751
10752 static void to_json(nlohmann::json& j, const TimelineQueryParameters& p)
10753 {
10754 j = nlohmann::json{
10755 TOJSON_IMPL(maxCount),
10756 TOJSON_IMPL(mostRecentFirst),
10757 TOJSON_IMPL(startedOnOrAfter),
10758 TOJSON_IMPL(endedOnOrBefore),
10759 TOJSON_IMPL(onlyDirection),
10760 TOJSON_IMPL(onlyType),
10761 TOJSON_IMPL(onlyCommitted),
10762 TOJSON_IMPL(onlyAlias),
10763 TOJSON_IMPL(onlyNodeId),
10764 TOJSON_IMPL(onlyTxId),
10765 TOJSON_IMPL(sql)
10766 };
10767 }
10768 static void from_json(const nlohmann::json& j, TimelineQueryParameters& p)
10769 {
10770 p.clear();
10771 getOptional<long>("maxCount", p.maxCount, j, 50);
10772 getOptional<bool>("mostRecentFirst", p.mostRecentFirst, j, false);
10773 getOptional<uint64_t>("startedOnOrAfter", p.startedOnOrAfter, j, 0);
10774 getOptional<uint64_t>("endedOnOrBefore", p.endedOnOrBefore, j, 0);
10775 getOptional<int>("onlyDirection", p.onlyDirection, j, 0);
10776 getOptional<int>("onlyType", p.onlyType, j, 0);
10777 getOptional<bool>("onlyCommitted", p.onlyCommitted, j, true);
10778 getOptional<std::string>("onlyAlias", p.onlyAlias, j, EMPTY_STRING);
10779 getOptional<std::string>("onlyNodeId", p.onlyNodeId, j, EMPTY_STRING);
10780 getOptional<int>("onlyTxId", p.onlyTxId, j, 0);
10781 getOptional<std::string>("sql", p.sql, j, EMPTY_STRING);
10782 }
10783
10784 //-----------------------------------------------------------
10785 JSON_SERIALIZED_CLASS(CertStoreCertificate)
10793 {
10794 IMPLEMENT_JSON_SERIALIZATION()
10795 IMPLEMENT_JSON_DOCUMENTATION(CertStoreCertificate)
10796
10797 public:
10799 std::string id;
10800
10802 std::string certificatePem;
10803
10805 std::string privateKeyPem;
10806
10809
10811 std::string tags;
10812
10814 {
10815 clear();
10816 }
10817
10818 void clear()
10819 {
10820 id.clear();
10821 certificatePem.clear();
10822 privateKeyPem.clear();
10823 internalData = nullptr;
10824 tags.clear();
10825 }
10826 };
10827
10828 static void to_json(nlohmann::json& j, const CertStoreCertificate& p)
10829 {
10830 j = nlohmann::json{
10831 TOJSON_IMPL(id),
10832 TOJSON_IMPL(certificatePem),
10833 TOJSON_IMPL(privateKeyPem),
10834 TOJSON_IMPL(tags)
10835 };
10836 }
10837 static void from_json(const nlohmann::json& j, CertStoreCertificate& p)
10838 {
10839 p.clear();
10840 j.at("id").get_to(p.id);
10841 j.at("certificatePem").get_to(p.certificatePem);
10842 getOptional<std::string>("privateKeyPem", p.privateKeyPem, j, EMPTY_STRING);
10843 getOptional<std::string>("tags", p.tags, j, EMPTY_STRING);
10844 }
10845
10846 //-----------------------------------------------------------
10847 JSON_SERIALIZED_CLASS(CertStore)
10855 {
10856 IMPLEMENT_JSON_SERIALIZATION()
10857 IMPLEMENT_JSON_DOCUMENTATION(CertStore)
10858
10859 public:
10861 std::string id;
10862
10864 std::vector<CertStoreCertificate> certificates;
10865
10867 std::vector<KvPair> kvp;
10868
10869 CertStore()
10870 {
10871 clear();
10872 }
10873
10874 void clear()
10875 {
10876 id.clear();
10877 certificates.clear();
10878 kvp.clear();
10879 }
10880 };
10881
10882 static void to_json(nlohmann::json& j, const CertStore& p)
10883 {
10884 j = nlohmann::json{
10885 TOJSON_IMPL(id),
10886 TOJSON_IMPL(certificates),
10887 TOJSON_IMPL(kvp)
10888 };
10889 }
10890 static void from_json(const nlohmann::json& j, CertStore& p)
10891 {
10892 p.clear();
10893 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
10894 getOptional<std::vector<CertStoreCertificate>>("certificates", p.certificates, j);
10895 getOptional<std::vector<KvPair>>("kvp", p.kvp, j);
10896 }
10897
10898 //-----------------------------------------------------------
10899 JSON_SERIALIZED_CLASS(CertStoreCertificateElement)
10907 {
10908 IMPLEMENT_JSON_SERIALIZATION()
10909 IMPLEMENT_JSON_DOCUMENTATION(CertStoreCertificateElement)
10910
10911 public:
10913 std::string id;
10914
10917
10919 std::string certificatePem;
10920
10922 std::string tags;
10923
10925 {
10926 clear();
10927 }
10928
10929 void clear()
10930 {
10931 id.clear();
10932 hasPrivateKey = false;
10933 tags.clear();
10934 }
10935 };
10936
10937 static void to_json(nlohmann::json& j, const CertStoreCertificateElement& p)
10938 {
10939 j = nlohmann::json{
10940 TOJSON_IMPL(id),
10941 TOJSON_IMPL(hasPrivateKey),
10942 TOJSON_IMPL(tags)
10943 };
10944
10945 if(!p.certificatePem.empty())
10946 {
10947 j["certificatePem"] = p.certificatePem;
10948 }
10949 }
10950 static void from_json(const nlohmann::json& j, CertStoreCertificateElement& p)
10951 {
10952 p.clear();
10953 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
10954 getOptional<bool>("hasPrivateKey", p.hasPrivateKey, j, false);
10955 getOptional<std::string>("certificatePem", p.certificatePem, j, EMPTY_STRING);
10956 getOptional<std::string>("tags", p.tags, j, EMPTY_STRING);
10957 }
10958
10959 //-----------------------------------------------------------
10960 JSON_SERIALIZED_CLASS(CertStoreDescriptor)
10968 {
10969 IMPLEMENT_JSON_SERIALIZATION()
10970 IMPLEMENT_JSON_DOCUMENTATION(CertStoreDescriptor)
10971
10972 public:
10974 std::string id;
10975
10977 std::string fileName;
10978
10981
10984
10986 std::vector<CertStoreCertificateElement> certificates;
10987
10989 std::vector<KvPair> kvp;
10990
10992 {
10993 clear();
10994 }
10995
10996 void clear()
10997 {
10998 id.clear();
10999 fileName.clear();
11000 version = 0;
11001 flags = 0;
11002 certificates.clear();
11003 kvp.clear();
11004 }
11005 };
11006
11007 static void to_json(nlohmann::json& j, const CertStoreDescriptor& p)
11008 {
11009 j = nlohmann::json{
11010 TOJSON_IMPL(id),
11011 TOJSON_IMPL(fileName),
11012 TOJSON_IMPL(version),
11013 TOJSON_IMPL(flags),
11014 TOJSON_IMPL(certificates),
11015 TOJSON_IMPL(kvp)
11016 };
11017 }
11018 static void from_json(const nlohmann::json& j, CertStoreDescriptor& p)
11019 {
11020 p.clear();
11021 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
11022 getOptional<std::string>("fileName", p.fileName, j, EMPTY_STRING);
11023 getOptional<int>("version", p.version, j, 0);
11024 getOptional<int>("flags", p.flags, j, 0);
11025 getOptional<std::vector<CertStoreCertificateElement>>("certificates", p.certificates, j);
11026 getOptional<std::vector<KvPair>>("kvp", p.kvp, j);
11027 }
11028
11029 //-----------------------------------------------------------
11030 JSON_SERIALIZED_CLASS(CertificateSubjectElement)
11038 {
11039 IMPLEMENT_JSON_SERIALIZATION()
11040 IMPLEMENT_JSON_DOCUMENTATION(CertificateSubjectElement)
11041
11042 public:
11044 std::string name;
11045
11047 std::string value;
11048
11050 {
11051 clear();
11052 }
11053
11054 void clear()
11055 {
11056 name.clear();
11057 value.clear();
11058 }
11059 };
11060
11061 static void to_json(nlohmann::json& j, const CertificateSubjectElement& p)
11062 {
11063 j = nlohmann::json{
11064 TOJSON_IMPL(name),
11065 TOJSON_IMPL(value)
11066 };
11067 }
11068 static void from_json(const nlohmann::json& j, CertificateSubjectElement& p)
11069 {
11070 p.clear();
11071 getOptional<std::string>("name", p.name, j, EMPTY_STRING);
11072 getOptional<std::string>("value", p.value, j, EMPTY_STRING);
11073 }
11074
11075
11076 //-----------------------------------------------------------
11077 JSON_SERIALIZED_CLASS(CertificateDescriptor)
11085 {
11086 IMPLEMENT_JSON_SERIALIZATION()
11087 IMPLEMENT_JSON_DOCUMENTATION(CertificateDescriptor)
11088
11089 public:
11091 std::string subject;
11092
11094 std::string issuer;
11095
11098
11101
11103 std::string notBefore;
11104
11106 std::string notAfter;
11107
11109 std::string serial;
11110
11112 std::string fingerprint;
11113
11115 std::vector<CertificateSubjectElement> subjectElements;
11116
11118 std::vector<CertificateSubjectElement> issuerElements;
11119
11121 std::string certificatePem;
11122
11124 std::string publicKeyPem;
11125
11127 {
11128 clear();
11129 }
11130
11131 void clear()
11132 {
11133 subject.clear();
11134 issuer.clear();
11135 selfSigned = false;
11136 version = 0;
11137 notBefore.clear();
11138 notAfter.clear();
11139 serial.clear();
11140 fingerprint.clear();
11141 subjectElements.clear();
11142 issuerElements.clear();
11143 certificatePem.clear();
11144 publicKeyPem.clear();
11145 }
11146 };
11147
11148 static void to_json(nlohmann::json& j, const CertificateDescriptor& p)
11149 {
11150 j = nlohmann::json{
11151 TOJSON_IMPL(subject),
11152 TOJSON_IMPL(issuer),
11153 TOJSON_IMPL(selfSigned),
11154 TOJSON_IMPL(version),
11155 TOJSON_IMPL(notBefore),
11156 TOJSON_IMPL(notAfter),
11157 TOJSON_IMPL(serial),
11158 TOJSON_IMPL(fingerprint),
11159 TOJSON_IMPL(subjectElements),
11160 TOJSON_IMPL(issuerElements),
11161 TOJSON_IMPL(certificatePem),
11162 TOJSON_IMPL(publicKeyPem)
11163 };
11164 }
11165 static void from_json(const nlohmann::json& j, CertificateDescriptor& p)
11166 {
11167 p.clear();
11168 getOptional<std::string>("subject", p.subject, j, EMPTY_STRING);
11169 getOptional<std::string>("issuer", p.issuer, j, EMPTY_STRING);
11170 getOptional<bool>("selfSigned", p.selfSigned, j, false);
11171 getOptional<int>("version", p.version, j, 0);
11172 getOptional<std::string>("notBefore", p.notBefore, j, EMPTY_STRING);
11173 getOptional<std::string>("notAfter", p.notAfter, j, EMPTY_STRING);
11174 getOptional<std::string>("serial", p.serial, j, EMPTY_STRING);
11175 getOptional<std::string>("fingerprint", p.fingerprint, j, EMPTY_STRING);
11176 getOptional<std::string>("certificatePem", p.certificatePem, j, EMPTY_STRING);
11177 getOptional<std::string>("publicKeyPem", p.publicKeyPem, j, EMPTY_STRING);
11178 getOptional<std::vector<CertificateSubjectElement>>("subjectElements", p.subjectElements, j);
11179 getOptional<std::vector<CertificateSubjectElement>>("issuerElements", p.issuerElements, j);
11180 }
11181
11182
11183 //-----------------------------------------------------------
11184 JSON_SERIALIZED_CLASS(RiffDescriptor)
11195 {
11196 IMPLEMENT_JSON_SERIALIZATION()
11197 IMPLEMENT_JSON_DOCUMENTATION(RiffDescriptor)
11198
11199 public:
11201 std::string file;
11202
11205
11208
11211
11213 std::string meta;
11214
11216 std::string certPem;
11217
11220
11222 std::string signature;
11223
11225 {
11226 clear();
11227 }
11228
11229 void clear()
11230 {
11231 file.clear();
11232 verified = false;
11233 channels = 0;
11234 sampleCount = 0;
11235 meta.clear();
11236 certPem.clear();
11237 certDescriptor.clear();
11238 signature.clear();
11239 }
11240 };
11241
11242 static void to_json(nlohmann::json& j, const RiffDescriptor& p)
11243 {
11244 j = nlohmann::json{
11245 TOJSON_IMPL(file),
11246 TOJSON_IMPL(verified),
11247 TOJSON_IMPL(channels),
11248 TOJSON_IMPL(sampleCount),
11249 TOJSON_IMPL(meta),
11250 TOJSON_IMPL(certPem),
11251 TOJSON_IMPL(certDescriptor),
11252 TOJSON_IMPL(signature)
11253 };
11254 }
11255
11256 static void from_json(const nlohmann::json& j, RiffDescriptor& p)
11257 {
11258 p.clear();
11259 FROMJSON_IMPL(file, std::string, EMPTY_STRING);
11260 FROMJSON_IMPL(verified, bool, false);
11261 FROMJSON_IMPL(channels, int, 0);
11262 FROMJSON_IMPL(sampleCount, int, 0);
11263 FROMJSON_IMPL(meta, std::string, EMPTY_STRING);
11264 FROMJSON_IMPL(certPem, std::string, EMPTY_STRING);
11265 getOptional<CertificateDescriptor>("certDescriptor", p.certDescriptor, j);
11266 FROMJSON_IMPL(signature, std::string, EMPTY_STRING);
11267 }
11268
11269
11270 //-----------------------------------------------------------
11271 JSON_SERIALIZED_CLASS(BridgeCreationDetail)
11279 {
11280 IMPLEMENT_JSON_SERIALIZATION()
11281 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(BridgeCreationDetail)
11282 IMPLEMENT_JSON_DOCUMENTATION(BridgeCreationDetail)
11283
11284 public:
11286 typedef enum
11287 {
11289 csUndefined = 0,
11290
11292 csOk = 1,
11293
11295 csNoJson = -1,
11296
11298 csAlreadyExists = -3,
11299
11301 csInvalidConfiguration = -4,
11302
11304 csInvalidJson = -5,
11305
11307 csInsufficientGroups = -6,
11308
11310 csTooManyGroups = -7,
11311
11313 csDuplicateGroup = -8,
11314
11316 csLocalLoopDetected = -9,
11317 } CreationStatus_t;
11318
11320 std::string id;
11321
11324
11326 {
11327 clear();
11328 }
11329
11330 void clear()
11331 {
11332 id.clear();
11333 status = csUndefined;
11334 }
11335 };
11336
11337 static void to_json(nlohmann::json& j, const BridgeCreationDetail& p)
11338 {
11339 j = nlohmann::json{
11340 TOJSON_IMPL(id),
11341 TOJSON_IMPL(status)
11342 };
11343 }
11344 static void from_json(const nlohmann::json& j, BridgeCreationDetail& p)
11345 {
11346 p.clear();
11347 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
11348 getOptional<BridgeCreationDetail::CreationStatus_t>("status", p.status, j, BridgeCreationDetail::CreationStatus_t::csUndefined);
11349 }
11350 //-----------------------------------------------------------
11351 JSON_SERIALIZED_CLASS(GroupConnectionDetail)
11359 {
11360 IMPLEMENT_JSON_SERIALIZATION()
11361 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(GroupConnectionDetail)
11362 IMPLEMENT_JSON_DOCUMENTATION(GroupConnectionDetail)
11363
11364 public:
11366 typedef enum
11367 {
11369 ctUndefined = 0,
11370
11372 ctDirectDatagram = 1,
11373
11375 ctRallypoint = 2
11376 } ConnectionType_t;
11377
11379 std::string id;
11380
11383
11385 std::string peer;
11386
11389
11391 std::string reason;
11392
11394 {
11395 clear();
11396 }
11397
11398 void clear()
11399 {
11400 id.clear();
11401 connectionType = ctUndefined;
11402 peer.clear();
11403 asFailover = false;
11404 reason.clear();
11405 }
11406 };
11407
11408 static void to_json(nlohmann::json& j, const GroupConnectionDetail& p)
11409 {
11410 j = nlohmann::json{
11411 TOJSON_IMPL(id),
11412 TOJSON_IMPL(connectionType),
11413 TOJSON_IMPL(peer),
11414 TOJSON_IMPL(asFailover),
11415 TOJSON_IMPL(reason)
11416 };
11417
11418 if(p.asFailover)
11419 {
11420 j["asFailover"] = p.asFailover;
11421 }
11422 }
11423 static void from_json(const nlohmann::json& j, GroupConnectionDetail& p)
11424 {
11425 p.clear();
11426 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
11427 getOptional<GroupConnectionDetail::ConnectionType_t>("connectionType", p.connectionType, j, GroupConnectionDetail::ConnectionType_t::ctUndefined);
11428 getOptional<std::string>("peer", p.peer, j, EMPTY_STRING);
11429 getOptional<bool>("asFailover", p.asFailover, j, false);
11430 getOptional<std::string>("reason", p.reason, j, EMPTY_STRING);
11431 }
11432
11433 //-----------------------------------------------------------
11434 JSON_SERIALIZED_CLASS(GroupTxDetail)
11442 {
11443 IMPLEMENT_JSON_SERIALIZATION()
11444 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(GroupTxDetail)
11445 IMPLEMENT_JSON_DOCUMENTATION(GroupTxDetail)
11446
11447 public:
11449 typedef enum
11450 {
11452 txsUndefined = 0,
11453
11455 txsTxStarted = 1,
11456
11458 txsTxEnded = 2,
11459
11461 txsNotAnAudioGroup = -1,
11462
11464 txsNotJoined = -2,
11465
11467 txsNotConnected = -3,
11468
11470 txsAlreadyTransmitting = -4,
11471
11473 txsInvalidParams = -5,
11474
11476 txsPriorityTooLow = -6,
11477
11479 txsRxActiveOnNonFdx = -7,
11480
11482 txsCannotSubscribeToInput = -8,
11483
11485 txsInvalidId = -9,
11486
11488 txsTxEndedWithFailure = -10,
11489
11491 txsBridgedButNotMultistream = -11,
11492
11494 txsAutoEndedDueToNonMultistreamBridge = -12,
11495
11497 txsReBeginWithoutPriorBegin = -13
11498 } TxStatus_t;
11499
11501 std::string id;
11502
11505
11508
11511
11514
11516 uint32_t txId;
11517
11519 {
11520 clear();
11521 }
11522
11523 void clear()
11524 {
11525 id.clear();
11526 status = txsUndefined;
11527 localPriority = 0;
11528 remotePriority = 0;
11529 nonFdxMsHangRemaining = 0;
11530 txId = 0;
11531 }
11532 };
11533
11534 static void to_json(nlohmann::json& j, const GroupTxDetail& p)
11535 {
11536 j = nlohmann::json{
11537 TOJSON_IMPL(id),
11538 TOJSON_IMPL(status),
11539 TOJSON_IMPL(localPriority),
11540 TOJSON_IMPL(txId)
11541 };
11542
11543 // Include remote priority if status is related to that
11544 if(p.status == GroupTxDetail::TxStatus_t::txsPriorityTooLow)
11545 {
11546 j["remotePriority"] = p.remotePriority;
11547 }
11548 else if(p.status == GroupTxDetail::TxStatus_t::txsRxActiveOnNonFdx)
11549 {
11550 j["nonFdxMsHangRemaining"] = p.nonFdxMsHangRemaining;
11551 }
11552 }
11553 static void from_json(const nlohmann::json& j, GroupTxDetail& p)
11554 {
11555 p.clear();
11556 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
11557 getOptional<GroupTxDetail::TxStatus_t>("status", p.status, j, GroupTxDetail::TxStatus_t::txsUndefined);
11558 getOptional<int>("localPriority", p.localPriority, j, 0);
11559 getOptional<int>("remotePriority", p.remotePriority, j, 0);
11560 getOptional<long>("nonFdxMsHangRemaining", p.nonFdxMsHangRemaining, j, 0);
11561 getOptional<uint32_t>("txId", p.txId, j, 0);
11562 }
11563
11564 //-----------------------------------------------------------
11565 JSON_SERIALIZED_CLASS(GroupCreationDetail)
11573 {
11574 IMPLEMENT_JSON_SERIALIZATION()
11575 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(GroupCreationDetail)
11576 IMPLEMENT_JSON_DOCUMENTATION(GroupCreationDetail)
11577
11578 public:
11580 typedef enum
11581 {
11583 csUndefined = 0,
11584
11586 csOk = 1,
11587
11589 csNoJson = -1,
11590
11592 csConflictingRpListAndCluster = -2,
11593
11595 csAlreadyExists = -3,
11596
11598 csInvalidConfiguration = -4,
11599
11601 csInvalidJson = -5,
11602
11604 csCryptoFailure = -6,
11605
11607 csAudioInputFailure = -7,
11608
11610 csAudioOutputFailure = -8,
11611
11613 csUnsupportedAudioEncoder = -9,
11614
11616 csNoLicense = -10,
11617
11619 csInvalidTransport = -11,
11620
11622 csAudioInputDeviceNotFound = -12,
11623
11625 csAudioOutputDeviceNotFound = -13
11626 } CreationStatus_t;
11627
11629 std::string id;
11630
11633
11635 {
11636 clear();
11637 }
11638
11639 void clear()
11640 {
11641 id.clear();
11642 status = csUndefined;
11643 }
11644 };
11645
11646 static void to_json(nlohmann::json& j, const GroupCreationDetail& p)
11647 {
11648 j = nlohmann::json{
11649 TOJSON_IMPL(id),
11650 TOJSON_IMPL(status)
11651 };
11652 }
11653 static void from_json(const nlohmann::json& j, GroupCreationDetail& p)
11654 {
11655 p.clear();
11656 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
11657 getOptional<GroupCreationDetail::CreationStatus_t>("status", p.status, j, GroupCreationDetail::CreationStatus_t::csUndefined);
11658 }
11659
11660
11661 //-----------------------------------------------------------
11662 JSON_SERIALIZED_CLASS(GroupReconfigurationDetail)
11670 {
11671 IMPLEMENT_JSON_SERIALIZATION()
11672 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(GroupReconfigurationDetail)
11673 IMPLEMENT_JSON_DOCUMENTATION(GroupReconfigurationDetail)
11674
11675 public:
11677 typedef enum
11678 {
11680 rsUndefined = 0,
11681
11683 rsOk = 1,
11684
11686 rsNoJson = -1,
11687
11689 rsInvalidConfiguration = -2,
11690
11692 rsInvalidJson = -3,
11693
11695 rsAudioInputFailure = -4,
11696
11698 rsAudioOutputFailure = -5,
11699
11701 rsDoesNotExist = -6,
11702
11704 rsAudioInputInUse = -7,
11705
11707 rsAudioDisabledForGroup = -8,
11708
11710 rsGroupIsNotAudio = -9
11711 } ReconfigurationStatus_t;
11712
11714 std::string id;
11715
11718
11720 {
11721 clear();
11722 }
11723
11724 void clear()
11725 {
11726 id.clear();
11727 status = rsUndefined;
11728 }
11729 };
11730
11731 static void to_json(nlohmann::json& j, const GroupReconfigurationDetail& p)
11732 {
11733 j = nlohmann::json{
11734 TOJSON_IMPL(id),
11735 TOJSON_IMPL(status)
11736 };
11737 }
11738 static void from_json(const nlohmann::json& j, GroupReconfigurationDetail& p)
11739 {
11740 p.clear();
11741 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
11742 getOptional<GroupReconfigurationDetail::ReconfigurationStatus_t>("status", p.status, j, GroupReconfigurationDetail::ReconfigurationStatus_t::rsUndefined);
11743 }
11744
11745
11746 //-----------------------------------------------------------
11747 JSON_SERIALIZED_CLASS(GroupHealthReport)
11755 {
11756 IMPLEMENT_JSON_SERIALIZATION()
11757 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(GroupHealthReport)
11758 IMPLEMENT_JSON_DOCUMENTATION(GroupHealthReport)
11759
11760 public:
11761 std::string id;
11762 uint64_t lastErrorTs;
11763 uint64_t decryptionErrors;
11764 uint64_t encryptionErrors;
11765 uint64_t unsupportDecoderErrors;
11766 uint64_t decoderFailures;
11767 uint64_t decoderStartFailures;
11768 uint64_t inboundRtpPacketAllocationFailures;
11769 uint64_t inboundRtpPacketLoadFailures;
11770 uint64_t latePacketsDiscarded;
11771 uint64_t jitterBufferInsertionFailures;
11772 uint64_t presenceDeserializationFailures;
11773 uint64_t notRtpErrors;
11774 uint64_t generalErrors;
11775 uint64_t inboundRtpProcessorAllocationFailures;
11776
11778 {
11779 clear();
11780 }
11781
11782 void clear()
11783 {
11784 id.clear();
11785 lastErrorTs = 0;
11786 decryptionErrors = 0;
11787 encryptionErrors = 0;
11788 unsupportDecoderErrors = 0;
11789 decoderFailures = 0;
11790 decoderStartFailures = 0;
11791 inboundRtpPacketAllocationFailures = 0;
11792 inboundRtpPacketLoadFailures = 0;
11793 latePacketsDiscarded = 0;
11794 jitterBufferInsertionFailures = 0;
11795 presenceDeserializationFailures = 0;
11796 notRtpErrors = 0;
11797 generalErrors = 0;
11798 inboundRtpProcessorAllocationFailures = 0;
11799 }
11800 };
11801
11802 static void to_json(nlohmann::json& j, const GroupHealthReport& p)
11803 {
11804 j = nlohmann::json{
11805 TOJSON_IMPL(id),
11806 TOJSON_IMPL(lastErrorTs),
11807 TOJSON_IMPL(decryptionErrors),
11808 TOJSON_IMPL(encryptionErrors),
11809 TOJSON_IMPL(unsupportDecoderErrors),
11810 TOJSON_IMPL(decoderFailures),
11811 TOJSON_IMPL(decoderStartFailures),
11812 TOJSON_IMPL(inboundRtpPacketAllocationFailures),
11813 TOJSON_IMPL(inboundRtpPacketLoadFailures),
11814 TOJSON_IMPL(latePacketsDiscarded),
11815 TOJSON_IMPL(jitterBufferInsertionFailures),
11816 TOJSON_IMPL(presenceDeserializationFailures),
11817 TOJSON_IMPL(notRtpErrors),
11818 TOJSON_IMPL(generalErrors),
11819 TOJSON_IMPL(inboundRtpProcessorAllocationFailures)
11820 };
11821 }
11822 static void from_json(const nlohmann::json& j, GroupHealthReport& p)
11823 {
11824 p.clear();
11825 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
11826 getOptional<uint64_t>("lastErrorTs", p.lastErrorTs, j, 0);
11827 getOptional<uint64_t>("decryptionErrors", p.decryptionErrors, j, 0);
11828 getOptional<uint64_t>("encryptionErrors", p.encryptionErrors, j, 0);
11829 getOptional<uint64_t>("unsupportDecoderErrors", p.unsupportDecoderErrors, j, 0);
11830 getOptional<uint64_t>("decoderFailures", p.decoderFailures, j, 0);
11831 getOptional<uint64_t>("decoderStartFailures", p.decoderStartFailures, j, 0);
11832 getOptional<uint64_t>("inboundRtpPacketAllocationFailures", p.inboundRtpPacketAllocationFailures, j, 0);
11833 getOptional<uint64_t>("inboundRtpPacketLoadFailures", p.inboundRtpPacketLoadFailures, j, 0);
11834 getOptional<uint64_t>("latePacketsDiscarded", p.latePacketsDiscarded, j, 0);
11835 getOptional<uint64_t>("jitterBufferInsertionFailures", p.jitterBufferInsertionFailures, j, 0);
11836 getOptional<uint64_t>("presenceDeserializationFailures", p.presenceDeserializationFailures, j, 0);
11837 getOptional<uint64_t>("notRtpErrors", p.notRtpErrors, j, 0);
11838 getOptional<uint64_t>("generalErrors", p.generalErrors, j, 0);
11839 getOptional<uint64_t>("inboundRtpProcessorAllocationFailures", p.inboundRtpProcessorAllocationFailures, j, 0);
11840 }
11841
11842 //-----------------------------------------------------------
11843 JSON_SERIALIZED_CLASS(InboundProcessorStats)
11851 {
11852 IMPLEMENT_JSON_SERIALIZATION()
11853 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(InboundProcessorStats)
11854 IMPLEMENT_JSON_DOCUMENTATION(InboundProcessorStats)
11855
11856 public:
11857 uint32_t ssrc;
11858 double jitter;
11859 uint64_t minRtpSamplesInQueue;
11860 uint64_t maxRtpSamplesInQueue;
11861 uint64_t totalSamplesTrimmed;
11862 uint64_t underruns;
11863 uint64_t overruns;
11864 uint64_t samplesInQueue;
11865 uint64_t totalPacketsReceived;
11866 uint64_t totalPacketsLost;
11867 uint64_t totalPacketsDiscarded;
11868
11870 {
11871 clear();
11872 }
11873
11874 void clear()
11875 {
11876 ssrc = 0;
11877 jitter = 0.0;
11878 minRtpSamplesInQueue = 0;
11879 maxRtpSamplesInQueue = 0;
11880 totalSamplesTrimmed = 0;
11881 underruns = 0;
11882 overruns = 0;
11883 samplesInQueue = 0;
11884 totalPacketsReceived = 0;
11885 totalPacketsLost = 0;
11886 totalPacketsDiscarded = 0;
11887 }
11888 };
11889
11890 static void to_json(nlohmann::json& j, const InboundProcessorStats& p)
11891 {
11892 j = nlohmann::json{
11893 TOJSON_IMPL(ssrc),
11894 TOJSON_IMPL(jitter),
11895 TOJSON_IMPL(minRtpSamplesInQueue),
11896 TOJSON_IMPL(maxRtpSamplesInQueue),
11897 TOJSON_IMPL(totalSamplesTrimmed),
11898 TOJSON_IMPL(underruns),
11899 TOJSON_IMPL(overruns),
11900 TOJSON_IMPL(samplesInQueue),
11901 TOJSON_IMPL(totalPacketsReceived),
11902 TOJSON_IMPL(totalPacketsLost),
11903 TOJSON_IMPL(totalPacketsDiscarded)
11904 };
11905 }
11906 static void from_json(const nlohmann::json& j, InboundProcessorStats& p)
11907 {
11908 p.clear();
11909 getOptional<uint32_t>("ssrc", p.ssrc, j, 0);
11910 getOptional<double>("jitter", p.jitter, j, 0.0);
11911 getOptional<uint64_t>("minRtpSamplesInQueue", p.minRtpSamplesInQueue, j, 0);
11912 getOptional<uint64_t>("maxRtpSamplesInQueue", p.maxRtpSamplesInQueue, j, 0);
11913 getOptional<uint64_t>("totalSamplesTrimmed", p.totalSamplesTrimmed, j, 0);
11914 getOptional<uint64_t>("underruns", p.underruns, j, 0);
11915 getOptional<uint64_t>("overruns", p.overruns, j, 0);
11916 getOptional<uint64_t>("samplesInQueue", p.samplesInQueue, j, 0);
11917 getOptional<uint64_t>("totalPacketsReceived", p.totalPacketsReceived, j, 0);
11918 getOptional<uint64_t>("totalPacketsLost", p.totalPacketsLost, j, 0);
11919 getOptional<uint64_t>("totalPacketsDiscarded", p.totalPacketsDiscarded, j, 0);
11920 }
11921
11922 //-----------------------------------------------------------
11923 JSON_SERIALIZED_CLASS(TrafficCounter)
11931 {
11932 IMPLEMENT_JSON_SERIALIZATION()
11933 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(TrafficCounter)
11934 IMPLEMENT_JSON_DOCUMENTATION(TrafficCounter)
11935
11936 public:
11937 uint64_t packets;
11938 uint64_t bytes;
11939 uint64_t errors;
11940
11942 {
11943 clear();
11944 }
11945
11946 void clear()
11947 {
11948 packets = 0;
11949 bytes = 0;
11950 errors = 0;
11951 }
11952 };
11953
11954 static void to_json(nlohmann::json& j, const TrafficCounter& p)
11955 {
11956 j = nlohmann::json{
11957 TOJSON_IMPL(packets),
11958 TOJSON_IMPL(bytes),
11959 TOJSON_IMPL(errors)
11960 };
11961 }
11962 static void from_json(const nlohmann::json& j, TrafficCounter& p)
11963 {
11964 p.clear();
11965 getOptional<uint64_t>("packets", p.packets, j, 0);
11966 getOptional<uint64_t>("bytes", p.bytes, j, 0);
11967 getOptional<uint64_t>("errors", p.errors, j, 0);
11968 }
11969
11970 //-----------------------------------------------------------
11971 JSON_SERIALIZED_CLASS(GroupStats)
11979 {
11980 IMPLEMENT_JSON_SERIALIZATION()
11981 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(GroupStats)
11982 IMPLEMENT_JSON_DOCUMENTATION(GroupStats)
11983
11984 public:
11985 std::string id;
11986 //std::vector<InboundProcessorStats> rtpInbounds;
11987 TrafficCounter rxTraffic;
11988 TrafficCounter txTraffic;
11989
11990 GroupStats()
11991 {
11992 clear();
11993 }
11994
11995 void clear()
11996 {
11997 id.clear();
11998 //rtpInbounds.clear();
11999 rxTraffic.clear();
12000 txTraffic.clear();
12001 }
12002 };
12003
12004 static void to_json(nlohmann::json& j, const GroupStats& p)
12005 {
12006 j = nlohmann::json{
12007 TOJSON_IMPL(id),
12008 //TOJSON_IMPL(rtpInbounds),
12009 TOJSON_IMPL(rxTraffic),
12010 TOJSON_IMPL(txTraffic)
12011 };
12012 }
12013 static void from_json(const nlohmann::json& j, GroupStats& p)
12014 {
12015 p.clear();
12016 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
12017 //getOptional<std::vector<InboundProcessorStats>>("rtpInbounds", p.rtpInbounds, j);
12018 getOptional<TrafficCounter>("rxTraffic", p.rxTraffic, j);
12019 getOptional<TrafficCounter>("txTraffic", p.txTraffic, j);
12020 }
12021
12022 //-----------------------------------------------------------
12023 JSON_SERIALIZED_CLASS(RallypointConnectionDetail)
12031 {
12032 IMPLEMENT_JSON_SERIALIZATION()
12033 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(RallypointConnectionDetail)
12034 IMPLEMENT_JSON_DOCUMENTATION(RallypointConnectionDetail)
12035
12036 public:
12038 std::string internalId;
12039
12041 std::string host;
12042
12044 int port;
12045
12048
12051
12053 {
12054 clear();
12055 }
12056
12057 void clear()
12058 {
12059 internalId.clear();
12060 host.clear();
12061 port = 0;
12062 msToNextConnectionAttempt = 0;
12063 serverProcessingMs = -1.0f;
12064 }
12065 };
12066
12067 static void to_json(nlohmann::json& j, const RallypointConnectionDetail& p)
12068 {
12069 j = nlohmann::json{
12070 TOJSON_IMPL(internalId),
12071 TOJSON_IMPL(host),
12072 TOJSON_IMPL(port)
12073 };
12074
12075 if(p.msToNextConnectionAttempt > 0)
12076 {
12077 j["msToNextConnectionAttempt"] = p.msToNextConnectionAttempt;
12078 }
12079
12080 if(p.serverProcessingMs >= 0.0)
12081 {
12082 j["serverProcessingMs"] = p.serverProcessingMs;
12083 }
12084 }
12085 static void from_json(const nlohmann::json& j, RallypointConnectionDetail& p)
12086 {
12087 p.clear();
12088 getOptional<std::string>("internalId", p.internalId, j, EMPTY_STRING);
12089 getOptional<std::string>("host", p.host, j, EMPTY_STRING);
12090 getOptional<int>("port", p.port, j, 0);
12091 getOptional<uint64_t>("msToNextConnectionAttempt", p.msToNextConnectionAttempt, j, 0);
12092 getOptional<float>("serverProcessingMs", p.serverProcessingMs, j, -1.0);
12093 }
12094
12095 //-----------------------------------------------------------
12096 JSON_SERIALIZED_CLASS(TranslationSession)
12107 {
12108 IMPLEMENT_JSON_SERIALIZATION()
12109 IMPLEMENT_JSON_DOCUMENTATION(TranslationSession)
12110
12111 public:
12113 std::string id;
12114
12116 std::string name;
12117
12119 std::vector<std::string> groups;
12120
12123
12125 {
12126 clear();
12127 }
12128
12129 void clear()
12130 {
12131 id.clear();
12132 name.clear();
12133 groups.clear();
12134 enabled = true;
12135 }
12136 };
12137
12138 static void to_json(nlohmann::json& j, const TranslationSession& p)
12139 {
12140 j = nlohmann::json{
12141 TOJSON_IMPL(id),
12142 TOJSON_IMPL(name),
12143 TOJSON_IMPL(groups),
12144 TOJSON_IMPL(enabled)
12145 };
12146 }
12147 static void from_json(const nlohmann::json& j, TranslationSession& p)
12148 {
12149 p.clear();
12150 FROMJSON_IMPL(id, std::string, EMPTY_STRING);
12151 FROMJSON_IMPL(name, std::string, EMPTY_STRING);
12152 getOptional<std::vector<std::string>>("groups", p.groups, j);
12153 FROMJSON_IMPL(enabled, bool, true);
12154 }
12155
12156 //-----------------------------------------------------------
12157 JSON_SERIALIZED_CLASS(TranslationConfiguration)
12168 {
12169 IMPLEMENT_JSON_SERIALIZATION()
12170 IMPLEMENT_JSON_DOCUMENTATION(TranslationConfiguration)
12171
12172 public:
12174 std::vector<TranslationSession> sessions;
12175
12177 std::vector<Group> groups;
12178
12180 {
12181 clear();
12182 }
12183
12184 void clear()
12185 {
12186 sessions.clear();
12187 groups.clear();
12188 }
12189 };
12190
12191 static void to_json(nlohmann::json& j, const TranslationConfiguration& p)
12192 {
12193 j = nlohmann::json{
12194 TOJSON_IMPL(sessions),
12195 TOJSON_IMPL(groups)
12196 };
12197 }
12198 static void from_json(const nlohmann::json& j, TranslationConfiguration& p)
12199 {
12200 p.clear();
12201 getOptional<std::vector<TranslationSession>>("sessions", p.sessions, j);
12202 getOptional<std::vector<Group>>("groups", p.groups, j);
12203 }
12204
12205 //-----------------------------------------------------------
12206 JSON_SERIALIZED_CLASS(LingoServerStatusReportConfiguration)
12217 {
12218 IMPLEMENT_JSON_SERIALIZATION()
12219 IMPLEMENT_JSON_DOCUMENTATION(LingoServerStatusReportConfiguration)
12220
12221 public:
12223 std::string fileName;
12224
12227
12230
12232 std::string runCmd;
12233
12236
12239
12242
12244 {
12245 clear();
12246 }
12247
12248 void clear()
12249 {
12250 fileName.clear();
12251 intervalSecs = 60;
12252 enabled = false;
12253 includeGroupDetail = false;
12254 includeSessionDetail = false;
12255 includeSessionGroupDetail = false;
12256 runCmd.clear();
12257 }
12258 };
12259
12260 static void to_json(nlohmann::json& j, const LingoServerStatusReportConfiguration& p)
12261 {
12262 j = nlohmann::json{
12263 TOJSON_IMPL(fileName),
12264 TOJSON_IMPL(intervalSecs),
12265 TOJSON_IMPL(enabled),
12266 TOJSON_IMPL(includeGroupDetail),
12267 TOJSON_IMPL(includeSessionDetail),
12268 TOJSON_IMPL(includeSessionGroupDetail),
12269 TOJSON_IMPL(runCmd)
12270 };
12271 }
12272 static void from_json(const nlohmann::json& j, LingoServerStatusReportConfiguration& p)
12273 {
12274 p.clear();
12275 getOptional<std::string>("fileName", p.fileName, j);
12276 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
12277 getOptional<bool>("enabled", p.enabled, j, false);
12278 getOptional<std::string>("runCmd", p.runCmd, j);
12279 getOptional<bool>("includeGroupDetail", p.includeGroupDetail, j, false);
12280 getOptional<bool>("includeSessionDetail", p.includeSessionDetail, j, false);
12281 getOptional<bool>("includeSessionGroupDetail", p.includeSessionGroupDetail, j, false);
12282 }
12283
12284 //-----------------------------------------------------------
12285 JSON_SERIALIZED_CLASS(LingoServerInternals)
12298 {
12299 IMPLEMENT_JSON_SERIALIZATION()
12300 IMPLEMENT_JSON_DOCUMENTATION(LingoServerInternals)
12301
12302 public:
12305
12308
12311
12313 {
12314 clear();
12315 }
12316
12317 void clear()
12318 {
12319 watchdog.clear();
12320 tuning.clear();
12321 housekeeperIntervalMs = 1000;
12322 }
12323 };
12324
12325 static void to_json(nlohmann::json& j, const LingoServerInternals& p)
12326 {
12327 j = nlohmann::json{
12328 TOJSON_IMPL(watchdog),
12329 TOJSON_IMPL(housekeeperIntervalMs),
12330 TOJSON_IMPL(tuning)
12331 };
12332 }
12333 static void from_json(const nlohmann::json& j, LingoServerInternals& p)
12334 {
12335 p.clear();
12336 getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
12337 getOptional<int>("housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
12338 getOptional<TuningSettings>("tuning", p.tuning, j);
12339 }
12340
12341 //-----------------------------------------------------------
12342 JSON_SERIALIZED_CLASS(LingoServerConfiguration)
12352 {
12353 IMPLEMENT_JSON_SERIALIZATION()
12354 IMPLEMENT_JSON_DOCUMENTATION(LingoServerConfiguration)
12355
12356 public:
12358 std::string id;
12359
12362
12365
12368
12371
12374
12377
12380
12383
12386
12389
12392
12395
12398
12401
12403 {
12404 clear();
12405 }
12406
12407 void clear()
12408 {
12409 id.clear();
12410 serviceConfigurationFileCheckSecs = 60;
12411 lingoConfigurationFileName.clear();
12412 lingoConfigurationFileCommand.clear();
12413 lingoConfigurationFileCheckSecs = 60;
12414 statusReport.clear();
12415 externalHealthCheckResponder.clear();
12416 internals.clear();
12417 certStoreFileName.clear();
12418 certStorePasswordHex.clear();
12419 enginePolicy.clear();
12420 configurationCheckSignalName = "rts.22f4ec3.${id}";
12421 fipsCrypto.clear();
12422 proxy.clear();
12423 nsm.clear();
12424 }
12425 };
12426
12427 static void to_json(nlohmann::json& j, const LingoServerConfiguration& p)
12428 {
12429 j = nlohmann::json{
12430 TOJSON_IMPL(id),
12431 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
12432 TOJSON_IMPL(lingoConfigurationFileName),
12433 TOJSON_IMPL(lingoConfigurationFileCommand),
12434 TOJSON_IMPL(lingoConfigurationFileCheckSecs),
12435 TOJSON_IMPL(statusReport),
12436 TOJSON_IMPL(externalHealthCheckResponder),
12437 TOJSON_IMPL(internals),
12438 TOJSON_IMPL(certStoreFileName),
12439 TOJSON_IMPL(certStorePasswordHex),
12440 TOJSON_IMPL(enginePolicy),
12441 TOJSON_IMPL(configurationCheckSignalName),
12442 TOJSON_IMPL(fipsCrypto),
12443 TOJSON_IMPL(proxy),
12444 TOJSON_IMPL(nsm)
12445 };
12446 }
12447 static void from_json(const nlohmann::json& j, LingoServerConfiguration& p)
12448 {
12449 p.clear();
12450 getOptional<std::string>("id", p.id, j);
12451 getOptional<int>("serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
12452 getOptional<std::string>("lingoConfigurationFileName", p.lingoConfigurationFileName, j);
12453 getOptional<std::string>("lingoConfigurationFileCommand", p.lingoConfigurationFileCommand, j);
12454 getOptional<int>("lingoConfigurationFileCheckSecs", p.lingoConfigurationFileCheckSecs, j, 60);
12455 getOptional<LingoServerStatusReportConfiguration>("statusReport", p.statusReport, j);
12456 getOptional<ExternalHealthCheckResponder>("externalHealthCheckResponder", p.externalHealthCheckResponder, j);
12457 getOptional<LingoServerInternals>("internals", p.internals, j);
12458 getOptional<std::string>("certStoreFileName", p.certStoreFileName, j);
12459 getOptional<std::string>("certStorePasswordHex", p.certStorePasswordHex, j);
12460 j.at("enginePolicy").get_to(p.enginePolicy);
12461 getOptional<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.22f4ec3.${id}");
12462 getOptional<FipsCryptoSettings>("fipsCrypo", p.fipsCrypto, j);
12463 getOptional<NetworkAddress>("proxy", p.proxy, j);
12464 nsmNodeFromEmbeddedServerJson(j, "nsm", p.nsm);
12465 }
12466
12467
12468 //-----------------------------------------------------------
12469 JSON_SERIALIZED_CLASS(VoiceToVoiceSession)
12480 {
12481 IMPLEMENT_JSON_SERIALIZATION()
12482 IMPLEMENT_JSON_DOCUMENTATION(VoiceToVoiceSession)
12483
12484 public:
12486 std::string id;
12487
12489 std::string name;
12490
12492 std::vector<std::string> groups;
12493
12496
12498 {
12499 clear();
12500 }
12501
12502 void clear()
12503 {
12504 id.clear();
12505 name.clear();
12506 groups.clear();
12507 enabled = true;
12508 }
12509 };
12510
12511 static void to_json(nlohmann::json& j, const VoiceToVoiceSession& p)
12512 {
12513 j = nlohmann::json{
12514 TOJSON_IMPL(id),
12515 TOJSON_IMPL(name),
12516 TOJSON_IMPL(groups),
12517 TOJSON_IMPL(enabled)
12518 };
12519 }
12520 static void from_json(const nlohmann::json& j, VoiceToVoiceSession& p)
12521 {
12522 p.clear();
12523 FROMJSON_IMPL(id, std::string, EMPTY_STRING);
12524 FROMJSON_IMPL(name, std::string, EMPTY_STRING);
12525 getOptional<std::vector<std::string>>("groups", p.groups, j);
12526 FROMJSON_IMPL(enabled, bool, true);
12527 }
12528
12529 //-----------------------------------------------------------
12530 JSON_SERIALIZED_CLASS(LingoConfiguration)
12541 {
12542 IMPLEMENT_JSON_SERIALIZATION()
12543 IMPLEMENT_JSON_DOCUMENTATION(LingoConfiguration)
12544
12545 public:
12547 std::vector<VoiceToVoiceSession> voiceToVoiceSessions;
12548
12550 std::vector<Group> groups;
12551
12553 {
12554 clear();
12555 }
12556
12557 void clear()
12558 {
12559 voiceToVoiceSessions.clear();
12560 groups.clear();
12561 }
12562 };
12563
12564 static void to_json(nlohmann::json& j, const LingoConfiguration& p)
12565 {
12566 j = nlohmann::json{
12567 TOJSON_IMPL(voiceToVoiceSessions),
12568 TOJSON_IMPL(groups)
12569 };
12570 }
12571 static void from_json(const nlohmann::json& j, LingoConfiguration& p)
12572 {
12573 p.clear();
12574 getOptional<std::vector<VoiceToVoiceSession>>("voiceToVoiceSessions", p.voiceToVoiceSessions, j);
12575 getOptional<std::vector<Group>>("groups", p.groups, j);
12576 }
12577
12578 //-----------------------------------------------------------
12579 JSON_SERIALIZED_CLASS(BridgingConfiguration)
12590 {
12591 IMPLEMENT_JSON_SERIALIZATION()
12592 IMPLEMENT_JSON_DOCUMENTATION(BridgingConfiguration)
12593
12594 public:
12596 std::vector<Bridge> bridges;
12597
12599 std::vector<Group> groups;
12600
12602 {
12603 clear();
12604 }
12605
12606 void clear()
12607 {
12608 bridges.clear();
12609 groups.clear();
12610 }
12611 };
12612
12613 static void to_json(nlohmann::json& j, const BridgingConfiguration& p)
12614 {
12615 j = nlohmann::json{
12616 TOJSON_IMPL(bridges),
12617 TOJSON_IMPL(groups)
12618 };
12619 }
12620 static void from_json(const nlohmann::json& j, BridgingConfiguration& p)
12621 {
12622 p.clear();
12623 getOptional<std::vector<Bridge>>("bridges", p.bridges, j);
12624 getOptional<std::vector<Group>>("groups", p.groups, j);
12625 }
12626
12627 //-----------------------------------------------------------
12628 JSON_SERIALIZED_CLASS(BridgingServerStatusReportConfiguration)
12639 {
12640 IMPLEMENT_JSON_SERIALIZATION()
12641 IMPLEMENT_JSON_DOCUMENTATION(BridgingServerStatusReportConfiguration)
12642
12643 public:
12645 std::string fileName;
12646
12649
12652
12654 std::string runCmd;
12655
12658
12661
12664
12666 {
12667 clear();
12668 }
12669
12670 void clear()
12671 {
12672 fileName.clear();
12673 intervalSecs = 60;
12674 enabled = false;
12675 includeGroupDetail = false;
12676 includeBridgeDetail = false;
12677 includeBridgeGroupDetail = false;
12678 runCmd.clear();
12679 }
12680 };
12681
12682 static void to_json(nlohmann::json& j, const BridgingServerStatusReportConfiguration& p)
12683 {
12684 j = nlohmann::json{
12685 TOJSON_IMPL(fileName),
12686 TOJSON_IMPL(intervalSecs),
12687 TOJSON_IMPL(enabled),
12688 TOJSON_IMPL(includeGroupDetail),
12689 TOJSON_IMPL(includeBridgeDetail),
12690 TOJSON_IMPL(includeBridgeGroupDetail),
12691 TOJSON_IMPL(runCmd)
12692 };
12693 }
12694 static void from_json(const nlohmann::json& j, BridgingServerStatusReportConfiguration& p)
12695 {
12696 p.clear();
12697 getOptional<std::string>("fileName", p.fileName, j);
12698 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
12699 getOptional<bool>("enabled", p.enabled, j, false);
12700 getOptional<std::string>("runCmd", p.runCmd, j);
12701 getOptional<bool>("includeGroupDetail", p.includeGroupDetail, j, false);
12702 getOptional<bool>("includeBridgeDetail", p.includeBridgeDetail, j, false);
12703 getOptional<bool>("includeBridgeGroupDetail", p.includeBridgeGroupDetail, j, false);
12704 }
12705
12706 //-----------------------------------------------------------
12707 JSON_SERIALIZED_CLASS(BridgingServerInternals)
12720 {
12721 IMPLEMENT_JSON_SERIALIZATION()
12722 IMPLEMENT_JSON_DOCUMENTATION(BridgingServerInternals)
12723
12724 public:
12727
12730
12733
12736
12739
12741 {
12742 clear();
12743 }
12744
12745 void clear()
12746 {
12747 watchdog.clear();
12748 tuning.clear();
12749 housekeeperIntervalMs = 1000;
12750 nsmUnhealthyBridgeGraceMs = 5000;
12751 nsmResourceReleaseCooldownMs = 30000;
12752 }
12753 };
12754
12755 static void to_json(nlohmann::json& j, const BridgingServerInternals& p)
12756 {
12757 j = nlohmann::json{
12758 TOJSON_IMPL(watchdog),
12759 TOJSON_IMPL(housekeeperIntervalMs),
12760 TOJSON_IMPL(nsmUnhealthyBridgeGraceMs),
12761 TOJSON_IMPL(nsmResourceReleaseCooldownMs),
12762 TOJSON_IMPL(tuning)
12763 };
12764 }
12765 static void from_json(const nlohmann::json& j, BridgingServerInternals& p)
12766 {
12767 p.clear();
12768 getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
12769 getOptional<int>("housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
12770 getOptional<int>("nsmUnhealthyBridgeGraceMs", p.nsmUnhealthyBridgeGraceMs, j, 5000);
12771 getOptional<int>("nsmResourceReleaseCooldownMs", p.nsmResourceReleaseCooldownMs, j, 30000);
12772 getOptional<TuningSettings>("tuning", p.tuning, j);
12773 }
12774
12775 //-----------------------------------------------------------
12776 JSON_SERIALIZED_CLASS(BridgingServerConfiguration)
12786 {
12787 IMPLEMENT_JSON_SERIALIZATION()
12788 IMPLEMENT_JSON_DOCUMENTATION(BridgingServerConfiguration)
12789
12790 public:
12797 typedef enum
12798 {
12800 omRaw = 0,
12801
12804 omMultistream = 1,
12805
12808 omMixedStream = 2,
12809
12811 omADictatedByGroup = 3,
12812 } OpMode_t;
12813
12815 std::string id;
12816
12819
12822
12825
12828
12831
12834
12837
12840
12843
12846
12849
12852
12855
12858
12861
12863 {
12864 clear();
12865 }
12866
12867 void clear()
12868 {
12869 id.clear();
12870 mode = omRaw;
12871 serviceConfigurationFileCheckSecs = 60;
12872 bridgingConfigurationFileName.clear();
12873 bridgingConfigurationFileCommand.clear();
12874 bridgingConfigurationFileCheckSecs = 60;
12875 statusReport.clear();
12876 externalHealthCheckResponder.clear();
12877 internals.clear();
12878 certStoreFileName.clear();
12879 certStorePasswordHex.clear();
12880 enginePolicy.clear();
12881 configurationCheckSignalName = "rts.6cc0651.${id}";
12882 fipsCrypto.clear();
12883 nsmNode.clear();
12884 rtiCloud.clear();
12885 }
12886 };
12887
12888 static void to_json(nlohmann::json& j, const BridgingServerConfiguration& p)
12889 {
12890 j = nlohmann::json{
12891 TOJSON_IMPL(id),
12892 TOJSON_IMPL(mode),
12893 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
12894 TOJSON_IMPL(bridgingConfigurationFileName),
12895 TOJSON_IMPL(bridgingConfigurationFileCommand),
12896 TOJSON_IMPL(bridgingConfigurationFileCheckSecs),
12897 TOJSON_IMPL(statusReport),
12898 TOJSON_IMPL(externalHealthCheckResponder),
12899 TOJSON_IMPL(internals),
12900 TOJSON_IMPL(certStoreFileName),
12901 TOJSON_IMPL(certStorePasswordHex),
12902 TOJSON_IMPL(enginePolicy),
12903 TOJSON_IMPL(configurationCheckSignalName),
12904 TOJSON_IMPL(fipsCrypto),
12905 TOJSON_IMPL(nsmNode),
12906 TOJSON_IMPL(rtiCloud)
12907 };
12908 }
12909 static void from_json(const nlohmann::json& j, BridgingServerConfiguration& p)
12910 {
12911 p.clear();
12912 getOptional<std::string>("id", p.id, j);
12913 getOptional<BridgingServerConfiguration::OpMode_t>("mode", p.mode, j, BridgingServerConfiguration::OpMode_t::omRaw);
12914 getOptional<int>("serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
12915 getOptional<std::string>("bridgingConfigurationFileName", p.bridgingConfigurationFileName, j);
12916 getOptional<std::string>("bridgingConfigurationFileCommand", p.bridgingConfigurationFileCommand, j);
12917 getOptional<int>("bridgingConfigurationFileCheckSecs", p.bridgingConfigurationFileCheckSecs, j, 60);
12918 getOptional<BridgingServerStatusReportConfiguration>("statusReport", p.statusReport, j);
12919 getOptional<ExternalHealthCheckResponder>("externalHealthCheckResponder", p.externalHealthCheckResponder, j);
12920 getOptional<BridgingServerInternals>("internals", p.internals, j);
12921 getOptional<std::string>("certStoreFileName", p.certStoreFileName, j);
12922 getOptional<std::string>("certStorePasswordHex", p.certStorePasswordHex, j);
12923 j.at("enginePolicy").get_to(p.enginePolicy);
12924 getOptional<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.6cc0651.${id}");
12925 getOptional<FipsCryptoSettings>("fipsCrypto", p.fipsCrypto, j);
12926 getOptional<NsmNode>("nsmNode", p.nsmNode, j);
12927 getOptional<RtiCloudSettings>("rtiCloud", p.rtiCloud, j);
12928 }
12929
12930
12931 //-----------------------------------------------------------
12932 JSON_SERIALIZED_CLASS(EarGroupsConfiguration)
12943 {
12944 IMPLEMENT_JSON_SERIALIZATION()
12945 IMPLEMENT_JSON_DOCUMENTATION(EarGroupsConfiguration)
12946
12947 public:
12949 std::vector<Group> groups;
12950
12952 {
12953 clear();
12954 }
12955
12956 void clear()
12957 {
12958 groups.clear();
12959 }
12960 };
12961
12962 static void to_json(nlohmann::json& j, const EarGroupsConfiguration& p)
12963 {
12964 j = nlohmann::json{
12965 TOJSON_IMPL(groups)
12966 };
12967 }
12968 static void from_json(const nlohmann::json& j, EarGroupsConfiguration& p)
12969 {
12970 p.clear();
12971 getOptional<std::vector<Group>>("groups", p.groups, j);
12972 }
12973
12974 //-----------------------------------------------------------
12975 JSON_SERIALIZED_CLASS(EarServerStatusReportConfiguration)
12986 {
12987 IMPLEMENT_JSON_SERIALIZATION()
12988 IMPLEMENT_JSON_DOCUMENTATION(EarServerStatusReportConfiguration)
12989
12990 public:
12992 std::string fileName;
12993
12996
12999
13001 std::string runCmd;
13002
13005
13007 {
13008 clear();
13009 }
13010
13011 void clear()
13012 {
13013 fileName.clear();
13014 intervalSecs = 60;
13015 enabled = false;
13016 includeGroupDetail = false;
13017 runCmd.clear();
13018 }
13019 };
13020
13021 static void to_json(nlohmann::json& j, const EarServerStatusReportConfiguration& p)
13022 {
13023 j = nlohmann::json{
13024 TOJSON_IMPL(fileName),
13025 TOJSON_IMPL(intervalSecs),
13026 TOJSON_IMPL(enabled),
13027 TOJSON_IMPL(includeGroupDetail),
13028 TOJSON_IMPL(runCmd)
13029 };
13030 }
13031 static void from_json(const nlohmann::json& j, EarServerStatusReportConfiguration& p)
13032 {
13033 p.clear();
13034 getOptional<std::string>("fileName", p.fileName, j);
13035 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
13036 getOptional<bool>("enabled", p.enabled, j, false);
13037 getOptional<std::string>("runCmd", p.runCmd, j);
13038 getOptional<bool>("includeGroupDetail", p.includeGroupDetail, j, false);
13039 }
13040
13041 //-----------------------------------------------------------
13042 JSON_SERIALIZED_CLASS(EarServerInternals)
13055 {
13056 IMPLEMENT_JSON_SERIALIZATION()
13057 IMPLEMENT_JSON_DOCUMENTATION(EarServerInternals)
13058
13059 public:
13062
13065
13068
13070 {
13071 clear();
13072 }
13073
13074 void clear()
13075 {
13076 watchdog.clear();
13077 tuning.clear();
13078 housekeeperIntervalMs = 1000;
13079 }
13080 };
13081
13082 static void to_json(nlohmann::json& j, const EarServerInternals& p)
13083 {
13084 j = nlohmann::json{
13085 TOJSON_IMPL(watchdog),
13086 TOJSON_IMPL(housekeeperIntervalMs),
13087 TOJSON_IMPL(tuning)
13088 };
13089 }
13090 static void from_json(const nlohmann::json& j, EarServerInternals& p)
13091 {
13092 p.clear();
13093 getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
13094 getOptional<int>("housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
13095 getOptional<TuningSettings>("tuning", p.tuning, j);
13096 }
13097
13098 //-----------------------------------------------------------
13099 JSON_SERIALIZED_CLASS(EarServerConfiguration)
13109 {
13110 IMPLEMENT_JSON_SERIALIZATION()
13111 IMPLEMENT_JSON_DOCUMENTATION(EarServerConfiguration)
13112
13113 public:
13114
13116 std::string id;
13117
13120
13123
13126
13129
13132
13135
13138
13141
13144
13147
13150
13153
13156
13158 {
13159 clear();
13160 }
13161
13162 void clear()
13163 {
13164 id.clear();
13165 serviceConfigurationFileCheckSecs = 60;
13166 groupsConfigurationFileName.clear();
13167 groupsConfigurationFileCommand.clear();
13168 groupsConfigurationFileCheckSecs = 60;
13169 statusReport.clear();
13170 externalHealthCheckResponder.clear();
13171 internals.clear();
13172 certStoreFileName.clear();
13173 certStorePasswordHex.clear();
13174 enginePolicy.clear();
13175 configurationCheckSignalName = "rts.9a164fa.${id}";
13176 fipsCrypto.clear();
13177 nsm.clear();
13178 }
13179 };
13180
13181 static void to_json(nlohmann::json& j, const EarServerConfiguration& p)
13182 {
13183 j = nlohmann::json{
13184 TOJSON_IMPL(id),
13185 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
13186 TOJSON_IMPL(groupsConfigurationFileName),
13187 TOJSON_IMPL(groupsConfigurationFileCommand),
13188 TOJSON_IMPL(groupsConfigurationFileCheckSecs),
13189 TOJSON_IMPL(statusReport),
13190 TOJSON_IMPL(externalHealthCheckResponder),
13191 TOJSON_IMPL(internals),
13192 TOJSON_IMPL(certStoreFileName),
13193 TOJSON_IMPL(certStorePasswordHex),
13194 TOJSON_IMPL(enginePolicy),
13195 TOJSON_IMPL(configurationCheckSignalName),
13196 TOJSON_IMPL(fipsCrypto),
13197 TOJSON_IMPL(nsm)
13198 };
13199 }
13200 static void from_json(const nlohmann::json& j, EarServerConfiguration& p)
13201 {
13202 p.clear();
13203 getOptional<std::string>("id", p.id, j);
13204 getOptional<int>("serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
13205 getOptional<std::string>("groupsConfigurationFileName", p.groupsConfigurationFileName, j);
13206 getOptional<std::string>("groupsConfigurationFileCommand", p.groupsConfigurationFileCommand, j);
13207 getOptional<int>("groupsConfigurationFileCheckSecs", p.groupsConfigurationFileCheckSecs, j, 60);
13208 getOptional<EarServerStatusReportConfiguration>("statusReport", p.statusReport, j);
13209 getOptional<ExternalHealthCheckResponder>("externalHealthCheckResponder", p.externalHealthCheckResponder, j);
13210 getOptional<EarServerInternals>("internals", p.internals, j);
13211 getOptional<std::string>("certStoreFileName", p.certStoreFileName, j);
13212 getOptional<std::string>("certStorePasswordHex", p.certStorePasswordHex, j);
13213 j.at("enginePolicy").get_to(p.enginePolicy);
13214 getOptional<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.9a164fa.${id}");
13215 getOptional<FipsCryptoSettings>("fipsCrypto", p.fipsCrypto, j);
13216 nsmNodeFromEmbeddedServerJson(j, "nsm", p.nsm);
13217 }
13218
13219//-----------------------------------------------------------
13220 JSON_SERIALIZED_CLASS(EngageSemGroupsConfiguration)
13231 {
13232 IMPLEMENT_JSON_SERIALIZATION()
13233 IMPLEMENT_JSON_DOCUMENTATION(EngageSemGroupsConfiguration)
13234
13235 public:
13237 std::vector<Group> groups;
13238
13240 {
13241 clear();
13242 }
13243
13244 void clear()
13245 {
13246 groups.clear();
13247 }
13248 };
13249
13250 static void to_json(nlohmann::json& j, const EngageSemGroupsConfiguration& p)
13251 {
13252 j = nlohmann::json{
13253 TOJSON_IMPL(groups)
13254 };
13255 }
13256 static void from_json(const nlohmann::json& j, EngageSemGroupsConfiguration& p)
13257 {
13258 p.clear();
13259 getOptional<std::vector<Group>>("groups", p.groups, j);
13260 }
13261
13262 //-----------------------------------------------------------
13263 JSON_SERIALIZED_CLASS(EngageSemServerStatusReportConfiguration)
13274 {
13275 IMPLEMENT_JSON_SERIALIZATION()
13276 IMPLEMENT_JSON_DOCUMENTATION(EngageSemServerStatusReportConfiguration)
13277
13278 public:
13280 std::string fileName;
13281
13284
13287
13289 std::string runCmd;
13290
13293
13295 {
13296 clear();
13297 }
13298
13299 void clear()
13300 {
13301 fileName.clear();
13302 intervalSecs = 60;
13303 enabled = false;
13304 includeGroupDetail = false;
13305 runCmd.clear();
13306 }
13307 };
13308
13309 static void to_json(nlohmann::json& j, const EngageSemServerStatusReportConfiguration& p)
13310 {
13311 j = nlohmann::json{
13312 TOJSON_IMPL(fileName),
13313 TOJSON_IMPL(intervalSecs),
13314 TOJSON_IMPL(enabled),
13315 TOJSON_IMPL(includeGroupDetail),
13316 TOJSON_IMPL(runCmd)
13317 };
13318 }
13319 static void from_json(const nlohmann::json& j, EngageSemServerStatusReportConfiguration& p)
13320 {
13321 p.clear();
13322 getOptional<std::string>("fileName", p.fileName, j);
13323 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
13324 getOptional<bool>("enabled", p.enabled, j, false);
13325 getOptional<std::string>("runCmd", p.runCmd, j);
13326 getOptional<bool>("includeGroupDetail", p.includeGroupDetail, j, false);
13327 }
13328
13329 //-----------------------------------------------------------
13330 JSON_SERIALIZED_CLASS(EngageSemServerInternals)
13343 {
13344 IMPLEMENT_JSON_SERIALIZATION()
13345 IMPLEMENT_JSON_DOCUMENTATION(EngageSemServerInternals)
13346
13347 public:
13350
13353
13356
13358 {
13359 clear();
13360 }
13361
13362 void clear()
13363 {
13364 watchdog.clear();
13365 tuning.clear();
13366 housekeeperIntervalMs = 1000;
13367 }
13368 };
13369
13370 static void to_json(nlohmann::json& j, const EngageSemServerInternals& p)
13371 {
13372 j = nlohmann::json{
13373 TOJSON_IMPL(watchdog),
13374 TOJSON_IMPL(housekeeperIntervalMs),
13375 TOJSON_IMPL(tuning)
13376 };
13377 }
13378 static void from_json(const nlohmann::json& j, EngageSemServerInternals& p)
13379 {
13380 p.clear();
13381 getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
13382 getOptional<int>("housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
13383 getOptional<TuningSettings>("tuning", p.tuning, j);
13384 }
13385
13386 //-----------------------------------------------------------
13387 JSON_SERIALIZED_CLASS(EngageSemServerConfiguration)
13397 {
13398 IMPLEMENT_JSON_SERIALIZATION()
13399 IMPLEMENT_JSON_DOCUMENTATION(EngageSemServerConfiguration)
13400
13401 public:
13402
13404 std::string id;
13405
13408
13411
13414
13417
13420
13423
13426
13429
13432
13435
13438
13441
13444
13445 int maxQueueLen;
13446 int minQueuingMs;
13447 int maxQueuingMs;
13448 int minPriority;
13449 int maxPriority;
13450
13452 {
13453 clear();
13454 }
13455
13456 void clear()
13457 {
13458 id.clear();
13459 serviceConfigurationFileCheckSecs = 60;
13460 groupsConfigurationFileName.clear();
13461 groupsConfigurationFileCommand.clear();
13462 groupsConfigurationFileCheckSecs = 60;
13463 statusReport.clear();
13464 externalHealthCheckResponder.clear();
13465 internals.clear();
13466 certStoreFileName.clear();
13467 certStorePasswordHex.clear();
13468 enginePolicy.clear();
13469 configurationCheckSignalName = "rts.9a164fa.${id}";
13470 fipsCrypto.clear();
13471 nsm.clear();
13472
13473 maxQueueLen = 64;
13474 minQueuingMs = 0;
13475 maxQueuingMs = 15000;
13476 minPriority = 0;
13477 maxPriority = 255;
13478 }
13479 };
13480
13481 static void to_json(nlohmann::json& j, const EngageSemServerConfiguration& p)
13482 {
13483 j = nlohmann::json{
13484 TOJSON_IMPL(id),
13485 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
13486 TOJSON_IMPL(groupsConfigurationFileName),
13487 TOJSON_IMPL(groupsConfigurationFileCommand),
13488 TOJSON_IMPL(groupsConfigurationFileCheckSecs),
13489 TOJSON_IMPL(statusReport),
13490 TOJSON_IMPL(externalHealthCheckResponder),
13491 TOJSON_IMPL(internals),
13492 TOJSON_IMPL(certStoreFileName),
13493 TOJSON_IMPL(certStorePasswordHex),
13494 TOJSON_IMPL(enginePolicy),
13495 TOJSON_IMPL(configurationCheckSignalName),
13496 TOJSON_IMPL(fipsCrypto),
13497 TOJSON_IMPL(nsm),
13498 TOJSON_IMPL(maxQueueLen),
13499 TOJSON_IMPL(minQueuingMs),
13500 TOJSON_IMPL(maxQueuingMs),
13501 TOJSON_IMPL(minPriority),
13502 TOJSON_IMPL(maxPriority)
13503 };
13504 }
13505 static void from_json(const nlohmann::json& j, EngageSemServerConfiguration& p)
13506 {
13507 p.clear();
13508 getOptional<std::string>("id", p.id, j);
13509 getOptional<int>("serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
13510 getOptional<std::string>("groupsConfigurationFileName", p.groupsConfigurationFileName, j);
13511 getOptional<std::string>("groupsConfigurationFileCommand", p.groupsConfigurationFileCommand, j);
13512 getOptional<int>("groupsConfigurationFileCheckSecs", p.groupsConfigurationFileCheckSecs, j, 60);
13513 getOptional<EngageSemServerStatusReportConfiguration>("statusReport", p.statusReport, j);
13514 getOptional<ExternalHealthCheckResponder>("externalHealthCheckResponder", p.externalHealthCheckResponder, j);
13515 getOptional<EngageSemServerInternals>("internals", p.internals, j);
13516 getOptional<std::string>("certStoreFileName", p.certStoreFileName, j);
13517 getOptional<std::string>("certStorePasswordHex", p.certStorePasswordHex, j);
13518 j.at("enginePolicy").get_to(p.enginePolicy);
13519 getOptional<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.9a164fa.${id}");
13520 getOptional<FipsCryptoSettings>("fipsCrypto", p.fipsCrypto, j);
13521 nsmNodeFromEmbeddedServerJson(j, "nsm", p.nsm);
13522 getOptional<int>("maxQueueLen", p.maxQueueLen, j, 64);
13523 getOptional<int>("minQueuingMs", p.minQueuingMs, j, 0);
13524 getOptional<int>("maxQueuingMs", p.maxQueuingMs, j, 15000);
13525 getOptional<int>("minPriority", p.minPriority, j, 0);
13526 getOptional<int>("maxPriority", p.maxPriority, j, 255);
13527 }
13528
13529 //-----------------------------------------------------------
13530 JSON_SERIALIZED_CLASS(EngateGroup)
13540 class EngateGroup : public Group
13541 {
13542 IMPLEMENT_JSON_SERIALIZATION()
13543 IMPLEMENT_JSON_DOCUMENTATION(EngateGroup)
13544
13545 public:
13546 bool useVad;
13547 uint32_t inputHangMs;
13548 uint32_t inputActivationPowerThreshold;
13549 uint32_t inputDeactivationPowerThreshold;
13550
13551 EngateGroup()
13552 {
13553 clear();
13554 }
13555
13556 void clear()
13557 {
13558 Group::clear();
13559 useVad = false;
13560 inputHangMs = 750;
13561 inputActivationPowerThreshold = 700;
13562 inputDeactivationPowerThreshold = 125;
13563 }
13564 };
13565
13566 static void to_json(nlohmann::json& j, const EngateGroup& p)
13567 {
13568 nlohmann::json g;
13569 to_json(g, static_cast<const Group&>(p));
13570
13571 j = nlohmann::json{
13572 TOJSON_IMPL(useVad),
13573 TOJSON_IMPL(inputHangMs),
13574 TOJSON_IMPL(inputActivationPowerThreshold),
13575 TOJSON_IMPL(inputDeactivationPowerThreshold)
13576 };
13577 }
13578 static void from_json(const nlohmann::json& j, EngateGroup& p)
13579 {
13580 p.clear();
13581 from_json(j, static_cast<Group&>(p));
13582 getOptional<uint32_t>("inputHangMs", p.inputHangMs, j, 750);
13583 getOptional<uint32_t>("inputActivationPowerThreshold", p.inputActivationPowerThreshold, j, 700);
13584 getOptional<uint32_t>("inputDeactivationPowerThreshold", p.inputDeactivationPowerThreshold, j, 125);
13585 }
13586
13587 //-----------------------------------------------------------
13588 JSON_SERIALIZED_CLASS(EngateGroupsConfiguration)
13599 {
13600 IMPLEMENT_JSON_SERIALIZATION()
13601 IMPLEMENT_JSON_DOCUMENTATION(EngateGroupsConfiguration)
13602
13603 public:
13605 std::vector<EngateGroup> groups;
13606
13608 {
13609 clear();
13610 }
13611
13612 void clear()
13613 {
13614 groups.clear();
13615 }
13616 };
13617
13618 static void to_json(nlohmann::json& j, const EngateGroupsConfiguration& p)
13619 {
13620 j = nlohmann::json{
13621 TOJSON_IMPL(groups)
13622 };
13623 }
13624 static void from_json(const nlohmann::json& j, EngateGroupsConfiguration& p)
13625 {
13626 p.clear();
13627 getOptional<std::vector<EngateGroup>>("groups", p.groups, j);
13628 }
13629
13630 //-----------------------------------------------------------
13631 JSON_SERIALIZED_CLASS(EngateServerStatusReportConfiguration)
13642 {
13643 IMPLEMENT_JSON_SERIALIZATION()
13644 IMPLEMENT_JSON_DOCUMENTATION(EngateServerStatusReportConfiguration)
13645
13646 public:
13648 std::string fileName;
13649
13652
13655
13657 std::string runCmd;
13658
13661
13663 {
13664 clear();
13665 }
13666
13667 void clear()
13668 {
13669 fileName.clear();
13670 intervalSecs = 60;
13671 enabled = false;
13672 includeGroupDetail = false;
13673 runCmd.clear();
13674 }
13675 };
13676
13677 static void to_json(nlohmann::json& j, const EngateServerStatusReportConfiguration& p)
13678 {
13679 j = nlohmann::json{
13680 TOJSON_IMPL(fileName),
13681 TOJSON_IMPL(intervalSecs),
13682 TOJSON_IMPL(enabled),
13683 TOJSON_IMPL(includeGroupDetail),
13684 TOJSON_IMPL(runCmd)
13685 };
13686 }
13687 static void from_json(const nlohmann::json& j, EngateServerStatusReportConfiguration& p)
13688 {
13689 p.clear();
13690 getOptional<std::string>("fileName", p.fileName, j);
13691 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
13692 getOptional<bool>("enabled", p.enabled, j, false);
13693 getOptional<std::string>("runCmd", p.runCmd, j);
13694 getOptional<bool>("includeGroupDetail", p.includeGroupDetail, j, false);
13695 }
13696
13697 //-----------------------------------------------------------
13698 JSON_SERIALIZED_CLASS(EngateServerInternals)
13711 {
13712 IMPLEMENT_JSON_SERIALIZATION()
13713 IMPLEMENT_JSON_DOCUMENTATION(EngateServerInternals)
13714
13715 public:
13718
13721
13724
13726 {
13727 clear();
13728 }
13729
13730 void clear()
13731 {
13732 watchdog.clear();
13733 tuning.clear();
13734 housekeeperIntervalMs = 1000;
13735 }
13736 };
13737
13738 static void to_json(nlohmann::json& j, const EngateServerInternals& p)
13739 {
13740 j = nlohmann::json{
13741 TOJSON_IMPL(watchdog),
13742 TOJSON_IMPL(housekeeperIntervalMs),
13743 TOJSON_IMPL(tuning)
13744 };
13745 }
13746 static void from_json(const nlohmann::json& j, EngateServerInternals& p)
13747 {
13748 p.clear();
13749 getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
13750 getOptional<int>("housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
13751 getOptional<TuningSettings>("tuning", p.tuning, j);
13752 }
13753
13754 //-----------------------------------------------------------
13755 JSON_SERIALIZED_CLASS(EngateServerConfiguration)
13765 {
13766 IMPLEMENT_JSON_SERIALIZATION()
13767 IMPLEMENT_JSON_DOCUMENTATION(EngateServerConfiguration)
13768
13769 public:
13770
13772 std::string id;
13773
13776
13779
13782
13785
13788
13791
13794
13797
13800
13803
13806
13809
13812
13814 {
13815 clear();
13816 }
13817
13818 void clear()
13819 {
13820 id.clear();
13821 serviceConfigurationFileCheckSecs = 60;
13822 groupsConfigurationFileName.clear();
13823 groupsConfigurationFileCommand.clear();
13824 groupsConfigurationFileCheckSecs = 60;
13825 statusReport.clear();
13826 externalHealthCheckResponder.clear();
13827 internals.clear();
13828 certStoreFileName.clear();
13829 certStorePasswordHex.clear();
13830 enginePolicy.clear();
13831 configurationCheckSignalName = "rts.9a164fa.${id}";
13832 fipsCrypto.clear();
13833 nsm.clear();
13834 }
13835 };
13836
13837 static void to_json(nlohmann::json& j, const EngateServerConfiguration& p)
13838 {
13839 j = nlohmann::json{
13840 TOJSON_IMPL(id),
13841 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
13842 TOJSON_IMPL(groupsConfigurationFileName),
13843 TOJSON_IMPL(groupsConfigurationFileCommand),
13844 TOJSON_IMPL(groupsConfigurationFileCheckSecs),
13845 TOJSON_IMPL(statusReport),
13846 TOJSON_IMPL(externalHealthCheckResponder),
13847 TOJSON_IMPL(internals),
13848 TOJSON_IMPL(certStoreFileName),
13849 TOJSON_IMPL(certStorePasswordHex),
13850 TOJSON_IMPL(enginePolicy),
13851 TOJSON_IMPL(configurationCheckSignalName),
13852 TOJSON_IMPL(fipsCrypto),
13853 TOJSON_IMPL(nsm)
13854 };
13855 }
13856 static void from_json(const nlohmann::json& j, EngateServerConfiguration& p)
13857 {
13858 p.clear();
13859 getOptional<std::string>("id", p.id, j);
13860 getOptional<int>("serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
13861 getOptional<std::string>("groupsConfigurationFileName", p.groupsConfigurationFileName, j);
13862 getOptional<std::string>("groupsConfigurationFileCommand", p.groupsConfigurationFileCommand, j);
13863 getOptional<int>("groupsConfigurationFileCheckSecs", p.groupsConfigurationFileCheckSecs, j, 60);
13864 getOptional<EngateServerStatusReportConfiguration>("statusReport", p.statusReport, j);
13865 getOptional<ExternalHealthCheckResponder>("externalHealthCheckResponder", p.externalHealthCheckResponder, j);
13866 getOptional<EngateServerInternals>("internals", p.internals, j);
13867 getOptional<std::string>("certStoreFileName", p.certStoreFileName, j);
13868 getOptional<std::string>("certStorePasswordHex", p.certStorePasswordHex, j);
13869 j.at("enginePolicy").get_to(p.enginePolicy);
13870 getOptional<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.9a164fa.${id}");
13871 getOptional<FipsCryptoSettings>("fipsCrypto", p.fipsCrypto, j);
13872 nsmNodeFromEmbeddedServerJson(j, "nsm", p.nsm);
13873 }
13874
13875 //-----------------------------------------------------------
13876 static inline void dumpExampleConfigurations(const char *path)
13877 {
13878 WatchdogSettings::document();
13879 FileRecordingRequest::document();
13880 Feature::document();
13881 Featureset::document();
13882 Agc::document();
13883 RtpPayloadTypeTranslation::document();
13884 NetworkInterfaceDevice::document();
13885 ListOfNetworkInterfaceDevice::document();
13886 RtpHeader::document();
13887 BlobInfo::document();
13888 TxAudioUri::document();
13889 AdvancedTxParams::document();
13890 Identity::document();
13891 Location::document();
13892 Power::document();
13893 Connectivity::document();
13894 PresenceDescriptorGroupItem::document();
13895 PresenceDescriptor::document();
13896 NetworkTxOptions::document();
13897 TcpNetworkTxOptions::document();
13898 NetworkAddress::document();
13899 NetworkAddressRxTx::document();
13900 NetworkAddressRestrictionList::document();
13901 StringRestrictionList::document();
13902 Rallypoint::document();
13903 RallypointCluster::document();
13904 NetworkDeviceDescriptor::document();
13905 TxAudio::document();
13906 AudioDeviceDescriptor::document();
13907 ListOfAudioDeviceDescriptor::document();
13908 Audio::document();
13909 TalkerInformation::document();
13910 GroupTalkers::document();
13911 Presence::document();
13912 Advertising::document();
13913 GroupPriorityTranslation::document();
13914 GroupTimeline::document();
13915 GroupAppTransport::document();
13916 RtpProfile::document();
13917 Group::document();
13918 Mission::document();
13919 LicenseDescriptor::document();
13920 EngineNetworkingRpUdpStreaming::document();
13921 EnginePolicyNetworking::document();
13922 Aec::document();
13923 Vad::document();
13924 Bridge::document();
13925 AndroidAudio::document();
13926 EnginePolicyAudio::document();
13927 SecurityCertificate::document();
13928 EnginePolicySecurity::document();
13929 EnginePolicyLogging::document();
13930 EnginePolicyDatabase::document();
13931 NamedAudioDevice::document();
13932 EnginePolicyNamedAudioDevices::document();
13933 Licensing::document();
13934 DiscoveryMagellan::document();
13935 DiscoverySsdp::document();
13936 DiscoverySap::document();
13937 DiscoveryCistech::document();
13938 DiscoveryTrellisware::document();
13939 DiscoveryConfiguration::document();
13940 EnginePolicyInternals::document();
13941 EnginePolicyTimelines::document();
13942 RtpMapEntry::document();
13943 ExternalModule::document();
13944 ExternalCodecDescriptor::document();
13945 EnginePolicy::document();
13946 TalkgroupAsset::document();
13947 EngageDiscoveredGroup::document();
13948 RallypointPeer::document();
13949 RallypointServerLimits::document();
13950 RallypointServerStatusReportConfiguration::document();
13951 RallypointServerLinkGraph::document();
13952 ExternalHealthCheckResponder::document();
13953 Tls::document();
13954 PeeringConfiguration::document();
13955 IgmpSnooping::document();
13956 RallypointReflector::document();
13957 RallypointUdpStreaming::document();
13958 RallypointServer::document();
13959 PlatformDiscoveredService::document();
13960 TimelineQueryParameters::document();
13961 CertStoreCertificate::document();
13962 CertStore::document();
13963 CertStoreCertificateElement::document();
13964 CertStoreDescriptor::document();
13965 CertificateDescriptor::document();
13966 BridgeCreationDetail::document();
13967 GroupConnectionDetail::document();
13968 GroupTxDetail::document();
13969 GroupCreationDetail::document();
13970 GroupReconfigurationDetail::document();
13971 GroupHealthReport::document();
13972 InboundProcessorStats::document();
13973 TrafficCounter::document();
13974 GroupStats::document();
13975 RallypointConnectionDetail::document();
13976 BridgingConfiguration::document();
13977 BridgingServerStatusReportConfiguration::document();
13978 BridgingServerInternals::document();
13979 RtiCloudSettings::document();
13980 BridgingServerConfiguration::document();
13981 EarGroupsConfiguration::document();
13982 EarServerStatusReportConfiguration::document();
13983 EarServerInternals::document();
13984 EarServerConfiguration::document();
13985 RangerPackets::document();
13986 TransportImpairment::document();
13987
13988 EngageSemGroupsConfiguration::document();
13989 EngageSemServerStatusReportConfiguration::document();
13990 EngageSemServerInternals::document();
13991 EngageSemServerConfiguration::document();
13992 }
13993}
13994
13995#ifndef WIN32
13996 #pragma GCC diagnostic pop
13997#endif
13998
13999#endif /* ConfigurationObjects_h */
static void nsmNodeFromEmbeddedServerJson(const nlohmann::json &j, const char *key, NsmNode &node)
TxPriority_t
Network Transmission Priority.
AddressResolutionPolicy_t
Address family resolution policy.
#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
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 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.
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 manufacturer
[Optional] Manufacturer
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
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 status
The creation status.
bool active
[Optional, Default: true] Runtime activity flag resolved by EBS.
std::vector< std::string > groups
List of group IDs to be included in the session.
bool enabled
[Optional, Default: true] Enable the bridge NOTE: this is only used bt EBS and is ignored when callin...
std::vector< Group > groups
Array of bridges in the configuration.
std::vector< Bridge > bridges
Array of bridges in the configuration.
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.
RtiCloudSettings rtiCloud
[Optional] Rally Tactical cloud (RTI) integration.
OpMode_t mode
Specifies the default operation mode (see OpMode_t).
EnginePolicy enginePolicy
The policy to be used for the underlying Engage Engine.
BridgingServerStatusReportConfiguration statusReport
Details for producing a status report.
std::string bridgingConfigurationFileCommand
Command-line to execute that returns a bridging configuration.
std::string bridgingConfigurationFileName
Name of a file containing the bridging configuration.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
NsmNode nsmNode
[Optional] Settings for embedded NSM node behavior.
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.
int nsmResourceReleaseCooldownMs
[Optional, Default: 30000] Time to keep an unhealthy NSM resource out of election before rejoining.
int housekeeperIntervalMs
[Optional, Default: 1000] Interval at which to run the housekeeper thread.
int nsmUnhealthyBridgeGraceMs
[Optional, Default: 5000] Time to wait before declaring an owned bridge unhealthy.
TuningSettings tuning
[Optional] Low-level tuning
WatchdogSettings watchdog
[Optional] Settings for the watchdog.
TODO: Configuration for the bridging server status report file.
Description of a certstore certificate element.
bool hasPrivateKey
True if the certificate has a private key associated with it.
Holds a certificate and (optionally) a private key in a certstore.
std::string certificatePem
Certificate in PEM format.
std::string privateKeyPem
Private key in PEM format.
std::vector< CertStoreCertificateElement > certificates
Array of certificate elements.
std::string fileName
Name of the file the certstore resides in.
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.
std::vector< CertificateSubjectElement > subjectElements
Array of subject elements.
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 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.
Configuration for the Discovery features.
DiscoveryMagellan Discovery settings.
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.
std::vector< Group > groups
Array of groups in the configuration.
std::string id
A unqiue identifier for the EAR server.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the server's interaction with an external health-checker such as a load-balancer.
NsmNode nsm
[Optional] Embedded NSM node settings (JSON key nsm; legacy flat NsmConfiguration accepted).
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
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.
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.
std::vector< Group > groups
Array of groups in the configuration.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
EnginePolicy enginePolicy
The policy to be used for the underlying Engage Engine.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
EngageSemServerStatusReportConfiguration statusReport
Details for producing a status report.
std::string id
A unqiue identifier for the EFC server.
std::string certStoreFileName
Path to the certificate store.
std::string groupsConfigurationFileName
Name of a file containing the EFC configuration.
int serviceConfigurationFileCheckSecs
Number of seconds between checks to see if the service configuration has been updated....
std::string groupsConfigurationFileCommand
Command-line to execute that returns a configuration.
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the server's interaction with an external health-checker such as a load-balancer.
NsmNode nsm
[Optional] Embedded NSM node settings (JSON key nsm; legacy flat NsmConfiguration accepted).
EngageSemServerInternals internals
Internal settings.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
int groupsConfigurationFileCheckSecs
Number of seconds between checks to see if the configuration has been updated. Default is 60.
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.
EngateServerStatusReportConfiguration statusReport
Details for producing a status report.
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the server's interaction with an external health-checker such as a load-balancer.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
std::string groupsConfigurationFileName
Name of a file containing the ear configuration.
NsmNode nsm
[Optional] Embedded NSM node settings (JSON key nsm; legacy flat NsmConfiguration accepted).
EngateServerInternals internals
Internal settings.
int groupsConfigurationFileCheckSecs
Number of seconds between checks to see if the configuration has been updated. Default is 60.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
std::string certStoreFileName
Path to the certificate store.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
EnginePolicy enginePolicy
The policy to be used for the underlying Engage Engine.
int serviceConfigurationFileCheckSecs
Number of seconds between checks to see if the service configuration has been updated....
std::string id
A unqiue identifier for the EAR server.
std::string groupsConfigurationFileCommand
Command-line to execute that returns a configuration.
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.
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.
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.
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 requireMulticast
[Optional, Default true] Require multicast support
bool preventMulticastFailover
[Optional, Default: false] Overrides/cancels group-level multicast failover if set to true
Default certificate to use for security operation in the Engage Engine.
SecurityCertificate certificate
The default certificate and private key for the Engine instance.
std::vector< std::string > caCertificates
[Optional] An array of CA certificates to be used for validation of far-end X.509 certificates
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.
TODO: Configuration to enable external systems to use to check if the service is still running.
Base for a description of an external module.
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.
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.
CreationStatus_t status
The 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.
Detailed information for a group reconfiguration.
ReconfigurationStatus_t status
The creation status.
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.
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)
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.
time_t expires
[Read only] The time that the license key or activation code expires in Unix timestamp - Zulu/UTC.
std::string activationCode
If the key required activation, this is the activation code generated using the entitlement,...
std::string expiresFormatted
[Read only] The time that the license key or activation code expires formatted in ISO 8601 format,...
std::string deviceId
Device Identifier. See LicenseDescriptor::deviceId for details.
std::string manufacturerId
Manufacturer ID to use for the product. See LicenseDescriptor::manufacturerId for details.
std::string activationCode
Activation Code issued for the license key. See LicenseDescriptor::activationCode for details.
std::string key
License key. See LicenseDescriptor::key for details.
std::string entitlement
Entitlement key to use for the product. See LicenseDescriptor::entitlement for details.
std::vector< Group > groups
Array of groups in the configuration.
std::vector< VoiceToVoiceSession > voiceToVoiceSessions
Array of voiceToVoice sessions in the configuration.
Configuration for the linguistics server.
LingoServerStatusReportConfiguration statusReport
Details for producing a status report.
std::string lingoConfigurationFileName
Name of a file containing the linguistics configuration.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
std::string id
A unqiue identifier for the linguistics server.
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the server's interaction with an external health-checker such as a load-balancer.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
std::string lingoConfigurationFileCommand
Command-line to execute that returns a linguistics configuration.
LingoServerInternals internals
Internal settings.
EnginePolicy enginePolicy
The policy to be used for the underlying Engage Engine.
NsmNode nsm
[Optional] Embedded NSM node settings (JSON key nsm; legacy flat NsmConfiguration accepted).
int lingoConfigurationFileCheckSecs
Number of seconds between checks to see if the linguistics configuration has been updated....
std::string certStoreFileName
Path to the certificate store.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
NetworkAddress proxy
Address and port of the proxy.
int serviceConfigurationFileCheckSecs
Number of seconds between checks to see if the service configuration has been updated....
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.
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.
RestrictionType_t type
Type indicating how the elements are to be treated.
std::vector< NetworkAddressRxTx > elements
List of elements.
std::string manufacturer
Device manufacturer (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 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.
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).
Periodic external command to refresh CoT point location.
std::string runCmd
Shell command returning JSON: {"lat":"…","lon":"…"[, "ce","hae","le"]}.
int intervalSecs
[Optional, Default: 10] Seconds between polls.
bool failClosed
[Optional, Default: true] When true, poll failure retains the last fix.
bool enabled
[Optional, Default: false] When true, runCmd is polled for location.
Cursor-on-Target envelope for NSM wire payloads (optional).
std::string callsign
Optional CoT contact callsign (emitted as detail/contact/@callsign ).
int idleIntervalSecs
CoT presence interval for fully idle nodes when announceWhenIdle is true (default 30).
NsmNodeCotLocationPollSettings locationPoll
Optional periodic command to refresh CoT point location.
std::string detailJson
Optional JSON object serialized as string for extra CoT detail elements.
bool announceWhenIdle
When useCot is true, fully idle nodes TX full resource state at idleIntervalSecs (default false).
Optional external gate for NSM election wire participation.
std::string runCmd
Shell command; trimmed stdout must be 1 (participate) or 0 (idle).
int intervalSecs
[Optional, Default: 2] Seconds between runCmd polls.
bool failClosed
[Optional, Default: true] When true, runCmd failure/timeout is treated as 0.
bool enabled
[Optional, Default: false] When true, election participation follows runCmd.
Configuration for a Nsm node.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
NsmNodeStatusReportConfiguration statusReport
Details for producing a status report.
std::string domainName
Logical domain label for status and monitoring.
NsmNodeElectionGateSettings electionGate
Optional external gate for election wire participation (Seeker active/standby, etc....
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.
Description of a packet capturer.
int version
TODO: A version number for the domain configuration. Change this whenever you update your configurati...
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.
uint32_t configurationVersion
Internal configuration version.
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 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.
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 rolloverSecs
Seconds between switching to a new target.
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.
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)
SecurityCertificate certificate
Internal certificate detail.
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 behavior
Specifies the streaming mode type (see BehaviorType_t).
Configuration for the Rallypoint server.
uint32_t maxSecurityLevel
[Optional, Default 0] Sets the maximum item security level that can be registered with the RP
bool forwardDiscoveredGroups
Enables automatic forwarding of discovered multicast traffic to peer Rallypoints.
std::string interfaceName
Name of the NIC to bind to for listening for incoming TCP connections.
NetworkTxOptions multicastTxOptions
Tx options for multicast.
bool disableMessageSigning
Set to true to forgo DSA signing of messages. Doing so is is a security risk but can be useful on CPU...
SecurityCertificate certificate
X.509 certificate and private key that identifies the Rallypoint.
std::string multicastInterfaceName
The name of the NIC on which to send and receive multicast traffic.
StringRestrictionList groupRestrictions
Group IDs to be restricted (inclusive or exclusive)
std::string peeringConfigurationFileName
Name of a file containing a JSON array of Rallypoint peers to connect to.
NsmNode nsm
[Optional] Embedded NSM node settings (JSON key nsm; legacy flat NsmConfiguration accepted).
uint32_t sysFlags
[Optional, Default 0] Internal system flags
int listenPort
TCP port to listen on. Default is 7443.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
NetworkAddressRestrictionList multicastRestrictions
Multicasts to be restricted (inclusive or exclusive)
uint32_t normalTaskQueueBias
[Optional, Default 0] Sets the queue's normal task bias
std::string name
A human-readable name for the Rallypoint.
PacketCapturer txCapture
Details for capture of transmitted packets
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.
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.
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the Rallypoint's interaction with an external health-checker such as a load-balanc...
std::vector< RallypointExtendedGroupRestriction > extendedGroupRestrictions
Extended group restrictions.
int ioPools
Number of threading pools to create for network I/O. Default is -1 which creates 1 I/O pool per CPU c...
RallypointServerStatusReportConfiguration statusReport
Details for producing a status report.
std::vector< NamedIdentity > additionalIdentities
[Optional] List of additional named identities
IgmpSnooping igmpSnooping
IGMP snooping configuration.
RallypointServerLinkGraph linkGraph
Details for producing a Graphviz-compatible link graph.
RallypointServerLimits limits
Details for capacity limits and determining processing load.
PeeringConfiguration peeringConfiguration
Internal - not serialized.
std::string domainName
[Optional] This Rallypoint's domain name
bool allowMulticastForwarding
Allows traffic received on unicast links to be forwarded to the multicast network.
RallypointWebsocketSettings websocket
[Optional] Settings for websocket operation
std::string peeringConfigurationFileCommand
Command-line to execute that returns a JSON array of Rallypoint peers to connect to.
RallypointServerRouteMap routeMap
Details for producing a report containing the route map.
StreamIdPrivacyType_t streamIdPrivacyType
[Optional, default sptDefault] Modes for stream ID transformation.
bool allowPeerForwarding
Set to true to allow forwarding of packets received from other Rallypoints to all other Rallypoints....
TcpNetworkTxOptions tcpTxOptions
Tx options for TCP.
RallypointUdpStreaming udpStreaming
Optional configuration for high-performance UDP streaming.
bool forwardMulticastAddressing
Enables forwarding of multicast addressing to peer Rallypoints.
std::vector< RallypointRpRtTimingBehavior > peerRtBehaviors
[Optional] Array of behaviors for roundtrip times to peers
std::string id
A unqiue identifier for the Rallypoint.
bool disableLoopDetection
If true, turns off loop detection.
std::vector< std::string > blockedDomains
[Optional] List of domains that explictly MAY NOT connect to this RP
std::vector< std::string > allowedDomains
[Optional] List of domains that explicitly MAY connect to this RP
std::string certStoreFileName
Path to the certificate store.
int peeringConfigurationFileCheckSecs
Number of seconds between checks to see if the peering configuration has been updated....
Tls tls
Details concerning Transport Layer Security.
RtiCloudSettings rtiCloud
[Optional] Rally Tactical cloud (RTI) integration.
TODO: Configuration for Rallypoint limits.
uint32_t maxQOpsPerSec
Maximum number of queue operations per second (0 = unlimited)
uint32_t maxInboundBacklog
Maximum number of inbound backlog requests the Rallypoint will accept.
uint32_t normalPriorityQueueThreshold
Number of normal priority queue operations after which new connections will not be accepted.
uint32_t maxPeers
Maximum number of peers (0 = unlimited)
uint32_t maxTxBytesPerSec
Maximum number of bytes transmitted per second (0 = unlimited)
uint32_t maxTxPacketsPerSec
Maximum number of packets transmitted per second (0 = unlimited)
uint32_t maxRegisteredStreams
Maximum number of registered streams (0 = unlimited)
uint32_t maxClients
Maximum number of clients (0 = unlimited)
uint32_t maxMulticastReflectors
Maximum number of multicastReflectors (0 = unlimited)
uint32_t maxStreamPaths
Maximum number of bidirectional stream paths (0 = unlimited)
uint32_t lowPriorityQueueThreshold
Number of low priority queue operations after which new connections will not be accepted.
uint32_t maxRxBytesPerSec
Maximum number of bytes received per second (0 = unlimited)
uint32_t denyNewConnectionCpuThreshold
The CPU utilization threshold percentage (0-100) beyond which new connections are denied.
uint32_t maxRxPacketsPerSec
Maximum number of packets received per second (0 = unlimited)
uint32_t warnAtCpuThreshold
The CPU utilization threshold percentage (0-100) beyond which warnings are logged.
TODO: Configuration for the Rallypoint status report file.
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...
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
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.
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
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...
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.
std::string signature
[Optional] ECDSA signature
std::string certPem
[Optional] X.509 certificate in PEM format used to sign the RIFF file.
std::string file
Name of the RIFF file.
Optional Rally Tactical cloud (RTI) integration (Rallypoint, Engage Bridge Service,...
std::string serviceBaseUrlPrefix
[Optional, Default: "prod.com"] Prefix used to construct default RTI SaaS base URL as "<prefix>....
std::string enrollmentCode
Enrollment code for the RTI cloud service.
bool enabled
Master switch: when true, the product uses RTI cloud HTTP APIs (token + heartbeat).
RTP header information as per RFC 3550.
uint32_t ssrc
Psuedo-random synchronization source.
uint16_t seq
Packet sequence number.
bool marker
Indicates whether this is the start of the media stream burst.
int pt
A valid RTP payload between 0 and 127 See IANA Real-Time Transport Protocol (RTP) Parameters
uint32_t ts
Media sample timestamp.
An RTP map entry.
std::string name
Name of the CODEC.
int engageType
An integer representing the codec type.
int rtpPayloadType
The RTP payload type identifier.
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.
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.
Contains talker information used in providing a list in GroupTalkers.
uint32_t txId
Transmission ID associated with a talker's transmission.
uint32_t ssrc
The RTS SSRC associated with a talker's transmission.
int duplicateCount
Number of duplicates detected.
int txPriority
Priority associated with a talker's transmission.
std::string alias
The user alias to represent as a "talker".
std::string nodeId
The nodeId the talker is originating from.
ManufacturedAliasType_t manufacturedAliasType
The method used to "manufacture" the alias.
ManufacturedAliasType_t
Manufactured alias type If an alias is "manufactured" then the alias is not a real user but is instea...
bool rxMuted
Indicates if RX is muted for this talker.
uint16_t rxFlags
Flags associated with a talker's transmission.
uint16_t aliasSpecializer
The numeric specializer (if any) associated with the alias.
std::string nodeId
A unique identifier for the asset.
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.
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
std::vector< TranslationSession > sessions
Array of sessions in the configuration.
std::vector< Group > groups
Array of groups in the configuration.
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.
Optional audio streaming from a URI for engageBeginGroupTxAdvanced.
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
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.
uint8_t t
DataSeries Type. Currently supported types.
uint8_t it
Increment type. Valid Types:
uint32_t ts
Timestamp representing the number of seconds elapsed since January 1, 1970 - based on traditional Uni...
uint8_t im
Increment multiplier. The increment multiplier is an additional field that allows you apply a multipl...