Engage Engine API  1.260.9100
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
6072 {
6073 clear();
6074 }
6075
6076 void clear()
6077 {
6078 defaultNic.clear();
6079 multicastRejoinSecs = 8;
6080 rallypointRtTestIntervalMs = 60000;
6081 logRtpJitterBufferStats = false;
6082 preventMulticastFailover = false;
6083 addressResolutionPolicy = AddressResolutionPolicy_t::arpIpv6ThenIpv4;
6084
6085 rpUdpStreaming.clear();
6086 rtpProfile.clear();
6087 }
6088 };
6089
6090 static void to_json(nlohmann::json& j, const EnginePolicyNetworking& p)
6091 {
6092 j = nlohmann::json{
6093 TOJSON_IMPL(defaultNic),
6094 TOJSON_IMPL(multicastRejoinSecs),
6095
6096 TOJSON_IMPL(rallypointRtTestIntervalMs),
6097 TOJSON_IMPL(logRtpJitterBufferStats),
6098 TOJSON_IMPL(preventMulticastFailover),
6099
6100 TOJSON_IMPL(rpUdpStreaming),
6101 TOJSON_IMPL(rtpProfile),
6102 TOJSON_IMPL(addressResolutionPolicy)
6103 };
6104 }
6105 static void from_json(const nlohmann::json& j, EnginePolicyNetworking& p)
6106 {
6107 p.clear();
6108 FROMJSON_IMPL(defaultNic, std::string, EMPTY_STRING);
6109 FROMJSON_IMPL(multicastRejoinSecs, int, 8);
6110 FROMJSON_IMPL(rallypointRtTestIntervalMs, int, 60000);
6111 FROMJSON_IMPL(logRtpJitterBufferStats, bool, false);
6112 FROMJSON_IMPL(preventMulticastFailover, bool, false);
6113
6114 getOptional<EngineNetworkingRpUdpStreaming>("rpUdpStreaming", p.rpUdpStreaming, j);
6115 getOptional<RtpProfile>("rtpProfile", p.rtpProfile, j);
6116 getOptional<AddressResolutionPolicy_t>("addressResolutionPolicy", p.addressResolutionPolicy, j, AddressResolutionPolicy_t::arpIpv6ThenIpv4);
6117 }
6118
6119 //-----------------------------------------------------------
6120 JSON_SERIALIZED_CLASS(Aec)
6131 {
6132 IMPLEMENT_JSON_SERIALIZATION()
6133 IMPLEMENT_JSON_DOCUMENTATION(Aec)
6134
6135 public:
6141 typedef enum
6142 {
6144 aecmDefault = 0,
6145
6147 aecmLow = 1,
6148
6150 aecmMedium = 2,
6151
6153 aecmHigh = 3,
6154
6156 aecmVeryHigh = 4,
6157
6159 aecmHighest = 5
6160 } Mode_t;
6161
6164
6167
6170
6172 bool cng;
6173
6174 Aec()
6175 {
6176 clear();
6177 }
6178
6179 void clear()
6180 {
6181 enabled = false;
6182 mode = aecmDefault;
6183 speakerTailMs = 60;
6184 cng = true;
6185 }
6186 };
6187
6188 static void to_json(nlohmann::json& j, const Aec& p)
6189 {
6190 j = nlohmann::json{
6191 TOJSON_IMPL(enabled),
6192 TOJSON_IMPL(mode),
6193 TOJSON_IMPL(speakerTailMs),
6194 TOJSON_IMPL(cng)
6195 };
6196 }
6197 static void from_json(const nlohmann::json& j, Aec& p)
6198 {
6199 p.clear();
6200 FROMJSON_IMPL(enabled, bool, false);
6201 FROMJSON_IMPL(mode, Aec::Mode_t, Aec::Mode_t::aecmDefault);
6202 FROMJSON_IMPL(speakerTailMs, int, 60);
6203 FROMJSON_IMPL(cng, bool, true);
6204 }
6205
6206 //-----------------------------------------------------------
6207 JSON_SERIALIZED_CLASS(Vad)
6218 {
6219 IMPLEMENT_JSON_SERIALIZATION()
6220 IMPLEMENT_JSON_DOCUMENTATION(Vad)
6221
6222 public:
6228 typedef enum
6229 {
6231 vamDefault = 0,
6232
6234 vamLowBitRate = 1,
6235
6237 vamAggressive = 2,
6238
6240 vamVeryAggressive = 3
6241 } Mode_t;
6242
6245
6248
6249 Vad()
6250 {
6251 clear();
6252 }
6253
6254 void clear()
6255 {
6256 enabled = false;
6257 mode = vamDefault;
6258 }
6259 };
6260
6261 static void to_json(nlohmann::json& j, const Vad& p)
6262 {
6263 j = nlohmann::json{
6264 TOJSON_IMPL(enabled),
6265 TOJSON_IMPL(mode)
6266 };
6267 }
6268 static void from_json(const nlohmann::json& j, Vad& p)
6269 {
6270 p.clear();
6271 FROMJSON_IMPL(enabled, bool, false);
6272 FROMJSON_IMPL(mode, Vad::Mode_t, Vad::Mode_t::vamDefault);
6273 }
6274
6275 //-----------------------------------------------------------
6276 JSON_SERIALIZED_CLASS(Bridge)
6287 {
6288 IMPLEMENT_JSON_SERIALIZATION()
6289 IMPLEMENT_JSON_DOCUMENTATION(Bridge)
6290
6291 public:
6293 std::string id;
6294
6296 std::string name;
6297
6299 std::vector<std::string> groups;
6300
6305
6308
6309
6310 Bridge()
6311 {
6312 clear();
6313 }
6314
6315 void clear()
6316 {
6317 id.clear();
6318 name.clear();
6319 groups.clear();
6320 enabled = true;
6321 active = true;
6322 }
6323 };
6324
6325 static void to_json(nlohmann::json& j, const Bridge& p)
6326 {
6327 j = nlohmann::json{
6328 TOJSON_IMPL(id),
6329 TOJSON_IMPL(name),
6330 TOJSON_IMPL(groups),
6331 TOJSON_IMPL(enabled),
6332 TOJSON_IMPL(active)
6333 };
6334 }
6335 static void from_json(const nlohmann::json& j, Bridge& p)
6336 {
6337 p.clear();
6338 FROMJSON_IMPL(id, std::string, EMPTY_STRING);
6339 FROMJSON_IMPL(name, std::string, EMPTY_STRING);
6340 getOptional<std::vector<std::string>>("groups", p.groups, j);
6341 FROMJSON_IMPL(enabled, bool, true);
6342 FROMJSON_IMPL(active, bool, true);
6343 }
6344
6345 //-----------------------------------------------------------
6346 JSON_SERIALIZED_CLASS(AndroidAudio)
6357 {
6358 IMPLEMENT_JSON_SERIALIZATION()
6359 IMPLEMENT_JSON_DOCUMENTATION(AndroidAudio)
6360
6361 public:
6362 constexpr static int INVALID_SESSION_ID = -9999;
6363
6365 int api;
6366
6369
6372
6388
6396
6406
6409
6412
6413
6414 AndroidAudio()
6415 {
6416 clear();
6417 }
6418
6419 void clear()
6420 {
6421 api = 0;
6422 sharingMode = 0;
6423 performanceMode = 12;
6424 usage = 2;
6425 contentType = 1;
6426 inputPreset = 7;
6427 sessionId = AndroidAudio::INVALID_SESSION_ID;
6428 engineMode = 0;
6429 }
6430 };
6431
6432 static void to_json(nlohmann::json& j, const AndroidAudio& p)
6433 {
6434 j = nlohmann::json{
6435 TOJSON_IMPL(api),
6436 TOJSON_IMPL(sharingMode),
6437 TOJSON_IMPL(performanceMode),
6438 TOJSON_IMPL(usage),
6439 TOJSON_IMPL(contentType),
6440 TOJSON_IMPL(inputPreset),
6441 TOJSON_IMPL(sessionId),
6442 TOJSON_IMPL(engineMode)
6443 };
6444 }
6445 static void from_json(const nlohmann::json& j, AndroidAudio& p)
6446 {
6447 p.clear();
6448 FROMJSON_IMPL(api, int, 0);
6449 FROMJSON_IMPL(sharingMode, int, 0);
6450 FROMJSON_IMPL(performanceMode, int, 12);
6451 FROMJSON_IMPL(usage, int, 2);
6452 FROMJSON_IMPL(contentType, int, 1);
6453 FROMJSON_IMPL(inputPreset, int, 7);
6454 FROMJSON_IMPL(sessionId, int, AndroidAudio::INVALID_SESSION_ID);
6455 FROMJSON_IMPL(engineMode, int, 0);
6456 }
6457
6458 //-----------------------------------------------------------
6459 JSON_SERIALIZED_CLASS(EnginePolicyAudio)
6470 {
6471 IMPLEMENT_JSON_SERIALIZATION()
6472 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicyAudio)
6473
6474 public:
6477
6480
6483
6486
6489
6492
6495
6498
6501
6504
6507
6510
6513
6516
6519
6520
6522 {
6523 clear();
6524 }
6525
6526 void clear()
6527 {
6528 enabled = true;
6529 hardwareEnabled = true;
6530 internalRate = 16000;
6531 internalChannels = 2;
6532 muteTxOnTx = false;
6533 aec.clear();
6534 vad.clear();
6535 android.clear();
6536 inputAgc.clear();
6537 outputAgc.clear();
6538 denoiseInput = false;
6539 denoiseOutput = false;
6540 saveInputPcm = false;
6541 saveOutputPcm = false;
6542 registry.clear();
6543 }
6544 };
6545
6546 static void to_json(nlohmann::json& j, const EnginePolicyAudio& p)
6547 {
6548 j = nlohmann::json{
6549 TOJSON_IMPL(enabled),
6550 TOJSON_IMPL(hardwareEnabled),
6551 TOJSON_IMPL(internalRate),
6552 TOJSON_IMPL(internalChannels),
6553 TOJSON_IMPL(muteTxOnTx),
6554 TOJSON_IMPL(aec),
6555 TOJSON_IMPL(vad),
6556 TOJSON_IMPL(android),
6557 TOJSON_IMPL(inputAgc),
6558 TOJSON_IMPL(outputAgc),
6559 TOJSON_IMPL(denoiseInput),
6560 TOJSON_IMPL(denoiseOutput),
6561 TOJSON_IMPL(saveInputPcm),
6562 TOJSON_IMPL(saveOutputPcm),
6563 TOJSON_IMPL(registry)
6564 };
6565 }
6566 static void from_json(const nlohmann::json& j, EnginePolicyAudio& p)
6567 {
6568 p.clear();
6569 getOptional<bool>("enabled", p.enabled, j, true);
6570 getOptional<bool>("hardwareEnabled", p.hardwareEnabled, j, true);
6571 FROMJSON_IMPL(internalRate, int, 16000);
6572 FROMJSON_IMPL(internalChannels, int, 2);
6573
6574 FROMJSON_IMPL(muteTxOnTx, bool, false);
6575 getOptional<Aec>("aec", p.aec, j);
6576 getOptional<Vad>("vad", p.vad, j);
6577 getOptional<AndroidAudio>("android", p.android, j);
6578 getOptional<Agc>("inputAgc", p.inputAgc, j);
6579 getOptional<Agc>("outputAgc", p.outputAgc, j);
6580 FROMJSON_IMPL(denoiseInput, bool, false);
6581 FROMJSON_IMPL(denoiseOutput, bool, false);
6582 FROMJSON_IMPL(saveInputPcm, bool, false);
6583 FROMJSON_IMPL(saveOutputPcm, bool, false);
6584 getOptional<AudioRegistry>("registry", p.registry, j);
6585 }
6586
6587 //-----------------------------------------------------------
6588 JSON_SERIALIZED_CLASS(SecurityCertificate)
6599 {
6600 IMPLEMENT_JSON_SERIALIZATION()
6601 IMPLEMENT_JSON_DOCUMENTATION(SecurityCertificate)
6602
6603 public:
6604
6610 std::string certificate;
6611
6613 std::string key;
6614
6616 {
6617 clear();
6618 }
6619
6620 void clear()
6621 {
6622 certificate.clear();
6623 key.clear();
6624 }
6625 };
6626
6627 static void to_json(nlohmann::json& j, const SecurityCertificate& p)
6628 {
6629 j = nlohmann::json{
6630 TOJSON_IMPL(certificate),
6631 TOJSON_IMPL(key)
6632 };
6633 }
6634 static void from_json(const nlohmann::json& j, SecurityCertificate& p)
6635 {
6636 p.clear();
6637 FROMJSON_IMPL(certificate, std::string, EMPTY_STRING);
6638 FROMJSON_IMPL(key, std::string, EMPTY_STRING);
6639 }
6640
6641 // This is where spell checking stops
6642 //-----------------------------------------------------------
6643 JSON_SERIALIZED_CLASS(EnginePolicySecurity)
6644
6645
6655 {
6656 IMPLEMENT_JSON_SERIALIZATION()
6657 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicySecurity)
6658
6659 public:
6660
6672
6680 std::vector<std::string> caCertificates;
6681
6683 {
6684 clear();
6685 }
6686
6687 void clear()
6688 {
6689 certificate.clear();
6690 caCertificates.clear();
6691 }
6692 };
6693
6694 static void to_json(nlohmann::json& j, const EnginePolicySecurity& p)
6695 {
6696 j = nlohmann::json{
6697 TOJSON_IMPL(certificate),
6698 TOJSON_IMPL(caCertificates)
6699 };
6700 }
6701 static void from_json(const nlohmann::json& j, EnginePolicySecurity& p)
6702 {
6703 p.clear();
6704 getOptional("certificate", p.certificate, j);
6705 getOptional<std::vector<std::string>>("caCertificates", p.caCertificates, j);
6706 }
6707
6708 //-----------------------------------------------------------
6709 JSON_SERIALIZED_CLASS(EnginePolicyLogging)
6720 {
6721 IMPLEMENT_JSON_SERIALIZATION()
6722 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicyLogging)
6723
6724 public:
6725
6742
6745
6747 {
6748 clear();
6749 }
6750
6751 void clear()
6752 {
6753 maxLevel = 4; // ILogger::Level::debug
6754 enableSyslog = false;
6755 }
6756 };
6757
6758 static void to_json(nlohmann::json& j, const EnginePolicyLogging& p)
6759 {
6760 j = nlohmann::json{
6761 TOJSON_IMPL(maxLevel),
6762 TOJSON_IMPL(enableSyslog)
6763 };
6764 }
6765 static void from_json(const nlohmann::json& j, EnginePolicyLogging& p)
6766 {
6767 p.clear();
6768 getOptional("maxLevel", p.maxLevel, j, 4); // ILogger::Level::debug
6769 getOptional("enableSyslog", p.enableSyslog, j);
6770 }
6771
6772
6773 //-----------------------------------------------------------
6774 JSON_SERIALIZED_CLASS(EnginePolicyDatabase)
6776 {
6777 IMPLEMENT_JSON_SERIALIZATION()
6778 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicyDatabase)
6779
6780 public:
6781 typedef enum
6782 {
6783 dbtFixedMemory = 0,
6784 dbtPagedMemory = 1,
6785 dbtFixedFile = 2
6786 } DatabaseType_t;
6787
6788 DatabaseType_t type;
6789 std::string fixedFileName;
6790 bool forceMaintenance;
6791 bool reclaimSpace;
6792
6794 {
6795 clear();
6796 }
6797
6798 void clear()
6799 {
6800 type = DatabaseType_t::dbtFixedMemory;
6801 fixedFileName.clear();
6802 forceMaintenance = false;
6803 reclaimSpace = false;
6804 }
6805 };
6806
6807 static void to_json(nlohmann::json& j, const EnginePolicyDatabase& p)
6808 {
6809 j = nlohmann::json{
6810 TOJSON_IMPL(type),
6811 TOJSON_IMPL(fixedFileName),
6812 TOJSON_IMPL(forceMaintenance),
6813 TOJSON_IMPL(reclaimSpace)
6814 };
6815 }
6816 static void from_json(const nlohmann::json& j, EnginePolicyDatabase& p)
6817 {
6818 p.clear();
6819 FROMJSON_IMPL(type, EnginePolicyDatabase::DatabaseType_t, EnginePolicyDatabase::DatabaseType_t::dbtFixedMemory);
6820 FROMJSON_IMPL(fixedFileName, std::string, EMPTY_STRING);
6821 FROMJSON_IMPL(forceMaintenance, bool, false);
6822 FROMJSON_IMPL(reclaimSpace, bool, false);
6823 }
6824
6825
6826 //-----------------------------------------------------------
6827 JSON_SERIALIZED_CLASS(SecureSignature)
6836 {
6837 IMPLEMENT_JSON_SERIALIZATION()
6838 IMPLEMENT_JSON_DOCUMENTATION(SecureSignature)
6839
6840 public:
6841
6843 std::string certificate;
6844
6845 // /** @brief Contains the PEM-formatted text of the certificate's public key */
6846 //std::string publicKey;
6847
6849 std::string signature;
6850
6852 {
6853 clear();
6854 }
6855
6856 void clear()
6857 {
6858 certificate.clear();
6859 //publicKey.clear();
6860 signature.clear();
6861 }
6862 };
6863
6864 static void to_json(nlohmann::json& j, const SecureSignature& p)
6865 {
6866 j = nlohmann::json{
6867 TOJSON_IMPL(certificate),
6868 //TOJSON_IMPL(publicKey),
6869 TOJSON_IMPL(signature)
6870 };
6871 }
6872 static void from_json(const nlohmann::json& j, SecureSignature& p)
6873 {
6874 p.clear();
6875 FROMJSON_IMPL(certificate, std::string, EMPTY_STRING);
6876 //FROMJSON_IMPL(publicKey, std::string, EMPTY_STRING);
6877 FROMJSON_IMPL(signature, std::string, EMPTY_STRING);
6878 }
6879
6880 //-----------------------------------------------------------
6881 JSON_SERIALIZED_CLASS(NamedAudioDevice)
6883 {
6884 IMPLEMENT_JSON_SERIALIZATION()
6885 IMPLEMENT_JSON_DOCUMENTATION(NamedAudioDevice)
6886
6887 public:
6888 std::string name;
6889 std::string manufacturer;
6890 std::string model;
6891 std::string id;
6892 std::string serialNumber;
6893 std::string type;
6894 std::string extra;
6895 bool isDefault;
6896
6898 {
6899 clear();
6900 }
6901
6902 void clear()
6903 {
6904 name.clear();
6905 manufacturer.clear();
6906 model.clear();
6907 id.clear();
6908 serialNumber.clear();
6909 type.clear();
6910 extra.clear();
6911 isDefault = false;
6912 }
6913 };
6914
6915 static void to_json(nlohmann::json& j, const NamedAudioDevice& p)
6916 {
6917 j = nlohmann::json{
6918 TOJSON_IMPL(name),
6919 TOJSON_IMPL(manufacturer),
6920 TOJSON_IMPL(model),
6921 TOJSON_IMPL(id),
6922 TOJSON_IMPL(serialNumber),
6923 TOJSON_IMPL(type),
6924 TOJSON_IMPL(extra),
6925 TOJSON_IMPL(isDefault),
6926 };
6927 }
6928 static void from_json(const nlohmann::json& j, NamedAudioDevice& p)
6929 {
6930 p.clear();
6931 getOptional<std::string>("name", p.name, j, EMPTY_STRING);
6932 getOptional<std::string>("manufacturer", p.manufacturer, j, EMPTY_STRING);
6933 getOptional<std::string>("model", p.model, j, EMPTY_STRING);
6934 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
6935 getOptional<std::string>("serialNumber", p.serialNumber, j, EMPTY_STRING);
6936 getOptional<std::string>("type", p.type, j, EMPTY_STRING);
6937 getOptional<std::string>("extra", p.extra, j, EMPTY_STRING);
6938 getOptional<bool>("isDefault", p.isDefault, j, false);
6939 }
6940
6941
6942 //-----------------------------------------------------------
6943 JSON_SERIALIZED_CLASS(EnginePolicyNamedAudioDevices)
6945 {
6946 IMPLEMENT_JSON_SERIALIZATION()
6947 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicyNamedAudioDevices)
6948
6949 public:
6950 std::vector<NamedAudioDevice> inputs;
6951 std::vector<NamedAudioDevice> outputs;
6952
6954 {
6955 clear();
6956 }
6957
6958 void clear()
6959 {
6960 inputs.clear();
6961 outputs.clear();
6962 }
6963 };
6964
6965 static void to_json(nlohmann::json& j, const EnginePolicyNamedAudioDevices& p)
6966 {
6967 j = nlohmann::json{
6968 TOJSON_IMPL(inputs),
6969 TOJSON_IMPL(outputs)
6970 };
6971 }
6972 static void from_json(const nlohmann::json& j, EnginePolicyNamedAudioDevices& p)
6973 {
6974 p.clear();
6975 getOptional<std::vector<NamedAudioDevice>>("inputs", p.inputs, j);
6976 getOptional<std::vector<NamedAudioDevice>>("outputs", p.outputs, j);
6977 }
6978
6979 //-----------------------------------------------------------
6980 JSON_SERIALIZED_CLASS(Licensing)
6993 {
6994 IMPLEMENT_JSON_SERIALIZATION()
6995 IMPLEMENT_JSON_DOCUMENTATION(Licensing)
6996
6997 public:
6998
7000 std::string entitlement;
7001
7003 std::string key;
7004
7006 std::string activationCode;
7007
7009 std::string deviceId;
7010
7012 std::string manufacturerId;
7013
7014 Licensing()
7015 {
7016 clear();
7017 }
7018
7019 void clear()
7020 {
7021 entitlement.clear();
7022 key.clear();
7023 activationCode.clear();
7024 deviceId.clear();
7025 manufacturerId.clear();
7026 }
7027 };
7028
7029 static void to_json(nlohmann::json& j, const Licensing& p)
7030 {
7031 j = nlohmann::json{
7032 TOJSON_IMPL(entitlement),
7033 TOJSON_IMPL(key),
7034 TOJSON_IMPL(activationCode),
7035 TOJSON_IMPL(deviceId),
7036 TOJSON_IMPL(manufacturerId)
7037 };
7038 }
7039 static void from_json(const nlohmann::json& j, Licensing& p)
7040 {
7041 p.clear();
7042 FROMJSON_IMPL(entitlement, std::string, EMPTY_STRING);
7043 FROMJSON_IMPL(key, std::string, EMPTY_STRING);
7044 FROMJSON_IMPL(activationCode, std::string, EMPTY_STRING);
7045 FROMJSON_IMPL(deviceId, std::string, EMPTY_STRING);
7046 FROMJSON_IMPL(manufacturerId, std::string, EMPTY_STRING);
7047 }
7048
7049 //-----------------------------------------------------------
7050 JSON_SERIALIZED_CLASS(DiscoveryMagellan)
7061 {
7062 IMPLEMENT_JSON_SERIALIZATION()
7063 IMPLEMENT_JSON_DOCUMENTATION(DiscoveryMagellan)
7064
7065 public:
7066
7069
7071 std::string interfaceName;
7072
7075
7078
7080 {
7081 clear();
7082 }
7083
7084 void clear()
7085 {
7086 enabled = false;
7087 interfaceName.clear();
7088 security.clear();
7089 tls.clear();
7090 }
7091 };
7092
7093 static void to_json(nlohmann::json& j, const DiscoveryMagellan& p)
7094 {
7095 j = nlohmann::json{
7096 TOJSON_IMPL(enabled),
7097 TOJSON_IMPL(interfaceName),
7098 TOJSON_IMPL(security),
7099 TOJSON_IMPL(tls)
7100 };
7101 }
7102 static void from_json(const nlohmann::json& j, DiscoveryMagellan& p)
7103 {
7104 p.clear();
7105 getOptional("enabled", p.enabled, j, false);
7106 getOptional<Tls>("tls", p.tls, j);
7107 getOptional<SecurityCertificate>("security", p.security, j);
7108 FROMJSON_IMPL(interfaceName, std::string, EMPTY_STRING);
7109 }
7110
7111 //-----------------------------------------------------------
7112 JSON_SERIALIZED_CLASS(DiscoverySsdp)
7123 {
7124 IMPLEMENT_JSON_SERIALIZATION()
7125 IMPLEMENT_JSON_DOCUMENTATION(DiscoverySsdp)
7126
7127 public:
7128
7131
7133 std::string interfaceName;
7134
7137
7139 std::vector<std::string> searchTerms;
7140
7143
7146
7148 {
7149 clear();
7150 }
7151
7152 void clear()
7153 {
7154 enabled = false;
7155 interfaceName.clear();
7156 address.clear();
7157 searchTerms.clear();
7158 ageTimeoutMs = 30000;
7159 advertising.clear();
7160 }
7161 };
7162
7163 static void to_json(nlohmann::json& j, const DiscoverySsdp& p)
7164 {
7165 j = nlohmann::json{
7166 TOJSON_IMPL(enabled),
7167 TOJSON_IMPL(interfaceName),
7168 TOJSON_IMPL(address),
7169 TOJSON_IMPL(searchTerms),
7170 TOJSON_IMPL(ageTimeoutMs),
7171 TOJSON_IMPL(advertising)
7172 };
7173 }
7174 static void from_json(const nlohmann::json& j, DiscoverySsdp& p)
7175 {
7176 p.clear();
7177 getOptional("enabled", p.enabled, j, false);
7178 getOptional<std::string>("interfaceName", p.interfaceName, j);
7179
7180 getOptional<NetworkAddress>("address", p.address, j);
7181 if(p.address.address.empty())
7182 {
7183 p.address.address = "255.255.255.255";
7184 }
7185 if(p.address.port <= 0)
7186 {
7187 p.address.port = 1900;
7188 }
7189
7190 getOptional<std::vector<std::string>>("searchTerms", p.searchTerms, j);
7191 getOptional<int>("ageTimeoutMs", p.ageTimeoutMs, j, 30000);
7192 getOptional<Advertising>("advertising", p.advertising, j);
7193 }
7194
7195 //-----------------------------------------------------------
7196 JSON_SERIALIZED_CLASS(DiscoverySap)
7207 {
7208 IMPLEMENT_JSON_SERIALIZATION()
7209 IMPLEMENT_JSON_DOCUMENTATION(DiscoverySap)
7210
7211 public:
7214
7216 std::string interfaceName;
7217
7220
7223
7226
7227 DiscoverySap()
7228 {
7229 clear();
7230 }
7231
7232 void clear()
7233 {
7234 enabled = false;
7235 interfaceName.clear();
7236 address.clear();
7237 ageTimeoutMs = 30000;
7238 advertising.clear();
7239 }
7240 };
7241
7242 static void to_json(nlohmann::json& j, const DiscoverySap& p)
7243 {
7244 j = nlohmann::json{
7245 TOJSON_IMPL(enabled),
7246 TOJSON_IMPL(interfaceName),
7247 TOJSON_IMPL(address),
7248 TOJSON_IMPL(ageTimeoutMs),
7249 TOJSON_IMPL(advertising)
7250 };
7251 }
7252 static void from_json(const nlohmann::json& j, DiscoverySap& p)
7253 {
7254 p.clear();
7255 getOptional("enabled", p.enabled, j, false);
7256 getOptional<std::string>("interfaceName", p.interfaceName, j);
7257 getOptional<NetworkAddress>("address", p.address, j);
7258 if(p.address.address.empty())
7259 {
7260 p.address.address = "224.2.127.254";
7261 }
7262 if(p.address.port <= 0)
7263 {
7264 p.address.port = 9875;
7265 }
7266
7267 getOptional<int>("ageTimeoutMs", p.ageTimeoutMs, j, 30000);
7268 getOptional<Advertising>("advertising", p.advertising, j);
7269 }
7270
7271 //-----------------------------------------------------------
7272 JSON_SERIALIZED_CLASS(DiscoveryCistech)
7285 {
7286 IMPLEMENT_JSON_SERIALIZATION()
7287 IMPLEMENT_JSON_DOCUMENTATION(DiscoveryCistech)
7288
7289 public:
7290 bool enabled;
7291 std::string interfaceName;
7292 NetworkAddress address;
7293 int ageTimeoutMs;
7294
7296 {
7297 clear();
7298 }
7299
7300 void clear()
7301 {
7302 enabled = false;
7303 interfaceName.clear();
7304 address.clear();
7305 ageTimeoutMs = 30000;
7306 }
7307 };
7308
7309 static void to_json(nlohmann::json& j, const DiscoveryCistech& p)
7310 {
7311 j = nlohmann::json{
7312 TOJSON_IMPL(enabled),
7313 TOJSON_IMPL(interfaceName),
7314 TOJSON_IMPL(address),
7315 TOJSON_IMPL(ageTimeoutMs)
7316 };
7317 }
7318 static void from_json(const nlohmann::json& j, DiscoveryCistech& p)
7319 {
7320 p.clear();
7321 getOptional("enabled", p.enabled, j, false);
7322 getOptional<std::string>("interfaceName", p.interfaceName, j);
7323 getOptional<NetworkAddress>("address", p.address, j);
7324 getOptional<int>("ageTimeoutMs", p.ageTimeoutMs, j, 30000);
7325 }
7326
7327
7328 //-----------------------------------------------------------
7329 JSON_SERIALIZED_CLASS(DiscoveryTrellisware)
7340 {
7341 IMPLEMENT_JSON_SERIALIZATION()
7342 IMPLEMENT_JSON_DOCUMENTATION(DiscoveryTrellisware)
7343
7344 public:
7345
7348
7351
7353 {
7354 clear();
7355 }
7356
7357 void clear()
7358 {
7359 enabled = false;
7360 security.clear();
7361 }
7362 };
7363
7364 static void to_json(nlohmann::json& j, const DiscoveryTrellisware& p)
7365 {
7366 j = nlohmann::json{
7367 TOJSON_IMPL(enabled),
7368 TOJSON_IMPL(security)
7369 };
7370 }
7371 static void from_json(const nlohmann::json& j, DiscoveryTrellisware& p)
7372 {
7373 p.clear();
7374 getOptional("enabled", p.enabled, j, false);
7375 getOptional<SecurityCertificate>("security", p.security, j);
7376 }
7377
7378 //-----------------------------------------------------------
7379 JSON_SERIALIZED_CLASS(DiscoveryConfiguration)
7390 {
7391 IMPLEMENT_JSON_SERIALIZATION()
7392 IMPLEMENT_JSON_DOCUMENTATION(DiscoveryConfiguration)
7393
7394 public:
7397
7400
7403
7406
7409
7411 {
7412 clear();
7413 }
7414
7415 void clear()
7416 {
7417 magellan.clear();
7418 ssdp.clear();
7419 sap.clear();
7420 cistech.clear();
7421 }
7422 };
7423
7424 static void to_json(nlohmann::json& j, const DiscoveryConfiguration& p)
7425 {
7426 j = nlohmann::json{
7427 TOJSON_IMPL(magellan),
7428 TOJSON_IMPL(ssdp),
7429 TOJSON_IMPL(sap),
7430 TOJSON_IMPL(cistech),
7431 TOJSON_IMPL(trellisware)
7432 };
7433 }
7434 static void from_json(const nlohmann::json& j, DiscoveryConfiguration& p)
7435 {
7436 p.clear();
7437 getOptional<DiscoveryMagellan>("magellan", p.magellan, j);
7438 getOptional<DiscoverySsdp>("ssdp", p.ssdp, j);
7439 getOptional<DiscoverySap>("sap", p.sap, j);
7440 getOptional<DiscoveryCistech>("cistech", p.cistech, j);
7441 getOptional<DiscoveryTrellisware>("trellisware", p.trellisware, j);
7442 }
7443
7444
7445 //-----------------------------------------------------------
7446 JSON_SERIALIZED_CLASS(EnginePolicyInternals)
7459 {
7460 IMPLEMENT_JSON_SERIALIZATION()
7461 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicyInternals)
7462
7463 public:
7466
7469
7472
7473 int maxRxSecs;
7474
7475 int logTaskQueueStatsIntervalMs;
7476
7477 bool enableLazySpeakerClosure;
7478
7481
7484
7487
7490
7493
7496
7499
7502
7505
7507 {
7508 clear();
7509 }
7510
7511 void clear()
7512 {
7513 watchdog.clear();
7514 housekeeperIntervalMs = 1000;
7515 logTaskQueueStatsIntervalMs = 0;
7516 maxTxSecs = 30;
7517 maxRxSecs = 0;
7518 enableLazySpeakerClosure = false;
7519 rpClusterStrategy = RallypointCluster::ConnectionStrategy_t::csRoundRobin;
7520 rpClusterRolloverSecs = 10;
7521 rtpExpirationCheckIntervalMs = 250;
7522 rpConnectionTimeoutSecs = 0;
7523 rpTransactionTimeoutMs = 0;
7524 stickyTidHangSecs = 10;
7525 uriStreamingIntervalMs = 60;
7526 delayedMicrophoneClosureSecs = 15;
7527 tuning.clear();
7528 }
7529 };
7530
7531 static void to_json(nlohmann::json& j, const EnginePolicyInternals& p)
7532 {
7533 j = nlohmann::json{
7534 TOJSON_IMPL(watchdog),
7535 TOJSON_IMPL(housekeeperIntervalMs),
7536 TOJSON_IMPL(logTaskQueueStatsIntervalMs),
7537 TOJSON_IMPL(maxTxSecs),
7538 TOJSON_IMPL(maxRxSecs),
7539 TOJSON_IMPL(enableLazySpeakerClosure),
7540 TOJSON_IMPL(rpClusterStrategy),
7541 TOJSON_IMPL(rpClusterRolloverSecs),
7542 TOJSON_IMPL(rtpExpirationCheckIntervalMs),
7543 TOJSON_IMPL(rpConnectionTimeoutSecs),
7544 TOJSON_IMPL(rpTransactionTimeoutMs),
7545 TOJSON_IMPL(stickyTidHangSecs),
7546 TOJSON_IMPL(uriStreamingIntervalMs),
7547 TOJSON_IMPL(delayedMicrophoneClosureSecs),
7548 TOJSON_IMPL(tuning)
7549 };
7550 }
7551 static void from_json(const nlohmann::json& j, EnginePolicyInternals& p)
7552 {
7553 p.clear();
7554 getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
7555 getOptional<int>("housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
7556 getOptional<int>("logTaskQueueStatsIntervalMs", p.logTaskQueueStatsIntervalMs, j, 0);
7557 getOptional<int>("maxTxSecs", p.maxTxSecs, j, 30);
7558 getOptional<int>("maxRxSecs", p.maxRxSecs, j, 0);
7559 getOptional<bool>("enableLazySpeakerClosure", p.enableLazySpeakerClosure, j, false);
7560 getOptional<RallypointCluster::ConnectionStrategy_t>("rpClusterStrategy", p.rpClusterStrategy, j, RallypointCluster::ConnectionStrategy_t::csRoundRobin);
7561 getOptional<int>("rpClusterRolloverSecs", p.rpClusterRolloverSecs, j, 10);
7562 getOptional<int>("rtpExpirationCheckIntervalMs", p.rtpExpirationCheckIntervalMs, j, 250);
7563 getOptional<int>("rpConnectionTimeoutSecs", p.rpConnectionTimeoutSecs, j, 0);
7564 getOptional<int>("rpTransactionTimeoutMs", p.rpTransactionTimeoutMs, j, 0);
7565 getOptional<int>("stickyTidHangSecs", p.stickyTidHangSecs, j, 10);
7566 getOptional<int>("uriStreamingIntervalMs", p.uriStreamingIntervalMs, j, 60);
7567 getOptional<int>("delayedMicrophoneClosureSecs", p.delayedMicrophoneClosureSecs, j, 15);
7568 getOptional<TuningSettings>("tuning", p.tuning, j);
7569 }
7570
7571 //-----------------------------------------------------------
7572 JSON_SERIALIZED_CLASS(EnginePolicyTimelines)
7585 {
7586 IMPLEMENT_JSON_SERIALIZATION()
7587 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicyTimelines)
7588
7589 public:
7590
7597
7599 std::string storageRoot;
7600
7603
7606
7609
7612
7615
7618
7621
7630
7633
7636
7639
7641 {
7642 clear();
7643 }
7644
7645 void clear()
7646 {
7647 enabled = true;
7648 storageRoot.clear();
7649 maxStorageMb = 1024; // 1 Gigabyte
7650 maxMemMb = maxStorageMb;
7651 maxAudioEventMemMb = maxMemMb;
7652 maxDiskMb = maxStorageMb;
7653 maxEventAgeSecs = (86400 * 30); // 30 days
7654 groomingIntervalSecs = (60 * 30); // 30 minutes
7655 maxEvents = 1000;
7656 autosaveIntervalSecs = 5;
7657 security.clear();
7658 disableSigningAndVerification = false;
7659 ephemeral = false;
7660 }
7661 };
7662
7663 static void to_json(nlohmann::json& j, const EnginePolicyTimelines& p)
7664 {
7665 j = nlohmann::json{
7666 TOJSON_IMPL(enabled),
7667 TOJSON_IMPL(storageRoot),
7668 TOJSON_IMPL(maxMemMb),
7669 TOJSON_IMPL(maxAudioEventMemMb),
7670 TOJSON_IMPL(maxDiskMb),
7671 TOJSON_IMPL(maxEventAgeSecs),
7672 TOJSON_IMPL(maxEvents),
7673 TOJSON_IMPL(groomingIntervalSecs),
7674 TOJSON_IMPL(autosaveIntervalSecs),
7675 TOJSON_IMPL(security),
7676 TOJSON_IMPL(disableSigningAndVerification),
7677 TOJSON_IMPL(ephemeral)
7678 };
7679 }
7680 static void from_json(const nlohmann::json& j, EnginePolicyTimelines& p)
7681 {
7682 p.clear();
7683 getOptional<bool>("enabled", p.enabled, j, true);
7684 getOptional<std::string>("storageRoot", p.storageRoot, j, EMPTY_STRING);
7685
7686 getOptional<int>("maxStorageMb", p.maxStorageMb, j, 1024);
7687 getOptional<int>("maxMemMb", p.maxMemMb, j, p.maxStorageMb);
7688 getOptional<int>("maxAudioEventMemMb", p.maxAudioEventMemMb, j, p.maxMemMb);
7689 getOptional<int>("maxDiskMb", p.maxDiskMb, j, p.maxStorageMb);
7690 getOptional<long>("maxEventAgeSecs", p.maxEventAgeSecs, j, (86400 * 30));
7691 getOptional<long>("groomingIntervalSecs", p.groomingIntervalSecs, j, (60 * 30));
7692 getOptional<long>("autosaveIntervalSecs", p.autosaveIntervalSecs, j, 5);
7693 getOptional<int>("maxEvents", p.maxEvents, j, 1000);
7694 getOptional<SecurityCertificate>("security", p.security, j);
7695 getOptional<bool>("disableSigningAndVerification", p.disableSigningAndVerification, j, false);
7696 getOptional<bool>("ephemeral", p.ephemeral, j, false);
7697 }
7698
7699
7700 //-----------------------------------------------------------
7701 JSON_SERIALIZED_CLASS(RtpMapEntry)
7712 {
7713 IMPLEMENT_JSON_SERIALIZATION()
7714 IMPLEMENT_JSON_DOCUMENTATION(RtpMapEntry)
7715
7716 public:
7718 std::string name;
7719
7722
7725
7726 RtpMapEntry()
7727 {
7728 clear();
7729 }
7730
7731 void clear()
7732 {
7733 name.clear();
7734 engageType = -1;
7735 rtpPayloadType = -1;
7736 }
7737 };
7738
7739 static void to_json(nlohmann::json& j, const RtpMapEntry& p)
7740 {
7741 j = nlohmann::json{
7742 TOJSON_IMPL(name),
7743 TOJSON_IMPL(engageType),
7744 TOJSON_IMPL(rtpPayloadType)
7745 };
7746 }
7747 static void from_json(const nlohmann::json& j, RtpMapEntry& p)
7748 {
7749 p.clear();
7750 getOptional<std::string>("name", p.name, j, EMPTY_STRING);
7751 getOptional<int>("engageType", p.engageType, j, -1);
7752 getOptional<int>("rtpPayloadType", p.rtpPayloadType, j, -1);
7753 }
7754
7755 //-----------------------------------------------------------
7756 JSON_SERIALIZED_CLASS(ExternalModule)
7767 {
7768 IMPLEMENT_JSON_SERIALIZATION()
7769 IMPLEMENT_JSON_DOCUMENTATION(ExternalModule)
7770
7771 public:
7773 std::string name;
7774
7776 std::string file;
7777
7779 nlohmann::json configuration;
7780
7782 {
7783 clear();
7784 }
7785
7786 void clear()
7787 {
7788 name.clear();
7789 file.clear();
7790 configuration.clear();
7791 }
7792 };
7793
7794 static void to_json(nlohmann::json& j, const ExternalModule& p)
7795 {
7796 j = nlohmann::json{
7797 TOJSON_IMPL(name),
7798 TOJSON_IMPL(file)
7799 };
7800
7801 if(!p.configuration.empty())
7802 {
7803 j["configuration"] = p.configuration;
7804 }
7805 }
7806 static void from_json(const nlohmann::json& j, ExternalModule& p)
7807 {
7808 p.clear();
7809 getOptional<std::string>("name", p.name, j, EMPTY_STRING);
7810 getOptional<std::string>("file", p.file, j, EMPTY_STRING);
7811
7812 try
7813 {
7814 p.configuration = j.at("configuration");
7815 }
7816 catch(...)
7817 {
7818 p.configuration.clear();
7819 }
7820 }
7821
7822
7823 //-----------------------------------------------------------
7824 JSON_SERIALIZED_CLASS(ExternalCodecDescriptor)
7835 {
7836 IMPLEMENT_JSON_SERIALIZATION()
7837 IMPLEMENT_JSON_DOCUMENTATION(ExternalCodecDescriptor)
7838
7839 public:
7842
7845
7848
7851
7853 {
7854 clear();
7855 }
7856
7857 void clear()
7858 {
7859 rtpPayloadType = -1;
7860 samplingRate = -1;
7861 channels = -1;
7862 rtpTsMultiplier = 0;
7863 }
7864 };
7865
7866 static void to_json(nlohmann::json& j, const ExternalCodecDescriptor& p)
7867 {
7868 j = nlohmann::json{
7869 TOJSON_IMPL(rtpPayloadType),
7870 TOJSON_IMPL(samplingRate),
7871 TOJSON_IMPL(channels),
7872 TOJSON_IMPL(rtpTsMultiplier)
7873 };
7874 }
7875 static void from_json(const nlohmann::json& j, ExternalCodecDescriptor& p)
7876 {
7877 p.clear();
7878
7879 getOptional<int>("rtpPayloadType", p.rtpPayloadType, j, -1);
7880 getOptional<int>("samplingRate", p.samplingRate, j, -1);
7881 getOptional<int>("channels", p.channels, j, -1);
7882 getOptional<int>("rtpTsMultiplier", p.rtpTsMultiplier, j, -1);
7883 }
7884
7885 //-----------------------------------------------------------
7886 JSON_SERIALIZED_CLASS(EngineStatusReportConfiguration)
7897 {
7898 IMPLEMENT_JSON_SERIALIZATION()
7899 IMPLEMENT_JSON_DOCUMENTATION(EngineStatusReportConfiguration)
7900
7901 public:
7903 std::string fileName;
7904
7907
7910
7912 std::string runCmd;
7913
7916
7919
7921 {
7922 clear();
7923 }
7924
7925 void clear()
7926 {
7927 fileName.clear();
7928 intervalSecs = 60;
7929 enabled = false;
7930 includeMemoryDetail = false;
7931 includeTaskQueueDetail = false;
7932 runCmd.clear();
7933 }
7934 };
7935
7936 static void to_json(nlohmann::json& j, const EngineStatusReportConfiguration& p)
7937 {
7938 j = nlohmann::json{
7939 TOJSON_IMPL(fileName),
7940 TOJSON_IMPL(intervalSecs),
7941 TOJSON_IMPL(enabled),
7942 TOJSON_IMPL(includeMemoryDetail),
7943 TOJSON_IMPL(includeTaskQueueDetail),
7944 TOJSON_IMPL(runCmd)
7945 };
7946 }
7947 static void from_json(const nlohmann::json& j, EngineStatusReportConfiguration& p)
7948 {
7949 p.clear();
7950 getOptional<std::string>("fileName", p.fileName, j);
7951 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
7952 getOptional<bool>("enabled", p.enabled, j, false);
7953 getOptional<std::string>("runCmd", p.runCmd, j);
7954 getOptional<bool>("includeMemoryDetail", p.includeMemoryDetail, j, false);
7955 getOptional<bool>("includeTaskQueueDetail", p.includeTaskQueueDetail, j, false);
7956 }
7957
7958 //-----------------------------------------------------------
7959 JSON_SERIALIZED_CLASS(EnginePolicy)
7972 {
7973 IMPLEMENT_JSON_SERIALIZATION()
7974 IMPLEMENT_JSON_DOCUMENTATION(EnginePolicy)
7975
7976 public:
7977
7979 std::string dataDirectory;
7980
7983
7986
7989
7992
7995
7998
8001
8004
8007
8010
8013
8015 std::vector<ExternalModule> externalCodecs;
8016
8018 std::vector<RtpMapEntry> rtpMap;
8019
8022
8023 EnginePolicy()
8024 {
8025 clear();
8026 }
8027
8028 void clear()
8029 {
8030 dataDirectory.clear();
8031 licensing.clear();
8032 security.clear();
8033 networking.clear();
8034 audio.clear();
8035 discovery.clear();
8036 logging.clear();
8037 internals.clear();
8038 timelines.clear();
8039 database.clear();
8040 featureset.clear();
8041 namedAudioDevices.clear();
8042 externalCodecs.clear();
8043 rtpMap.clear();
8044 statusReport.clear();
8045 }
8046 };
8047
8048 static void to_json(nlohmann::json& j, const EnginePolicy& p)
8049 {
8050 j = nlohmann::json{
8051 TOJSON_IMPL(dataDirectory),
8052 TOJSON_IMPL(licensing),
8053 TOJSON_IMPL(security),
8054 TOJSON_IMPL(networking),
8055 TOJSON_IMPL(audio),
8056 TOJSON_IMPL(discovery),
8057 TOJSON_IMPL(logging),
8058 TOJSON_IMPL(internals),
8059 TOJSON_IMPL(timelines),
8060 TOJSON_IMPL(database),
8061 TOJSON_IMPL(featureset),
8062 TOJSON_IMPL(namedAudioDevices),
8063 TOJSON_IMPL(externalCodecs),
8064 TOJSON_IMPL(rtpMap),
8065 TOJSON_IMPL(statusReport)
8066 };
8067 }
8068 static void from_json(const nlohmann::json& j, EnginePolicy& p)
8069 {
8070 p.clear();
8071 FROMJSON_IMPL_SIMPLE(dataDirectory);
8072 FROMJSON_IMPL_SIMPLE(licensing);
8073 FROMJSON_IMPL_SIMPLE(security);
8074 FROMJSON_IMPL_SIMPLE(networking);
8075 FROMJSON_IMPL_SIMPLE(audio);
8076 FROMJSON_IMPL_SIMPLE(discovery);
8077 FROMJSON_IMPL_SIMPLE(logging);
8078 FROMJSON_IMPL_SIMPLE(internals);
8079 FROMJSON_IMPL_SIMPLE(timelines);
8080 FROMJSON_IMPL_SIMPLE(database);
8081 FROMJSON_IMPL_SIMPLE(featureset);
8082 FROMJSON_IMPL_SIMPLE(namedAudioDevices);
8083 FROMJSON_IMPL_SIMPLE(externalCodecs);
8084 FROMJSON_IMPL_SIMPLE(rtpMap);
8085 FROMJSON_IMPL_SIMPLE(statusReport);
8086 }
8087
8088
8089 //-----------------------------------------------------------
8090 JSON_SERIALIZED_CLASS(TalkgroupAsset)
8101 {
8102 IMPLEMENT_JSON_SERIALIZATION()
8103 IMPLEMENT_JSON_DOCUMENTATION(TalkgroupAsset)
8104
8105 public:
8106
8108 std::string nodeId;
8109
8112
8114 {
8115 clear();
8116 }
8117
8118 void clear()
8119 {
8120 nodeId.clear();
8121 group.clear();
8122 }
8123 };
8124
8125 static void to_json(nlohmann::json& j, const TalkgroupAsset& p)
8126 {
8127 j = nlohmann::json{
8128 TOJSON_IMPL(nodeId),
8129 TOJSON_IMPL(group)
8130 };
8131 }
8132 static void from_json(const nlohmann::json& j, TalkgroupAsset& p)
8133 {
8134 p.clear();
8135 getOptional<std::string>("nodeId", p.nodeId, j);
8136 getOptional<Group>("group", p.group, j);
8137 }
8138
8139 //-----------------------------------------------------------
8140 JSON_SERIALIZED_CLASS(EngageDiscoveredGroup)
8149 {
8150 IMPLEMENT_JSON_SERIALIZATION()
8151 IMPLEMENT_JSON_DOCUMENTATION(EngageDiscoveredGroup)
8152
8153 public:
8155 std::string id;
8156
8158 int type;
8159
8162
8165
8167 {
8168 clear();
8169 }
8170
8171 void clear()
8172 {
8173 id.clear();
8174 type = 0;
8175 rx.clear();
8176 tx.clear();
8177 }
8178 };
8179
8180 static void to_json(nlohmann::json& j, const EngageDiscoveredGroup& p)
8181 {
8182 j = nlohmann::json{
8183 TOJSON_IMPL(id),
8184 TOJSON_IMPL(type),
8185 TOJSON_IMPL(rx),
8186 TOJSON_IMPL(tx)
8187 };
8188 }
8189 static void from_json(const nlohmann::json& j, EngageDiscoveredGroup& p)
8190 {
8191 p.clear();
8192 getOptional<std::string>("id", p.id, j);
8193 getOptional<int>("type", p.type, j, 0);
8194 getOptional<NetworkAddress>("rx", p.rx, j);
8195 getOptional<NetworkAddress>("tx", p.tx, j);
8196 }
8197
8198 //-----------------------------------------------------------
8199 JSON_SERIALIZED_CLASS(RallypointPeer)
8210 {
8211 IMPLEMENT_JSON_SERIALIZATION()
8212 IMPLEMENT_JSON_DOCUMENTATION(RallypointPeer)
8213
8214 public:
8215 typedef enum
8216 {
8218 olpUseRpConfiguration = 0,
8219
8221 olpIsMeshLeaf = 1,
8222
8224 olpNotMeshLeaf = 2
8225 } OutboundLeafPolicy_t;
8226
8227 typedef enum
8228 {
8230 olpUseRpWebSocketTlsConfiguration = 0,
8231
8233 olpUseTlsForWebSocket = 1,
8234
8236 olpDoNotUseTlsForWebSocket = 2
8237 } OutboundWebSocketTlsPolicy_t;
8238
8240 std::string id;
8241
8244
8247
8250
8253
8256
8257 OutboundLeafPolicy_t outboundLeafPolicy;
8258
8261
8263 std::string path;
8264
8267
8270
8272 {
8273 clear();
8274 }
8275
8276 void clear()
8277 {
8278 id.clear();
8279 enabled = true;
8280 host.clear();
8281 certificate.clear();
8282 connectionTimeoutSecs = 0;
8283 forceIsMeshLeaf = false;
8284 outboundLeafPolicy = OutboundLeafPolicy_t::olpUseRpConfiguration;
8285 protocol = Rallypoint::RpProtocol_t::rppTlsTcp;
8286 path.clear();
8287 additionalProtocols.clear();
8288 outboundWebSocketTlsPolicy = OutboundWebSocketTlsPolicy_t::olpUseRpWebSocketTlsConfiguration;
8289 }
8290 };
8291
8292 static void to_json(nlohmann::json& j, const RallypointPeer& p)
8293 {
8294 j = nlohmann::json{
8295 TOJSON_IMPL(id),
8296 TOJSON_IMPL(enabled),
8297 TOJSON_IMPL(host),
8298 TOJSON_IMPL(certificate),
8299 TOJSON_IMPL(connectionTimeoutSecs),
8300 TOJSON_IMPL(forceIsMeshLeaf),
8301 TOJSON_IMPL(outboundLeafPolicy),
8302 TOJSON_IMPL(protocol),
8303 TOJSON_IMPL(path),
8304 TOJSON_IMPL(additionalProtocols),
8305 TOJSON_IMPL(outboundWebSocketTlsPolicy)
8306 };
8307 }
8308 static void from_json(const nlohmann::json& j, RallypointPeer& p)
8309 {
8310 p.clear();
8311 j.at("id").get_to(p.id);
8312 getOptional<bool>("enabled", p.enabled, j, true);
8313 getOptional<NetworkAddress>("host", p.host, j);
8314 getOptional<SecurityCertificate>("certificate", p.certificate, j);
8315 getOptional<int>("connectionTimeoutSecs", p.connectionTimeoutSecs, j, 0);
8316 getOptional<bool>("forceIsMeshLeaf", p.forceIsMeshLeaf, j, false);
8317 getOptional<RallypointPeer::OutboundLeafPolicy_t>("outboundLeafPolicy", p.outboundLeafPolicy, j, RallypointPeer::OutboundLeafPolicy_t::olpUseRpConfiguration);
8318 getOptional<Rallypoint::RpProtocol_t>("protocol", p.protocol, j, Rallypoint::RpProtocol_t::rppTlsTcp);
8319 getOptional<std::string>("path", p.path, j);
8320 getOptional<std::string>("additionalProtocols", p.additionalProtocols, j);
8321 getOptional<RallypointPeer::OutboundWebSocketTlsPolicy_t>("outboundWebSocketTlsPolicy", p.outboundWebSocketTlsPolicy, j, RallypointPeer::OutboundWebSocketTlsPolicy_t::olpUseRpWebSocketTlsConfiguration);
8322 }
8323
8324 //-----------------------------------------------------------
8325 JSON_SERIALIZED_CLASS(RallypointServerLimits)
8336 {
8337 IMPLEMENT_JSON_SERIALIZATION()
8338 IMPLEMENT_JSON_DOCUMENTATION(RallypointServerLimits)
8339
8340 public:
8342 uint32_t maxClients;
8343
8345 uint32_t maxPeers;
8346
8349
8352
8355
8358
8361
8364
8367
8370
8373
8376
8379
8382
8385
8387 {
8388 clear();
8389 }
8390
8391 void clear()
8392 {
8393 maxClients = 0;
8394 maxPeers = 0;
8395 maxMulticastReflectors = 0;
8396 maxRegisteredStreams = 0;
8397 maxStreamPaths = 0;
8398 maxRxPacketsPerSec = 0;
8399 maxTxPacketsPerSec = 0;
8400 maxRxBytesPerSec = 0;
8401 maxTxBytesPerSec = 0;
8402 maxQOpsPerSec = 0;
8403 maxInboundBacklog = 64;
8404 lowPriorityQueueThreshold = 64;
8405 normalPriorityQueueThreshold = 256;
8406 denyNewConnectionCpuThreshold = 75;
8407 warnAtCpuThreshold = 65;
8408 }
8409 };
8410
8411 static void to_json(nlohmann::json& j, const RallypointServerLimits& p)
8412 {
8413 j = nlohmann::json{
8414 TOJSON_IMPL(maxClients),
8415 TOJSON_IMPL(maxPeers),
8416 TOJSON_IMPL(maxMulticastReflectors),
8417 TOJSON_IMPL(maxRegisteredStreams),
8418 TOJSON_IMPL(maxStreamPaths),
8419 TOJSON_IMPL(maxRxPacketsPerSec),
8420 TOJSON_IMPL(maxTxPacketsPerSec),
8421 TOJSON_IMPL(maxRxBytesPerSec),
8422 TOJSON_IMPL(maxTxBytesPerSec),
8423 TOJSON_IMPL(maxQOpsPerSec),
8424 TOJSON_IMPL(maxInboundBacklog),
8425 TOJSON_IMPL(lowPriorityQueueThreshold),
8426 TOJSON_IMPL(normalPriorityQueueThreshold),
8427 TOJSON_IMPL(denyNewConnectionCpuThreshold),
8428 TOJSON_IMPL(warnAtCpuThreshold)
8429 };
8430 }
8431 static void from_json(const nlohmann::json& j, RallypointServerLimits& p)
8432 {
8433 p.clear();
8434 getOptional<uint32_t>("maxClients", p.maxClients, j, 0);
8435 getOptional<uint32_t>("maxPeers", p.maxPeers, j, 0);
8436 getOptional<uint32_t>("maxMulticastReflectors", p.maxMulticastReflectors, j, 0);
8437 getOptional<uint32_t>("maxRegisteredStreams", p.maxRegisteredStreams, j, 0);
8438 getOptional<uint32_t>("maxStreamPaths", p.maxStreamPaths, j, 0);
8439 getOptional<uint32_t>("maxRxPacketsPerSec", p.maxRxPacketsPerSec, j, 0);
8440 getOptional<uint32_t>("maxTxPacketsPerSec", p.maxTxPacketsPerSec, j, 0);
8441 getOptional<uint32_t>("maxRxBytesPerSec", p.maxRxBytesPerSec, j, 0);
8442 getOptional<uint32_t>("maxTxBytesPerSec", p.maxTxBytesPerSec, j, 0);
8443 getOptional<uint32_t>("maxQOpsPerSec", p.maxQOpsPerSec, j, 0);
8444 getOptional<uint32_t>("maxInboundBacklog", p.maxInboundBacklog, j, 64);
8445 getOptional<uint32_t>("lowPriorityQueueThreshold", p.lowPriorityQueueThreshold, j, 64);
8446 getOptional<uint32_t>("normalPriorityQueueThreshold", p.normalPriorityQueueThreshold, j, 256);
8447 getOptional<uint32_t>("denyNewConnectionCpuThreshold", p.denyNewConnectionCpuThreshold, j, 75);
8448 getOptional<uint32_t>("warnAtCpuThreshold", p.warnAtCpuThreshold, j, 65);
8449 }
8450
8451 //-----------------------------------------------------------
8452 JSON_SERIALIZED_CLASS(RallypointServerStatusReportConfiguration)
8463 {
8464 IMPLEMENT_JSON_SERIALIZATION()
8465 IMPLEMENT_JSON_DOCUMENTATION(RallypointServerStatusReportConfiguration)
8466
8467 public:
8469 std::string fileName;
8470
8473
8476
8479
8482
8485
8487 std::string runCmd;
8488
8490 {
8491 clear();
8492 }
8493
8494 void clear()
8495 {
8496 fileName.clear();
8497 intervalSecs = 60;
8498 enabled = false;
8499 includeLinks = false;
8500 includePeerLinkDetails = false;
8501 includeClientLinkDetails = false;
8502 runCmd.clear();
8503 }
8504 };
8505
8506 static void to_json(nlohmann::json& j, const RallypointServerStatusReportConfiguration& p)
8507 {
8508 j = nlohmann::json{
8509 TOJSON_IMPL(fileName),
8510 TOJSON_IMPL(intervalSecs),
8511 TOJSON_IMPL(enabled),
8512 TOJSON_IMPL(includeLinks),
8513 TOJSON_IMPL(includePeerLinkDetails),
8514 TOJSON_IMPL(includeClientLinkDetails),
8515 TOJSON_IMPL(runCmd)
8516 };
8517 }
8518 static void from_json(const nlohmann::json& j, RallypointServerStatusReportConfiguration& p)
8519 {
8520 p.clear();
8521 getOptional<std::string>("fileName", p.fileName, j);
8522 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
8523 getOptional<bool>("enabled", p.enabled, j, false);
8524 getOptional<bool>("includeLinks", p.includeLinks, j, false);
8525 getOptional<bool>("includePeerLinkDetails", p.includePeerLinkDetails, j, false);
8526 getOptional<bool>("includeClientLinkDetails", p.includeClientLinkDetails, j, false);
8527 getOptional<std::string>("runCmd", p.runCmd, j);
8528 }
8529
8530 //-----------------------------------------------------------
8531 JSON_SERIALIZED_CLASS(RallypointServerLinkGraph)
8533 {
8534 IMPLEMENT_JSON_SERIALIZATION()
8535 IMPLEMENT_JSON_DOCUMENTATION(RallypointServerLinkGraph)
8536
8537 public:
8539 std::string fileName;
8540
8543
8546
8549
8554
8556 std::string coreRpStyling;
8557
8559 std::string leafRpStyling;
8560
8562 std::string clientStyling;
8563
8565 std::string runCmd;
8566
8568 {
8569 clear();
8570 }
8571
8572 void clear()
8573 {
8574 fileName.clear();
8575 minRefreshSecs = 5;
8576 enabled = false;
8577 includeDigraphEnclosure = true;
8578 includeClients = false;
8579 coreRpStyling = "[shape=hexagon color=firebrick style=filled]";
8580 leafRpStyling = "[shape=box color=gray style=filled]";
8581 clientStyling.clear();
8582 runCmd.clear();
8583 }
8584 };
8585
8586 static void to_json(nlohmann::json& j, const RallypointServerLinkGraph& p)
8587 {
8588 j = nlohmann::json{
8589 TOJSON_IMPL(fileName),
8590 TOJSON_IMPL(minRefreshSecs),
8591 TOJSON_IMPL(enabled),
8592 TOJSON_IMPL(includeDigraphEnclosure),
8593 TOJSON_IMPL(includeClients),
8594 TOJSON_IMPL(coreRpStyling),
8595 TOJSON_IMPL(leafRpStyling),
8596 TOJSON_IMPL(clientStyling),
8597 TOJSON_IMPL(runCmd)
8598 };
8599 }
8600 static void from_json(const nlohmann::json& j, RallypointServerLinkGraph& p)
8601 {
8602 p.clear();
8603 getOptional<std::string>("fileName", p.fileName, j);
8604 getOptional<int>("minRefreshSecs", p.minRefreshSecs, j, 5);
8605 getOptional<bool>("enabled", p.enabled, j, false);
8606 getOptional<bool>("includeDigraphEnclosure", p.includeDigraphEnclosure, j, true);
8607 getOptional<bool>("includeClients", p.includeClients, j, false);
8608 getOptional<std::string>("coreRpStyling", p.coreRpStyling, j, "[shape=hexagon color=firebrick style=filled]");
8609 getOptional<std::string>("leafRpStyling", p.leafRpStyling, j, "[shape=box color=gray style=filled]");
8610 getOptional<std::string>("clientStyling", p.clientStyling, j);
8611 getOptional<std::string>("runCmd", p.runCmd, j);
8612 }
8613
8614
8615 //-----------------------------------------------------------
8616 JSON_SERIALIZED_CLASS(RallypointServerStreamStatsExport)
8625 {
8626 IMPLEMENT_JSON_SERIALIZATION()
8627 IMPLEMENT_JSON_DOCUMENTATION(RallypointServerStreamStatsExport)
8628
8629 public:
8631 typedef enum
8632 {
8634 fmtCsv = 0,
8635
8637 fmtJson = 1
8638 } ExportFormat_t;
8639
8641 std::string fileName;
8642
8645
8648
8651
8653 std::string runCmd;
8654
8657
8658
8660 {
8661 clear();
8662 }
8663
8664 void clear()
8665 {
8666 fileName.clear();
8667 intervalSecs = 60;
8668 enabled = false;
8669 resetCountersAfterExport = false;
8670 runCmd.clear();
8671 format = fmtJson;
8672 }
8673 };
8674
8675 static void to_json(nlohmann::json& j, const RallypointServerStreamStatsExport& p)
8676 {
8677 j = nlohmann::json{
8678 TOJSON_IMPL(fileName),
8679 TOJSON_IMPL(intervalSecs),
8680 TOJSON_IMPL(enabled),
8681 TOJSON_IMPL(resetCountersAfterExport),
8682 TOJSON_IMPL(runCmd),
8683 TOJSON_IMPL(format)
8684 };
8685 }
8686 static void from_json(const nlohmann::json& j, RallypointServerStreamStatsExport& p)
8687 {
8688 p.clear();
8689 getOptional<std::string>("fileName", p.fileName, j);
8690 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
8691 getOptional<bool>("enabled", p.enabled, j, false);
8692 getOptional<bool>("resetCountersAfterExport", p.resetCountersAfterExport, j, false);
8693 getOptional<std::string>("runCmd", p.runCmd, j);
8694 getOptional<RallypointServerStreamStatsExport::ExportFormat_t>("format", p.format, j, RallypointServerStreamStatsExport::ExportFormat_t::fmtCsv);
8695 }
8696
8697 //-----------------------------------------------------------
8698 JSON_SERIALIZED_CLASS(RallypointServerRouteMap)
8700 {
8701 IMPLEMENT_JSON_SERIALIZATION()
8702 IMPLEMENT_JSON_DOCUMENTATION(RallypointServerRouteMap)
8703
8704 public:
8706 std::string fileName;
8707
8710
8713
8715 std::string runCmd;
8716
8718 {
8719 clear();
8720 }
8721
8722 void clear()
8723 {
8724 fileName.clear();
8725 minRefreshSecs = 5;
8726 enabled = false;
8727 }
8728 };
8729
8730 static void to_json(nlohmann::json& j, const RallypointServerRouteMap& p)
8731 {
8732 j = nlohmann::json{
8733 TOJSON_IMPL(fileName),
8734 TOJSON_IMPL(minRefreshSecs),
8735 TOJSON_IMPL(enabled),
8736 TOJSON_IMPL(runCmd)
8737 };
8738 }
8739 static void from_json(const nlohmann::json& j, RallypointServerRouteMap& p)
8740 {
8741 p.clear();
8742 getOptional<std::string>("fileName", p.fileName, j);
8743 getOptional<int>("minRefreshSecs", p.minRefreshSecs, j, 5);
8744 getOptional<bool>("enabled", p.enabled, j, false);
8745 getOptional<std::string>("runCmd", p.runCmd, j);
8746 }
8747
8748
8749 //-----------------------------------------------------------
8750 JSON_SERIALIZED_CLASS(ExternalHealthCheckResponder)
8761 {
8762 IMPLEMENT_JSON_SERIALIZATION()
8763 IMPLEMENT_JSON_DOCUMENTATION(ExternalHealthCheckResponder)
8764
8765 public:
8766
8769
8772
8774 {
8775 clear();
8776 }
8777
8778 void clear()
8779 {
8780 listenPort = 0;
8781 immediateClose = true;
8782 }
8783 };
8784
8785 static void to_json(nlohmann::json& j, const ExternalHealthCheckResponder& p)
8786 {
8787 j = nlohmann::json{
8788 TOJSON_IMPL(listenPort),
8789 TOJSON_IMPL(immediateClose)
8790 };
8791 }
8792 static void from_json(const nlohmann::json& j, ExternalHealthCheckResponder& p)
8793 {
8794 p.clear();
8795 getOptional<int>("listenPort", p.listenPort, j, 0);
8796 getOptional<bool>("immediateClose", p.immediateClose, j, true);
8797 }
8798
8799
8800 //-----------------------------------------------------------
8801 JSON_SERIALIZED_CLASS(PeeringConfiguration)
8810 {
8811 IMPLEMENT_JSON_SERIALIZATION()
8812 IMPLEMENT_JSON_DOCUMENTATION(PeeringConfiguration)
8813
8814 public:
8815
8817 std::string id;
8818
8821
8823 std::string comments;
8824
8826 std::vector<RallypointPeer> peers;
8827
8829 {
8830 clear();
8831 }
8832
8833 void clear()
8834 {
8835 id.clear();
8836 version = 0;
8837 comments.clear();
8838 }
8839 };
8840
8841 static void to_json(nlohmann::json& j, const PeeringConfiguration& p)
8842 {
8843 j = nlohmann::json{
8844 TOJSON_IMPL(id),
8845 TOJSON_IMPL(version),
8846 TOJSON_IMPL(comments),
8847 TOJSON_IMPL(peers)
8848 };
8849 }
8850 static void from_json(const nlohmann::json& j, PeeringConfiguration& p)
8851 {
8852 p.clear();
8853 getOptional<std::string>("id", p.id, j);
8854 getOptional<int>("version", p.version, j, 0);
8855 getOptional<std::string>("comments", p.comments, j);
8856 getOptional<std::vector<RallypointPeer>>("peers", p.peers, j);
8857 }
8858
8859 //-----------------------------------------------------------
8860 JSON_SERIALIZED_CLASS(IgmpSnooping)
8869 {
8870 IMPLEMENT_JSON_SERIALIZATION()
8871 IMPLEMENT_JSON_DOCUMENTATION(IgmpSnooping)
8872
8873 public:
8874
8877
8880
8883
8884
8885 IgmpSnooping()
8886 {
8887 clear();
8888 }
8889
8890 void clear()
8891 {
8892 enabled = false;
8893 queryIntervalMs = 125000;
8894 subscriptionTimeoutMs = 0;
8895 }
8896 };
8897
8898 static void to_json(nlohmann::json& j, const IgmpSnooping& p)
8899 {
8900 j = nlohmann::json{
8901 TOJSON_IMPL(enabled),
8902 TOJSON_IMPL(queryIntervalMs),
8903 TOJSON_IMPL(subscriptionTimeoutMs)
8904 };
8905 }
8906 static void from_json(const nlohmann::json& j, IgmpSnooping& p)
8907 {
8908 p.clear();
8909 getOptional<bool>("enabled", p.enabled, j);
8910 getOptional<int>("queryIntervalMs", p.queryIntervalMs, j, 125000);
8911 getOptional<int>("subscriptionTimeoutMs", p.subscriptionTimeoutMs, j, 0);
8912 }
8913
8914
8915 //-----------------------------------------------------------
8916 JSON_SERIALIZED_CLASS(RallypointReflector)
8924 {
8925 IMPLEMENT_JSON_SERIALIZATION()
8926 IMPLEMENT_JSON_DOCUMENTATION(RallypointReflector)
8927
8928 public:
8930 typedef enum
8931 {
8933 drNone = 0,
8934
8936 drRxOnly = 1,
8937
8939 drTxOnly = 2
8940 } DirectionRestriction_t;
8941
8945 std::string id;
8946
8949
8952
8955
8957 std::vector<NetworkAddress> additionalTx;
8958
8961
8963 {
8964 clear();
8965 }
8966
8967 void clear()
8968 {
8969 id.clear();
8970 rx.clear();
8971 tx.clear();
8972 multicastInterfaceName.clear();
8973 additionalTx.clear();
8974 directionRestriction = drNone;
8975 }
8976 };
8977
8978 static void to_json(nlohmann::json& j, const RallypointReflector& p)
8979 {
8980 j = nlohmann::json{
8981 TOJSON_IMPL(id),
8982 TOJSON_IMPL(rx),
8983 TOJSON_IMPL(tx),
8984 TOJSON_IMPL(multicastInterfaceName),
8985 TOJSON_IMPL(additionalTx),
8986 TOJSON_IMPL(directionRestriction)
8987 };
8988 }
8989 static void from_json(const nlohmann::json& j, RallypointReflector& p)
8990 {
8991 p.clear();
8992 j.at("id").get_to(p.id);
8993 j.at("rx").get_to(p.rx);
8994 j.at("tx").get_to(p.tx);
8995 getOptional<std::string>("multicastInterfaceName", p.multicastInterfaceName, j);
8996 getOptional<std::vector<NetworkAddress>>("additionalTx", p.additionalTx, j);
8997 getOptional<RallypointReflector::DirectionRestriction_t>("directionRestriction", p.directionRestriction, j, RallypointReflector::DirectionRestriction_t::drNone);
8998 }
8999
9000
9001 //-----------------------------------------------------------
9002 JSON_SERIALIZED_CLASS(RallypointUdpStreamingIpvX)
9010 {
9011 IMPLEMENT_JSON_SERIALIZATION()
9012 IMPLEMENT_JSON_DOCUMENTATION(RallypointUdpStreamingIpvX)
9013
9014 public:
9017
9020
9022 {
9023 clear();
9024 }
9025
9026 void clear()
9027 {
9028 enabled = true;
9029 external.clear();
9030 }
9031 };
9032
9033 static void to_json(nlohmann::json& j, const RallypointUdpStreamingIpvX& p)
9034 {
9035 j = nlohmann::json{
9036 TOJSON_IMPL(enabled),
9037 TOJSON_IMPL(external)
9038 };
9039 }
9040 static void from_json(const nlohmann::json& j, RallypointUdpStreamingIpvX& p)
9041 {
9042 p.clear();
9043 getOptional<bool>("enabled", p.enabled, j, true);
9044 getOptional<NetworkAddress>("external", p.external, j);
9045 }
9046
9047 //-----------------------------------------------------------
9048 JSON_SERIALIZED_CLASS(RallypointUdpStreaming)
9056 {
9057 IMPLEMENT_JSON_SERIALIZATION()
9058 IMPLEMENT_JSON_DOCUMENTATION(RallypointUdpStreaming)
9059
9060 public:
9062 typedef enum
9063 {
9065 ctUnknown = 0,
9066
9068 ctSharedKeyAes256FullIv = 1,
9069
9071 ctSharedKeyAes256IdxIv = 2,
9072
9074 ctSharedKeyChaCha20FullIv = 3,
9075
9077 ctSharedKeyChaCha20IdxIv = 4
9078 } CryptoType_t;
9079
9082
9085
9088
9091
9094
9097
9100
9102 int ttl;
9103
9104
9106 {
9107 clear();
9108 }
9109
9110 void clear()
9111 {
9112 enabled = true;
9113 cryptoType = CryptoType_t::ctSharedKeyAes256FullIv;
9114 listenPort = 7444;
9115 ipv4.clear();
9116 ipv6.clear();
9117 keepaliveIntervalSecs = 15;
9118 priority = TxPriority_t::priVoice;
9119 ttl = 64;
9120 }
9121 };
9122
9123 static void to_json(nlohmann::json& j, const RallypointUdpStreaming& p)
9124 {
9125 j = nlohmann::json{
9126 TOJSON_IMPL(enabled),
9127 TOJSON_IMPL(cryptoType),
9128 TOJSON_IMPL(listenPort),
9129 TOJSON_IMPL(keepaliveIntervalSecs),
9130 TOJSON_IMPL(ipv4),
9131 TOJSON_IMPL(ipv6),
9132 TOJSON_IMPL(priority),
9133 TOJSON_IMPL(ttl)
9134 };
9135 }
9136 static void from_json(const nlohmann::json& j, RallypointUdpStreaming& p)
9137 {
9138 p.clear();
9139 getOptional<bool>("enabled", p.enabled, j, true);
9140 getOptional<RallypointUdpStreaming::CryptoType_t>("cryptoType", p.cryptoType, j, RallypointUdpStreaming::CryptoType_t::ctSharedKeyAes256FullIv);
9141 getOptional<int>("listenPort", p.listenPort, j, 7444);
9142 getOptional<int>("keepaliveIntervalSecs", p.keepaliveIntervalSecs, j, 15);
9143 getOptional<RallypointUdpStreamingIpvX>("ipv4", p.ipv4, j);
9144 getOptional<RallypointUdpStreamingIpvX>("ipv6", p.ipv6, j);
9145 getOptional<TxPriority_t>("priority", p.priority, j, TxPriority_t::priVoice);
9146 getOptional<int>("ttl", p.ttl, j, 64);
9147 }
9148
9149 //-----------------------------------------------------------
9150 JSON_SERIALIZED_CLASS(RallypointRpRtTimingBehavior)
9158 {
9159 IMPLEMENT_JSON_SERIALIZATION()
9160 IMPLEMENT_JSON_DOCUMENTATION(RallypointRpRtTimingBehavior)
9161
9162 public:
9164 typedef enum
9165 {
9168
9171
9174
9177
9179 btDrop = 99
9180 } BehaviorType_t;
9181
9184
9186 uint32_t atOrAboveMs;
9187
9189 std::string runCmd;
9190
9192 {
9193 clear();
9194 }
9195
9196 void clear()
9197 {
9198 behavior = btNone;
9199 atOrAboveMs = 0;
9200 runCmd.clear();
9201 }
9202 };
9203
9204 static void to_json(nlohmann::json& j, const RallypointRpRtTimingBehavior& p)
9205 {
9206 j = nlohmann::json{
9207 TOJSON_IMPL(behavior),
9208 TOJSON_IMPL(atOrAboveMs),
9209 TOJSON_IMPL(runCmd)
9210 };
9211 }
9212 static void from_json(const nlohmann::json& j, RallypointRpRtTimingBehavior& p)
9213 {
9214 p.clear();
9215 getOptional<RallypointRpRtTimingBehavior::BehaviorType_t>("behavior", p.behavior, j, RallypointRpRtTimingBehavior::BehaviorType_t::btNone);
9216 getOptional<uint32_t>("atOrAboveMs", p.atOrAboveMs, j, 0);
9217 getOptional<std::string>("runCmd", p.runCmd, j);
9218 }
9219
9220
9221 //-----------------------------------------------------------
9222 JSON_SERIALIZED_CLASS(RallypointWebsocketSettings)
9230 {
9231 IMPLEMENT_JSON_SERIALIZATION()
9232 IMPLEMENT_JSON_DOCUMENTATION(RallypointWebsocketSettings)
9233
9234 public:
9237
9240
9243
9246
9249
9251 {
9252 clear();
9253 }
9254
9255 void clear()
9256 {
9257 enabled = false;
9258 listenPort = 8443;
9259 certificate.clear();
9260 requireClientCertificate = false;
9261 requireTls = true;
9262 }
9263 };
9264
9265 static void to_json(nlohmann::json& j, const RallypointWebsocketSettings& p)
9266 {
9267 j = nlohmann::json{
9268 TOJSON_IMPL(enabled),
9269 TOJSON_IMPL(listenPort),
9270 TOJSON_IMPL(certificate),
9271 TOJSON_IMPL(requireClientCertificate),
9272 TOJSON_IMPL(requireTls)
9273 };
9274 }
9275 static void from_json(const nlohmann::json& j, RallypointWebsocketSettings& p)
9276 {
9277 p.clear();
9278 getOptional<bool>("enabled", p.enabled, j, false);
9279 getOptional<int>("listenPort", p.listenPort, j, 8443);
9280 getOptional<SecurityCertificate>("certificate", p.certificate, j);
9281 getOptional<bool>("requireClientCertificate", p.requireClientCertificate, j, false);
9282 getOptional<bool>("requireTls", p.requireTls, j, true);
9283 }
9284
9285
9286
9287 //-----------------------------------------------------------
9288 JSON_SERIALIZED_CLASS(RallypointAdvertisingSettings)
9296 {
9297 IMPLEMENT_JSON_SERIALIZATION()
9298 IMPLEMENT_JSON_DOCUMENTATION(RallypointAdvertisingSettings)
9299
9300 public:
9303
9305 std::string hostName;
9306
9308 std::string serviceName;
9309
9311 std::string interfaceName;
9312
9314 int port;
9315
9317 int ttl;
9318
9320 {
9321 clear();
9322 }
9323
9324 void clear()
9325 {
9326 enabled = false;
9327 hostName.clear();
9328 serviceName = "_rallypoint._tcp.local.";
9329 interfaceName.clear();
9330 port = 0;
9331 ttl = 60;
9332 }
9333 };
9334
9335 static void to_json(nlohmann::json& j, const RallypointAdvertisingSettings& p)
9336 {
9337 j = nlohmann::json{
9338 TOJSON_IMPL(enabled),
9339 TOJSON_IMPL(hostName),
9340 TOJSON_IMPL(serviceName),
9341 TOJSON_IMPL(interfaceName),
9342 TOJSON_IMPL(port),
9343 TOJSON_IMPL(ttl)
9344 };
9345 }
9346 static void from_json(const nlohmann::json& j, RallypointAdvertisingSettings& p)
9347 {
9348 p.clear();
9349 getOptional<bool>("enabled", p.enabled, j, false);
9350 getOptional<std::string>("hostName", p.hostName, j);
9351 getOptional<std::string>("serviceName", p.serviceName, j, "_rallypoint._tcp.local.");
9352 getOptional<std::string>("interfaceName", p.interfaceName, j);
9353
9354 getOptional<int>("port", p.port, j, 0);
9355 getOptional<int>("ttl", p.ttl, j, 60);
9356 }
9357
9358
9359
9360
9361 //-----------------------------------------------------------
9362 JSON_SERIALIZED_CLASS(NamedIdentity)
9370 {
9371 IMPLEMENT_JSON_SERIALIZATION()
9372 IMPLEMENT_JSON_DOCUMENTATION(NamedIdentity)
9373
9374 public:
9376 std::string name;
9377
9380
9382 {
9383 clear();
9384 }
9385
9386 void clear()
9387 {
9388 name.clear();
9389 certificate.clear();
9390 }
9391 };
9392
9393 static void to_json(nlohmann::json& j, const NamedIdentity& p)
9394 {
9395 j = nlohmann::json{
9396 TOJSON_IMPL(name),
9397 TOJSON_IMPL(certificate)
9398 };
9399 }
9400 static void from_json(const nlohmann::json& j, NamedIdentity& p)
9401 {
9402 p.clear();
9403 getOptional<std::string>("name", p.name, j);
9404 getOptional<SecurityCertificate>("certificate", p.certificate, j);
9405 }
9406
9407 //-----------------------------------------------------------
9408 JSON_SERIALIZED_CLASS(RallypointExtendedGroupRestriction)
9416 {
9417 IMPLEMENT_JSON_SERIALIZATION()
9418 IMPLEMENT_JSON_DOCUMENTATION(RallypointExtendedGroupRestriction)
9419
9420 public:
9422 std::string id;
9423
9425 std::vector<StringRestrictionList> restrictions;
9426
9428 {
9429 clear();
9430 }
9431
9432 void clear()
9433 {
9434 id.clear();
9435 restrictions.clear();
9436 }
9437 };
9438
9439 static void to_json(nlohmann::json& j, const RallypointExtendedGroupRestriction& p)
9440 {
9441 j = nlohmann::json{
9442 TOJSON_IMPL(id),
9443 TOJSON_IMPL(restrictions)
9444 };
9445 }
9446 static void from_json(const nlohmann::json& j, RallypointExtendedGroupRestriction& p)
9447 {
9448 p.clear();
9449 getOptional<std::string>("id", p.id, j);
9450 getOptional<std::vector<StringRestrictionList>>("restrictions", p.restrictions, j);
9451 }
9452
9453
9454 //-----------------------------------------------------------
9455 JSON_SERIALIZED_CLASS(RallypointServer)
9465 {
9466 IMPLEMENT_JSON_SERIALIZATION()
9467 IMPLEMENT_JSON_DOCUMENTATION(RallypointServer)
9468
9469 public:
9470 typedef enum
9471 {
9472 sptDefault = 0,
9473 sptCertificate = 1,
9474 sptCertPublicKey = 2,
9475 sptCertSubject = 3,
9476 sptCertIssuer = 4,
9477 sptCertFingerprint = 5,
9478 sptCertSerial = 6,
9479 sptSubjectC = 7,
9480 sptSubjectST = 8,
9481 sptSubjectL = 9,
9482 sptSubjectO = 10,
9483 sptSubjectOU = 11,
9484 sptSubjectCN = 12,
9485 sptIssuerC = 13,
9486 sptIssuerST = 14,
9487 sptIssuerL = 15,
9488 sptIssuerO = 16,
9489 sptIssuerOU = 17,
9490 sptIssuerCN = 18
9491 } StreamIdPrivacyType_t;
9492
9494 StreamIdPrivacyType_t streamIdPrivacyType;
9495
9498
9501
9503 std::string id;
9504
9506 std::string name;
9507
9510
9513
9515 std::string interfaceName;
9516
9519
9522
9525
9528
9531
9534
9537
9540
9543
9546
9549
9552
9555
9558
9561
9564
9566 PeeringConfiguration peeringConfiguration; // NOTE: This is NOT serialized
9567
9570
9573
9576
9579
9581 std::vector<RallypointReflector> staticReflectors;
9582
9585
9588
9591
9594
9597
9600
9602 std::vector<RallypointExtendedGroupRestriction> extendedGroupRestrictions;
9603
9606
9609
9612
9615
9617 uint32_t sysFlags;
9618
9621
9624
9627
9630
9633
9636
9639
9642
9644 std::vector<RallypointRpRtTimingBehavior> peerRtBehaviors;
9645
9648
9651
9654
9657
9660
9662 std::string domainName;
9663
9665 std::vector<std::string> allowedDomains;
9666
9668 std::vector<std::string> blockedDomains;
9669
9671 std::vector<std::string> extraDomains;
9672
9675
9677 std::vector<NamedIdentity> additionalIdentities;
9678
9680 {
9681 clear();
9682 }
9683
9684 void clear()
9685 {
9686 fipsCrypto.clear();
9687 watchdog.clear();
9688 id.clear();
9689 name.clear();
9690 listenPort = 7443;
9691 interfaceName.clear();
9692 certificate.clear();
9693 allowMulticastForwarding = false;
9694 peeringConfiguration.clear();
9695 peeringConfigurationFileName.clear();
9696 peeringConfigurationFileCommand.clear();
9697 peeringConfigurationFileCheckSecs = 60;
9698 ioPools = -1;
9699 statusReport.clear();
9700 limits.clear();
9701 linkGraph.clear();
9702 externalHealthCheckResponder.clear();
9703 allowPeerForwarding = false;
9704 multicastInterfaceName.clear();
9705 tls.clear();
9706 discovery.clear();
9707 forwardDiscoveredGroups = false;
9708 forwardMulticastAddressing = false;
9709 isMeshLeaf = false;
9710 disableMessageSigning = false;
9711 multicastRestrictions.clear();
9712 igmpSnooping.clear();
9713 staticReflectors.clear();
9714 tcpTxOptions.clear();
9715 multicastTxOptions.clear();
9716 certStoreFileName.clear();
9717 certStorePasswordHex.clear();
9718 groupRestrictions.clear();
9719 configurationCheckSignalName = "rts.7b392d1.${id}";
9720 licensing.clear();
9721 featureset.clear();
9722 udpStreaming.clear();
9723 sysFlags = 0;
9724 normalTaskQueueBias = 0;
9725 enableLeafReflectionReverseSubscription = false;
9726 disableLoopDetection = false;
9727 maxSecurityLevel = 0;
9728 routeMap.clear();
9729 streamStatsExport.clear();
9730 maxOutboundPeerConnectionIntervalDeltaSecs = 15;
9731 peerRtTestIntervalMs = 60000;
9732 peerRtBehaviors.clear();
9733 websocket.clear();
9734 nsm.clear();
9735 advertising.clear();
9736 extendedGroupRestrictions.clear();
9737 groupRestrictionAccessPolicyType = GroupRestrictionAccessPolicyType_t::graptPermissive;
9738 ipFamily = IpFamilyType_t::ifIp4;
9739 rxCapture.clear();
9740 txCapture.clear();
9741 domainName.clear();
9742 allowedDomains.clear();
9743 blockedDomains.clear();
9744 extraDomains.clear();
9745 tuning.clear();
9746 additionalIdentities.clear();
9747 streamIdPrivacyType = StreamIdPrivacyType_t::sptDefault;
9748 }
9749 };
9750
9751 static void to_json(nlohmann::json& j, const RallypointServer& p)
9752 {
9753 j = nlohmann::json{
9754 TOJSON_IMPL(fipsCrypto),
9755 TOJSON_IMPL(watchdog),
9756 TOJSON_IMPL(id),
9757 TOJSON_IMPL(name),
9758 TOJSON_IMPL(listenPort),
9759 TOJSON_IMPL(interfaceName),
9760 TOJSON_IMPL(certificate),
9761 TOJSON_IMPL(allowMulticastForwarding),
9762 // TOJSON_IMPL(peeringConfiguration), // NOTE: Not serialized!
9763 TOJSON_IMPL(peeringConfigurationFileName),
9764 TOJSON_IMPL(peeringConfigurationFileCommand),
9765 TOJSON_IMPL(peeringConfigurationFileCheckSecs),
9766 TOJSON_IMPL(ioPools),
9767 TOJSON_IMPL(statusReport),
9768 TOJSON_IMPL(limits),
9769 TOJSON_IMPL(linkGraph),
9770 TOJSON_IMPL(externalHealthCheckResponder),
9771 TOJSON_IMPL(allowPeerForwarding),
9772 TOJSON_IMPL(multicastInterfaceName),
9773 TOJSON_IMPL(tls),
9774 TOJSON_IMPL(discovery),
9775 TOJSON_IMPL(forwardDiscoveredGroups),
9776 TOJSON_IMPL(forwardMulticastAddressing),
9777 TOJSON_IMPL(isMeshLeaf),
9778 TOJSON_IMPL(disableMessageSigning),
9779 TOJSON_IMPL(multicastRestrictions),
9780 TOJSON_IMPL(igmpSnooping),
9781 TOJSON_IMPL(staticReflectors),
9782 TOJSON_IMPL(tcpTxOptions),
9783 TOJSON_IMPL(multicastTxOptions),
9784 TOJSON_IMPL(certStoreFileName),
9785 TOJSON_IMPL(certStorePasswordHex),
9786 TOJSON_IMPL(groupRestrictions),
9787 TOJSON_IMPL(configurationCheckSignalName),
9788 TOJSON_IMPL(featureset),
9789 TOJSON_IMPL(licensing),
9790 TOJSON_IMPL(udpStreaming),
9791 TOJSON_IMPL(sysFlags),
9792 TOJSON_IMPL(normalTaskQueueBias),
9793 TOJSON_IMPL(enableLeafReflectionReverseSubscription),
9794 TOJSON_IMPL(disableLoopDetection),
9795 TOJSON_IMPL(maxSecurityLevel),
9796 TOJSON_IMPL(routeMap),
9797 TOJSON_IMPL(streamStatsExport),
9798 TOJSON_IMPL(maxOutboundPeerConnectionIntervalDeltaSecs),
9799 TOJSON_IMPL(peerRtTestIntervalMs),
9800 TOJSON_IMPL(peerRtBehaviors),
9801 TOJSON_IMPL(websocket),
9802 TOJSON_IMPL(nsm),
9803 TOJSON_IMPL(advertising),
9804 TOJSON_IMPL(extendedGroupRestrictions),
9805 TOJSON_IMPL(groupRestrictionAccessPolicyType),
9806 TOJSON_IMPL(ipFamily),
9807 TOJSON_IMPL(rxCapture),
9808 TOJSON_IMPL(txCapture),
9809 TOJSON_IMPL(domainName),
9810 TOJSON_IMPL(allowedDomains),
9811 TOJSON_IMPL(blockedDomains),
9812 TOJSON_IMPL(extraDomains),
9813 TOJSON_IMPL(tuning),
9814 TOJSON_IMPL(additionalIdentities),
9815 TOJSON_IMPL(streamIdPrivacyType)
9816 };
9817 }
9818 static void from_json(const nlohmann::json& j, RallypointServer& p)
9819 {
9820 p.clear();
9821 getOptional<FipsCryptoSettings>("fipsCrypto", p.fipsCrypto, j);
9822 getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
9823 getOptional<std::string>("id", p.id, j);
9824 getOptional<std::string>("name", p.name, j);
9825 getOptional<SecurityCertificate>("certificate", p.certificate, j);
9826 getOptional<std::string>("interfaceName", p.interfaceName, j);
9827 getOptional<int>("listenPort", p.listenPort, j, 7443);
9828 getOptional<bool>("allowMulticastForwarding", p.allowMulticastForwarding, j, false);
9829 //getOptional<PeeringConfiguration>("peeringConfiguration", p.peeringConfiguration, j); // NOTE: Not serialized!
9830 getOptional<std::string>("peeringConfigurationFileName", p.peeringConfigurationFileName, j);
9831 getOptional<std::string>("peeringConfigurationFileCommand", p.peeringConfigurationFileCommand, j);
9832 getOptional<int>("peeringConfigurationFileCheckSecs", p.peeringConfigurationFileCheckSecs, j, 60);
9833 getOptional<int>("ioPools", p.ioPools, j, -1);
9834 getOptional<RallypointServerStatusReportConfiguration>("statusReport", p.statusReport, j);
9835 getOptional<RallypointServerLimits>("limits", p.limits, j);
9836 getOptional<RallypointServerLinkGraph>("linkGraph", p.linkGraph, j);
9837 getOptional<ExternalHealthCheckResponder>("externalHealthCheckResponder", p.externalHealthCheckResponder, j);
9838 getOptional<bool>("allowPeerForwarding", p.allowPeerForwarding, j, false);
9839 getOptional<std::string>("multicastInterfaceName", p.multicastInterfaceName, j);
9840 getOptional<Tls>("tls", p.tls, j);
9841 getOptional<DiscoveryConfiguration>("discovery", p.discovery, j);
9842 getOptional<bool>("forwardDiscoveredGroups", p.forwardDiscoveredGroups, j, false);
9843 getOptional<bool>("forwardMulticastAddressing", p.forwardMulticastAddressing, j, false);
9844 getOptional<bool>("isMeshLeaf", p.isMeshLeaf, j, false);
9845 getOptional<bool>("disableMessageSigning", p.disableMessageSigning, j, false);
9846 getOptional<NetworkAddressRestrictionList>("multicastRestrictions", p.multicastRestrictions, j);
9847 getOptional<IgmpSnooping>("igmpSnooping", p.igmpSnooping, j);
9848 getOptional<std::vector<RallypointReflector>>("staticReflectors", p.staticReflectors, j);
9849 getOptional<TcpNetworkTxOptions>("tcpTxOptions", p.tcpTxOptions, j);
9850 getOptional<NetworkTxOptions>("multicastTxOptions", p.multicastTxOptions, j);
9851 getOptional<std::string>("certStoreFileName", p.certStoreFileName, j);
9852 getOptional<std::string>("certStorePasswordHex", p.certStorePasswordHex, j);
9853 getOptional<StringRestrictionList>("groupRestrictions", p.groupRestrictions, j);
9854 getOptional<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.7b392d1.${id}");
9855 getOptional<Licensing>("licensing", p.licensing, j);
9856 getOptional<Featureset>("featureset", p.featureset, j);
9857 getOptional<RallypointUdpStreaming>("udpStreaming", p.udpStreaming, j);
9858 getOptional<uint32_t>("sysFlags", p.sysFlags, j, 0);
9859 getOptional<uint32_t>("normalTaskQueueBias", p.normalTaskQueueBias, j, 0);
9860 getOptional<bool>("enableLeafReflectionReverseSubscription", p.enableLeafReflectionReverseSubscription, j, false);
9861 getOptional<bool>("disableLoopDetection", p.disableLoopDetection, j, false);
9862 getOptional<uint32_t>("maxSecurityLevel", p.maxSecurityLevel, j, 0);
9863 getOptional<RallypointServerRouteMap>("routeMap", p.routeMap, j);
9864 getOptional<RallypointServerStreamStatsExport>("streamStatsExport", p.streamStatsExport, j);
9865 getOptional<uint32_t>("maxOutboundPeerConnectionIntervalDeltaSecs", p.maxOutboundPeerConnectionIntervalDeltaSecs, j, 15);
9866 getOptional<int>("peerRtTestIntervalMs", p.peerRtTestIntervalMs, j, 60000);
9867 getOptional<std::vector<RallypointRpRtTimingBehavior>>("peerRtBehaviors", p.peerRtBehaviors, j);
9868 getOptional<RallypointWebsocketSettings>("websocket", p.websocket, j);
9869 getOptional<NsmConfiguration>("nsm", p.nsm, j);
9870 getOptional<RallypointAdvertisingSettings>("advertising", p.advertising, j);
9871 getOptional<std::vector<RallypointExtendedGroupRestriction>>("extendedGroupRestrictions", p.extendedGroupRestrictions, j);
9872 getOptional<GroupRestrictionAccessPolicyType_t>("groupRestrictionAccessPolicyType", p.groupRestrictionAccessPolicyType, j, GroupRestrictionAccessPolicyType_t::graptPermissive);
9873 getOptional<IpFamilyType_t>("ipFamily", p.ipFamily, j, IpFamilyType_t::ifIp4);
9874 getOptional<PacketCapturer>("rxCapture", p.rxCapture, j);
9875 getOptional<PacketCapturer>("txCapture", p.txCapture, j);
9876 getOptional<std::string>("domainName", p.domainName, j);
9877 getOptional<std::vector<std::string>>("allowedDomains", p.allowedDomains, j);
9878 getOptional<std::vector<std::string>>("blockedDomains", p.blockedDomains, j);
9879 getOptional<std::vector<std::string>>("extraDomains", p.extraDomains, j);
9880 getOptional<TuningSettings>("tuning", p.tuning, j);
9881 getOptional<std::vector<NamedIdentity>>("additionalIdentities", p.additionalIdentities, j);
9882 getOptional<RallypointServer::StreamIdPrivacyType_t>("streamIdPrivacyType", p.streamIdPrivacyType, j, RallypointServer::StreamIdPrivacyType_t::sptDefault);
9883 }
9884
9885 //-----------------------------------------------------------
9886 JSON_SERIALIZED_CLASS(NsmNodeScripts)
9893 {
9894 IMPLEMENT_JSON_SERIALIZATION()
9895 IMPLEMENT_JSON_DOCUMENTATION(NsmNodeScripts)
9896
9897 public:
9898 std::string onIdle;
9899 std::string beforeGoingActive;
9900 std::string onGoingActive;
9901 std::string beforeActive;
9902 std::string onActive;
9903 std::string inDashboard;
9904 std::string onStatusReport;
9905
9907 {
9908 clear();
9909 }
9910
9911 void clear()
9912 {
9913 onIdle.clear();
9914 beforeGoingActive.clear();
9915 onGoingActive.clear();
9916 beforeActive.clear();
9917 onActive.clear();
9918 inDashboard.clear();
9919 onStatusReport.clear();
9920 }
9921 };
9922
9923 static void to_json(nlohmann::json& j, const NsmNodeScripts& p)
9924 {
9925 j = nlohmann::json{
9926 TOJSON_IMPL(onIdle),
9927 TOJSON_IMPL(beforeGoingActive),
9928 TOJSON_IMPL(onGoingActive),
9929 TOJSON_IMPL(beforeActive),
9930 TOJSON_IMPL(onActive),
9931 TOJSON_IMPL(inDashboard),
9932 TOJSON_IMPL(onStatusReport)
9933 };
9934 }
9935 static void from_json(const nlohmann::json& j, NsmNodeScripts& p)
9936 {
9937 p.clear();
9938 getOptional<std::string>("onIdle", p.onIdle, j);
9939 getOptional<std::string>("beforeGoingActive", p.beforeGoingActive, j);
9940 getOptional<std::string>("onGoingActive", p.onGoingActive, j);
9941 getOptional<std::string>("beforeActive", p.beforeActive, j);
9942 getOptional<std::string>("onActive", p.onActive, j);
9943 getOptional<std::string>("inDashboard", p.inDashboard, j);
9944 getOptional<std::string>("onStatusReport", p.onStatusReport, j);
9945 }
9946
9947 //-----------------------------------------------------------
9948 JSON_SERIALIZED_CLASS(NsmNodeLogging)
9955 {
9956 IMPLEMENT_JSON_SERIALIZATION()
9957 IMPLEMENT_JSON_DOCUMENTATION(NsmNodeLogging)
9958
9959 public:
9964 bool logCommandOutput;
9965 bool logResourceStates;
9966
9968 {
9969 clear();
9970 }
9971
9972 void clear()
9973 {
9974 level = 3;
9975 dashboard = false;
9976 logCommandOutput = false;
9977 logResourceStates = false;
9978 }
9979 };
9980
9981 static void to_json(nlohmann::json& j, const NsmNodeLogging& p)
9982 {
9983 j = nlohmann::json{
9984 TOJSON_IMPL(level),
9985 TOJSON_IMPL(dashboard),
9986 TOJSON_IMPL(logCommandOutput),
9987 TOJSON_IMPL(logResourceStates)
9988 };
9989 }
9990 static void from_json(const nlohmann::json& j, NsmNodeLogging& p)
9991 {
9992 p.clear();
9993 getOptional<int>("level", p.level, j, 3);
9994 getOptional<bool>("dashboard", p.dashboard, j, false);
9995 getOptional<bool>("logCommandOutput", p.logCommandOutput, j, false);
9996 getOptional<bool>("logResourceStates", p.logResourceStates, j, false);
9997 }
9998
9999 //-----------------------------------------------------------
10000 JSON_SERIALIZED_CLASS(NsmNodePeriodic)
10007 {
10008 IMPLEMENT_JSON_SERIALIZATION()
10009 IMPLEMENT_JSON_DOCUMENTATION(NsmNodePeriodic)
10010
10011 public:
10012 std::string id;
10013 int intervalSecs;
10014 std::string command;
10015
10017 {
10018 clear();
10019 }
10020
10021 void clear()
10022 {
10023 id.clear();
10024 intervalSecs = 1;
10025 command.clear();
10026 }
10027 };
10028
10029 static void to_json(nlohmann::json& j, const NsmNodePeriodic& p)
10030 {
10031 j = nlohmann::json{
10032 TOJSON_IMPL(id),
10033 TOJSON_IMPL(intervalSecs),
10034 TOJSON_IMPL(command)
10035 };
10036 }
10037 static void from_json(const nlohmann::json& j, NsmNodePeriodic& p)
10038 {
10039 p.clear();
10040 getOptional<std::string>("id", p.id, j);
10041 getOptional<int>("intervalSecs", p.intervalSecs, j, 1);
10042 getOptional<std::string>("command", p.command, j);
10043 }
10044
10045 //-----------------------------------------------------------
10046 JSON_SERIALIZED_CLASS(NsmNodeCotSettings)
10053 {
10054 IMPLEMENT_JSON_SERIALIZATION()
10055 IMPLEMENT_JSON_DOCUMENTATION(NsmNodeCotSettings)
10056
10057 public:
10058 bool useCot;
10059 std::string uid;
10060 std::string type;
10061 std::string how;
10062 std::string lat;
10063 std::string lon;
10064 std::string ce;
10065 std::string hae;
10066 std::string le;
10068 std::string detailJson;
10069
10071 {
10072 clear();
10073 }
10074
10075 void clear()
10076 {
10077 useCot = false;
10078 uid.clear();
10079 type.clear();
10080 how.clear();
10081 lat.clear();
10082 lon.clear();
10083 ce.clear();
10084 hae.clear();
10085 le.clear();
10086 detailJson.clear();
10087 }
10088 };
10089
10090 static void to_json(nlohmann::json& j, const NsmNodeCotSettings& p)
10091 {
10092 j = nlohmann::json{
10093 TOJSON_IMPL(useCot),
10094 TOJSON_IMPL(uid),
10095 TOJSON_IMPL(type),
10096 TOJSON_IMPL(how),
10097 TOJSON_IMPL(lat),
10098 TOJSON_IMPL(lon),
10099 TOJSON_IMPL(ce),
10100 TOJSON_IMPL(hae),
10101 TOJSON_IMPL(le),
10102 TOJSON_IMPL(detailJson)
10103 };
10104 }
10105 static void from_json(const nlohmann::json& j, NsmNodeCotSettings& p)
10106 {
10107 p.clear();
10108 getOptional<bool>("useCot", p.useCot, j, false);
10109 getOptional<std::string>("uid", p.uid, j);
10110 getOptional<std::string>("type", p.type, j);
10111 getOptional<std::string>("how", p.how, j);
10112 getOptional<std::string>("lat", p.lat, j);
10113 getOptional<std::string>("lon", p.lon, j);
10114 getOptional<std::string>("ce", p.ce, j);
10115 getOptional<std::string>("hae", p.hae, j);
10116 getOptional<std::string>("le", p.le, j);
10117 getOptional<std::string>("detailJson", p.detailJson, j);
10118 }
10119
10120 //-----------------------------------------------------------
10121 JSON_SERIALIZED_CLASS(NsmNodeStatusReportConfiguration)
10132 {
10133 IMPLEMENT_JSON_SERIALIZATION()
10134 IMPLEMENT_JSON_DOCUMENTATION(NsmNodeStatusReportConfiguration)
10135
10136 public:
10138 std::string fileName;
10139
10142
10145
10147 std::string runCmd;
10148
10151
10153 {
10154 clear();
10155 }
10156
10157 void clear()
10158 {
10159 fileName.clear();
10160 intervalSecs = 60;
10161 enabled = false;
10162 includeResourceDetail = false;
10163 runCmd.clear();
10164 }
10165 };
10166
10167 static void to_json(nlohmann::json& j, const NsmNodeStatusReportConfiguration& p)
10168 {
10169 j = nlohmann::json{
10170 TOJSON_IMPL(fileName),
10171 TOJSON_IMPL(intervalSecs),
10172 TOJSON_IMPL(enabled),
10173 TOJSON_IMPL(includeResourceDetail),
10174 TOJSON_IMPL(runCmd)
10175 };
10176 }
10177 static void from_json(const nlohmann::json& j, NsmNodeStatusReportConfiguration& p)
10178 {
10179 p.clear();
10180 getOptional<std::string>("fileName", p.fileName, j);
10181 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
10182 getOptional<bool>("enabled", p.enabled, j, false);
10183 getOptional<std::string>("runCmd", p.runCmd, j);
10184 getOptional<bool>("includeResourceDetail", p.includeResourceDetail, j, false);
10185 }
10186
10187 //-----------------------------------------------------------
10188 JSON_SERIALIZED_CLASS(NsmNode)
10198 {
10199 IMPLEMENT_JSON_SERIALIZATION()
10200 IMPLEMENT_JSON_DOCUMENTATION(NsmNode)
10201
10202 public:
10203
10206
10209
10211 std::string id;
10212
10214 std::string name;
10215
10217 std::string domainName;
10218
10221
10224
10227
10230
10233
10236
10239
10242
10245
10247 std::vector<NsmNodePeriodic> periodics;
10248
10251
10254
10257
10260
10263
10266
10269
10270 NsmNode()
10271 {
10272 clear();
10273 }
10274
10275 void clear()
10276 {
10277 fipsCrypto.clear();
10278 watchdog.clear();
10279 id.clear();
10280 name.clear();
10281 domainName.clear();
10282 multicastInterfaceName.clear();
10283 stateMachine.clear();
10284 defaultPriority = 0;
10285 fixedToken = -1;
10286 dashboardToken = false;
10287 scripts.clear();
10288 logging.clear();
10289 cot.clear();
10290 periodics.clear();
10291 statusReport.clear();
10292 configurationCheckSignalName = "rts.7b392d1.${id}";
10293 licensing.clear();
10294 featureset.clear();
10295 rxCapture.clear();
10296 txCapture.clear();
10297 tuning.clear();
10298 ipFamily = IpFamilyType_t::ifIp4;
10299 }
10300 };
10301
10302 static void to_json(nlohmann::json& j, const NsmNode& p)
10303 {
10304 j = nlohmann::json{
10305 TOJSON_IMPL(fipsCrypto),
10306 TOJSON_IMPL(watchdog),
10307 TOJSON_IMPL(id),
10308 TOJSON_IMPL(name),
10309 TOJSON_IMPL(domainName),
10310 TOJSON_IMPL(multicastInterfaceName),
10311 TOJSON_IMPL(stateMachine),
10312 TOJSON_IMPL(defaultPriority),
10313 TOJSON_IMPL(fixedToken),
10314 TOJSON_IMPL(dashboardToken),
10315 TOJSON_IMPL(scripts),
10316 TOJSON_IMPL(logging),
10317 TOJSON_IMPL(cot),
10318 TOJSON_IMPL(periodics),
10319 TOJSON_IMPL(statusReport),
10320 TOJSON_IMPL(configurationCheckSignalName),
10321 TOJSON_IMPL(featureset),
10322 TOJSON_IMPL(licensing),
10323 TOJSON_IMPL(ipFamily),
10324 TOJSON_IMPL(rxCapture),
10325 TOJSON_IMPL(txCapture),
10326 TOJSON_IMPL(tuning)
10327 };
10328 }
10329 static void from_json(const nlohmann::json& j, NsmNode& p)
10330 {
10331 p.clear();
10332 getOptional<FipsCryptoSettings>("fipsCrypto", p.fipsCrypto, j);
10333 getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
10334 getOptional<std::string>("id", p.id, j);
10335 getOptional<std::string>("name", p.name, j);
10336 getOptional<std::string>("domainName", p.domainName, j);
10337 getOptional<std::string>("multicastInterfaceName", p.multicastInterfaceName, j);
10338 getOptional<NsmConfiguration>("stateMachine", p.stateMachine, j);
10339 getOptional<int>("defaultPriority", p.defaultPriority, j, 0);
10340 getOptional<int>("fixedToken", p.fixedToken, j, -1);
10341 getOptional<bool>("dashboardToken", p.dashboardToken, j, false);
10342 getOptional<NsmNodeScripts>("scripts", p.scripts, j);
10343 getOptional<NsmNodeLogging>("logging", p.logging, j);
10344 getOptional<NsmNodeCotSettings>("cot", p.cot, j);
10345 getOptional<std::vector<NsmNodePeriodic>>("periodics", p.periodics, j);
10346 getOptional<NsmNodeStatusReportConfiguration>("statusReport", p.statusReport, j);
10347 getOptional<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.7b392d1.${id}");
10348 getOptional<Licensing>("licensing", p.licensing, j);
10349 getOptional<Featureset>("featureset", p.featureset, j);
10350 getOptional<PacketCapturer>("rxCapture", p.rxCapture, j);
10351 getOptional<PacketCapturer>("txCapture", p.txCapture, j);
10352 getOptional<TuningSettings>("tuning", p.tuning, j);
10353 getOptional<IpFamilyType_t>("ipFamily", p.ipFamily, j, IpFamilyType_t::ifIp4);
10354 }
10355 //-----------------------------------------------------------
10356 JSON_SERIALIZED_CLASS(PlatformDiscoveredService)
10367 {
10368 IMPLEMENT_JSON_SERIALIZATION()
10369 IMPLEMENT_JSON_DOCUMENTATION(PlatformDiscoveredService)
10370
10371 public:
10372
10374 std::string id;
10375
10377 std::string type;
10378
10380 std::string name;
10381
10384
10386 std::string uri;
10387
10390
10392 {
10393 clear();
10394 }
10395
10396 void clear()
10397 {
10398 id.clear();
10399 type.clear();
10400 name.clear();
10401 address.clear();
10402 uri.clear();
10403 configurationVersion = 0;
10404 }
10405 };
10406
10407 static void to_json(nlohmann::json& j, const PlatformDiscoveredService& p)
10408 {
10409 j = nlohmann::json{
10410 TOJSON_IMPL(id),
10411 TOJSON_IMPL(type),
10412 TOJSON_IMPL(name),
10413 TOJSON_IMPL(address),
10414 TOJSON_IMPL(uri),
10415 TOJSON_IMPL(configurationVersion)
10416 };
10417 }
10418 static void from_json(const nlohmann::json& j, PlatformDiscoveredService& p)
10419 {
10420 p.clear();
10421 getOptional<std::string>("id", p.id, j);
10422 getOptional<std::string>("type", p.type, j);
10423 getOptional<std::string>("name", p.name, j);
10424 getOptional<NetworkAddress>("address", p.address, j);
10425 getOptional<std::string>("uri", p.uri, j);
10426 getOptional<uint32_t>("configurationVersion", p.configurationVersion, j, 0);
10427 }
10428
10429
10430 //-----------------------------------------------------------
10432 {
10433 public:
10434 typedef enum
10435 {
10436 etUndefined = 0,
10437 etAudio = 1,
10438 etLocation = 2,
10439 etUser = 3
10440 } EventType_t;
10441
10442 typedef enum
10443 {
10444 dNone = 0,
10445 dInbound = 1,
10446 dOutbound = 2,
10447 dBoth = 3,
10448 dUndefined = 4,
10449 } Direction_t;
10450 };
10451
10452
10453 //-----------------------------------------------------------
10454 JSON_SERIALIZED_CLASS(TimelineQueryParameters)
10465 {
10466 IMPLEMENT_JSON_SERIALIZATION()
10467 IMPLEMENT_JSON_DOCUMENTATION(TimelineQueryParameters)
10468
10469 public:
10470
10473
10476
10479
10482
10485
10488
10491
10493 std::string onlyAlias;
10494
10496 std::string onlyNodeId;
10497
10500
10502 std::string sql;
10503
10505 {
10506 clear();
10507 }
10508
10509 void clear()
10510 {
10511 maxCount = 50;
10512 mostRecentFirst = true;
10513 startedOnOrAfter = 0;
10514 endedOnOrBefore = 0;
10515 onlyDirection = 0;
10516 onlyType = 0;
10517 onlyCommitted = true;
10518 onlyAlias.clear();
10519 onlyNodeId.clear();
10520 sql.clear();
10521 onlyTxId = 0;
10522 }
10523 };
10524
10525 static void to_json(nlohmann::json& j, const TimelineQueryParameters& p)
10526 {
10527 j = nlohmann::json{
10528 TOJSON_IMPL(maxCount),
10529 TOJSON_IMPL(mostRecentFirst),
10530 TOJSON_IMPL(startedOnOrAfter),
10531 TOJSON_IMPL(endedOnOrBefore),
10532 TOJSON_IMPL(onlyDirection),
10533 TOJSON_IMPL(onlyType),
10534 TOJSON_IMPL(onlyCommitted),
10535 TOJSON_IMPL(onlyAlias),
10536 TOJSON_IMPL(onlyNodeId),
10537 TOJSON_IMPL(onlyTxId),
10538 TOJSON_IMPL(sql)
10539 };
10540 }
10541 static void from_json(const nlohmann::json& j, TimelineQueryParameters& p)
10542 {
10543 p.clear();
10544 getOptional<long>("maxCount", p.maxCount, j, 50);
10545 getOptional<bool>("mostRecentFirst", p.mostRecentFirst, j, false);
10546 getOptional<uint64_t>("startedOnOrAfter", p.startedOnOrAfter, j, 0);
10547 getOptional<uint64_t>("endedOnOrBefore", p.endedOnOrBefore, j, 0);
10548 getOptional<int>("onlyDirection", p.onlyDirection, j, 0);
10549 getOptional<int>("onlyType", p.onlyType, j, 0);
10550 getOptional<bool>("onlyCommitted", p.onlyCommitted, j, true);
10551 getOptional<std::string>("onlyAlias", p.onlyAlias, j, EMPTY_STRING);
10552 getOptional<std::string>("onlyNodeId", p.onlyNodeId, j, EMPTY_STRING);
10553 getOptional<int>("onlyTxId", p.onlyTxId, j, 0);
10554 getOptional<std::string>("sql", p.sql, j, EMPTY_STRING);
10555 }
10556
10557 //-----------------------------------------------------------
10558 JSON_SERIALIZED_CLASS(CertStoreCertificate)
10566 {
10567 IMPLEMENT_JSON_SERIALIZATION()
10568 IMPLEMENT_JSON_DOCUMENTATION(CertStoreCertificate)
10569
10570 public:
10572 std::string id;
10573
10575 std::string certificatePem;
10576
10578 std::string privateKeyPem;
10579
10582
10584 std::string tags;
10585
10587 {
10588 clear();
10589 }
10590
10591 void clear()
10592 {
10593 id.clear();
10594 certificatePem.clear();
10595 privateKeyPem.clear();
10596 internalData = nullptr;
10597 tags.clear();
10598 }
10599 };
10600
10601 static void to_json(nlohmann::json& j, const CertStoreCertificate& p)
10602 {
10603 j = nlohmann::json{
10604 TOJSON_IMPL(id),
10605 TOJSON_IMPL(certificatePem),
10606 TOJSON_IMPL(privateKeyPem),
10607 TOJSON_IMPL(tags)
10608 };
10609 }
10610 static void from_json(const nlohmann::json& j, CertStoreCertificate& p)
10611 {
10612 p.clear();
10613 j.at("id").get_to(p.id);
10614 j.at("certificatePem").get_to(p.certificatePem);
10615 getOptional<std::string>("privateKeyPem", p.privateKeyPem, j, EMPTY_STRING);
10616 getOptional<std::string>("tags", p.tags, j, EMPTY_STRING);
10617 }
10618
10619 //-----------------------------------------------------------
10620 JSON_SERIALIZED_CLASS(CertStore)
10628 {
10629 IMPLEMENT_JSON_SERIALIZATION()
10630 IMPLEMENT_JSON_DOCUMENTATION(CertStore)
10631
10632 public:
10634 std::string id;
10635
10637 std::vector<CertStoreCertificate> certificates;
10638
10640 std::vector<KvPair> kvp;
10641
10642 CertStore()
10643 {
10644 clear();
10645 }
10646
10647 void clear()
10648 {
10649 id.clear();
10650 certificates.clear();
10651 kvp.clear();
10652 }
10653 };
10654
10655 static void to_json(nlohmann::json& j, const CertStore& p)
10656 {
10657 j = nlohmann::json{
10658 TOJSON_IMPL(id),
10659 TOJSON_IMPL(certificates),
10660 TOJSON_IMPL(kvp)
10661 };
10662 }
10663 static void from_json(const nlohmann::json& j, CertStore& p)
10664 {
10665 p.clear();
10666 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
10667 getOptional<std::vector<CertStoreCertificate>>("certificates", p.certificates, j);
10668 getOptional<std::vector<KvPair>>("kvp", p.kvp, j);
10669 }
10670
10671 //-----------------------------------------------------------
10672 JSON_SERIALIZED_CLASS(CertStoreCertificateElement)
10680 {
10681 IMPLEMENT_JSON_SERIALIZATION()
10682 IMPLEMENT_JSON_DOCUMENTATION(CertStoreCertificateElement)
10683
10684 public:
10686 std::string id;
10687
10690
10692 std::string certificatePem;
10693
10695 std::string tags;
10696
10698 {
10699 clear();
10700 }
10701
10702 void clear()
10703 {
10704 id.clear();
10705 hasPrivateKey = false;
10706 tags.clear();
10707 }
10708 };
10709
10710 static void to_json(nlohmann::json& j, const CertStoreCertificateElement& p)
10711 {
10712 j = nlohmann::json{
10713 TOJSON_IMPL(id),
10714 TOJSON_IMPL(hasPrivateKey),
10715 TOJSON_IMPL(tags)
10716 };
10717
10718 if(!p.certificatePem.empty())
10719 {
10720 j["certificatePem"] = p.certificatePem;
10721 }
10722 }
10723 static void from_json(const nlohmann::json& j, CertStoreCertificateElement& p)
10724 {
10725 p.clear();
10726 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
10727 getOptional<bool>("hasPrivateKey", p.hasPrivateKey, j, false);
10728 getOptional<std::string>("certificatePem", p.certificatePem, j, EMPTY_STRING);
10729 getOptional<std::string>("tags", p.tags, j, EMPTY_STRING);
10730 }
10731
10732 //-----------------------------------------------------------
10733 JSON_SERIALIZED_CLASS(CertStoreDescriptor)
10741 {
10742 IMPLEMENT_JSON_SERIALIZATION()
10743 IMPLEMENT_JSON_DOCUMENTATION(CertStoreDescriptor)
10744
10745 public:
10747 std::string id;
10748
10750 std::string fileName;
10751
10754
10757
10759 std::vector<CertStoreCertificateElement> certificates;
10760
10762 std::vector<KvPair> kvp;
10763
10765 {
10766 clear();
10767 }
10768
10769 void clear()
10770 {
10771 id.clear();
10772 fileName.clear();
10773 version = 0;
10774 flags = 0;
10775 certificates.clear();
10776 kvp.clear();
10777 }
10778 };
10779
10780 static void to_json(nlohmann::json& j, const CertStoreDescriptor& p)
10781 {
10782 j = nlohmann::json{
10783 TOJSON_IMPL(id),
10784 TOJSON_IMPL(fileName),
10785 TOJSON_IMPL(version),
10786 TOJSON_IMPL(flags),
10787 TOJSON_IMPL(certificates),
10788 TOJSON_IMPL(kvp)
10789 };
10790 }
10791 static void from_json(const nlohmann::json& j, CertStoreDescriptor& p)
10792 {
10793 p.clear();
10794 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
10795 getOptional<std::string>("fileName", p.fileName, j, EMPTY_STRING);
10796 getOptional<int>("version", p.version, j, 0);
10797 getOptional<int>("flags", p.flags, j, 0);
10798 getOptional<std::vector<CertStoreCertificateElement>>("certificates", p.certificates, j);
10799 getOptional<std::vector<KvPair>>("kvp", p.kvp, j);
10800 }
10801
10802 //-----------------------------------------------------------
10803 JSON_SERIALIZED_CLASS(CertificateSubjectElement)
10811 {
10812 IMPLEMENT_JSON_SERIALIZATION()
10813 IMPLEMENT_JSON_DOCUMENTATION(CertificateSubjectElement)
10814
10815 public:
10817 std::string name;
10818
10820 std::string value;
10821
10823 {
10824 clear();
10825 }
10826
10827 void clear()
10828 {
10829 name.clear();
10830 value.clear();
10831 }
10832 };
10833
10834 static void to_json(nlohmann::json& j, const CertificateSubjectElement& p)
10835 {
10836 j = nlohmann::json{
10837 TOJSON_IMPL(name),
10838 TOJSON_IMPL(value)
10839 };
10840 }
10841 static void from_json(const nlohmann::json& j, CertificateSubjectElement& p)
10842 {
10843 p.clear();
10844 getOptional<std::string>("name", p.name, j, EMPTY_STRING);
10845 getOptional<std::string>("value", p.value, j, EMPTY_STRING);
10846 }
10847
10848
10849 //-----------------------------------------------------------
10850 JSON_SERIALIZED_CLASS(CertificateDescriptor)
10858 {
10859 IMPLEMENT_JSON_SERIALIZATION()
10860 IMPLEMENT_JSON_DOCUMENTATION(CertificateDescriptor)
10861
10862 public:
10864 std::string subject;
10865
10867 std::string issuer;
10868
10871
10874
10876 std::string notBefore;
10877
10879 std::string notAfter;
10880
10882 std::string serial;
10883
10885 std::string fingerprint;
10886
10888 std::vector<CertificateSubjectElement> subjectElements;
10889
10891 std::vector<CertificateSubjectElement> issuerElements;
10892
10894 std::string certificatePem;
10895
10897 std::string publicKeyPem;
10898
10900 {
10901 clear();
10902 }
10903
10904 void clear()
10905 {
10906 subject.clear();
10907 issuer.clear();
10908 selfSigned = false;
10909 version = 0;
10910 notBefore.clear();
10911 notAfter.clear();
10912 serial.clear();
10913 fingerprint.clear();
10914 subjectElements.clear();
10915 issuerElements.clear();
10916 certificatePem.clear();
10917 publicKeyPem.clear();
10918 }
10919 };
10920
10921 static void to_json(nlohmann::json& j, const CertificateDescriptor& p)
10922 {
10923 j = nlohmann::json{
10924 TOJSON_IMPL(subject),
10925 TOJSON_IMPL(issuer),
10926 TOJSON_IMPL(selfSigned),
10927 TOJSON_IMPL(version),
10928 TOJSON_IMPL(notBefore),
10929 TOJSON_IMPL(notAfter),
10930 TOJSON_IMPL(serial),
10931 TOJSON_IMPL(fingerprint),
10932 TOJSON_IMPL(subjectElements),
10933 TOJSON_IMPL(issuerElements),
10934 TOJSON_IMPL(certificatePem),
10935 TOJSON_IMPL(publicKeyPem)
10936 };
10937 }
10938 static void from_json(const nlohmann::json& j, CertificateDescriptor& p)
10939 {
10940 p.clear();
10941 getOptional<std::string>("subject", p.subject, j, EMPTY_STRING);
10942 getOptional<std::string>("issuer", p.issuer, j, EMPTY_STRING);
10943 getOptional<bool>("selfSigned", p.selfSigned, j, false);
10944 getOptional<int>("version", p.version, j, 0);
10945 getOptional<std::string>("notBefore", p.notBefore, j, EMPTY_STRING);
10946 getOptional<std::string>("notAfter", p.notAfter, j, EMPTY_STRING);
10947 getOptional<std::string>("serial", p.serial, j, EMPTY_STRING);
10948 getOptional<std::string>("fingerprint", p.fingerprint, j, EMPTY_STRING);
10949 getOptional<std::string>("certificatePem", p.certificatePem, j, EMPTY_STRING);
10950 getOptional<std::string>("publicKeyPem", p.publicKeyPem, j, EMPTY_STRING);
10951 getOptional<std::vector<CertificateSubjectElement>>("subjectElements", p.subjectElements, j);
10952 getOptional<std::vector<CertificateSubjectElement>>("issuerElements", p.issuerElements, j);
10953 }
10954
10955
10956 //-----------------------------------------------------------
10957 JSON_SERIALIZED_CLASS(RiffDescriptor)
10968 {
10969 IMPLEMENT_JSON_SERIALIZATION()
10970 IMPLEMENT_JSON_DOCUMENTATION(RiffDescriptor)
10971
10972 public:
10974 std::string file;
10975
10978
10981
10984
10986 std::string meta;
10987
10989 std::string certPem;
10990
10993
10995 std::string signature;
10996
10998 {
10999 clear();
11000 }
11001
11002 void clear()
11003 {
11004 file.clear();
11005 verified = false;
11006 channels = 0;
11007 sampleCount = 0;
11008 meta.clear();
11009 certPem.clear();
11010 certDescriptor.clear();
11011 signature.clear();
11012 }
11013 };
11014
11015 static void to_json(nlohmann::json& j, const RiffDescriptor& p)
11016 {
11017 j = nlohmann::json{
11018 TOJSON_IMPL(file),
11019 TOJSON_IMPL(verified),
11020 TOJSON_IMPL(channels),
11021 TOJSON_IMPL(sampleCount),
11022 TOJSON_IMPL(meta),
11023 TOJSON_IMPL(certPem),
11024 TOJSON_IMPL(certDescriptor),
11025 TOJSON_IMPL(signature)
11026 };
11027 }
11028
11029 static void from_json(const nlohmann::json& j, RiffDescriptor& p)
11030 {
11031 p.clear();
11032 FROMJSON_IMPL(file, std::string, EMPTY_STRING);
11033 FROMJSON_IMPL(verified, bool, false);
11034 FROMJSON_IMPL(channels, int, 0);
11035 FROMJSON_IMPL(sampleCount, int, 0);
11036 FROMJSON_IMPL(meta, std::string, EMPTY_STRING);
11037 FROMJSON_IMPL(certPem, std::string, EMPTY_STRING);
11038 getOptional<CertificateDescriptor>("certDescriptor", p.certDescriptor, j);
11039 FROMJSON_IMPL(signature, std::string, EMPTY_STRING);
11040 }
11041
11042
11043 //-----------------------------------------------------------
11044 JSON_SERIALIZED_CLASS(BridgeCreationDetail)
11052 {
11053 IMPLEMENT_JSON_SERIALIZATION()
11054 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(BridgeCreationDetail)
11055 IMPLEMENT_JSON_DOCUMENTATION(BridgeCreationDetail)
11056
11057 public:
11059 typedef enum
11060 {
11062 csUndefined = 0,
11063
11065 csOk = 1,
11066
11068 csNoJson = -1,
11069
11071 csAlreadyExists = -3,
11072
11074 csInvalidConfiguration = -4,
11075
11077 csInvalidJson = -5,
11078
11080 csInsufficientGroups = -6,
11081
11083 csTooManyGroups = -7,
11084
11086 csDuplicateGroup = -8,
11087
11089 csLocalLoopDetected = -9,
11090 } CreationStatus_t;
11091
11093 std::string id;
11094
11097
11099 {
11100 clear();
11101 }
11102
11103 void clear()
11104 {
11105 id.clear();
11106 status = csUndefined;
11107 }
11108 };
11109
11110 static void to_json(nlohmann::json& j, const BridgeCreationDetail& p)
11111 {
11112 j = nlohmann::json{
11113 TOJSON_IMPL(id),
11114 TOJSON_IMPL(status)
11115 };
11116 }
11117 static void from_json(const nlohmann::json& j, BridgeCreationDetail& p)
11118 {
11119 p.clear();
11120 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
11121 getOptional<BridgeCreationDetail::CreationStatus_t>("status", p.status, j, BridgeCreationDetail::CreationStatus_t::csUndefined);
11122 }
11123 //-----------------------------------------------------------
11124 JSON_SERIALIZED_CLASS(GroupConnectionDetail)
11132 {
11133 IMPLEMENT_JSON_SERIALIZATION()
11134 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(GroupConnectionDetail)
11135 IMPLEMENT_JSON_DOCUMENTATION(GroupConnectionDetail)
11136
11137 public:
11139 typedef enum
11140 {
11142 ctUndefined = 0,
11143
11145 ctDirectDatagram = 1,
11146
11148 ctRallypoint = 2
11149 } ConnectionType_t;
11150
11152 std::string id;
11153
11156
11158 std::string peer;
11159
11162
11164 std::string reason;
11165
11167 {
11168 clear();
11169 }
11170
11171 void clear()
11172 {
11173 id.clear();
11174 connectionType = ctUndefined;
11175 peer.clear();
11176 asFailover = false;
11177 reason.clear();
11178 }
11179 };
11180
11181 static void to_json(nlohmann::json& j, const GroupConnectionDetail& p)
11182 {
11183 j = nlohmann::json{
11184 TOJSON_IMPL(id),
11185 TOJSON_IMPL(connectionType),
11186 TOJSON_IMPL(peer),
11187 TOJSON_IMPL(asFailover),
11188 TOJSON_IMPL(reason)
11189 };
11190
11191 if(p.asFailover)
11192 {
11193 j["asFailover"] = p.asFailover;
11194 }
11195 }
11196 static void from_json(const nlohmann::json& j, GroupConnectionDetail& p)
11197 {
11198 p.clear();
11199 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
11200 getOptional<GroupConnectionDetail::ConnectionType_t>("connectionType", p.connectionType, j, GroupConnectionDetail::ConnectionType_t::ctUndefined);
11201 getOptional<std::string>("peer", p.peer, j, EMPTY_STRING);
11202 getOptional<bool>("asFailover", p.asFailover, j, false);
11203 getOptional<std::string>("reason", p.reason, j, EMPTY_STRING);
11204 }
11205
11206 //-----------------------------------------------------------
11207 JSON_SERIALIZED_CLASS(GroupTxDetail)
11215 {
11216 IMPLEMENT_JSON_SERIALIZATION()
11217 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(GroupTxDetail)
11218 IMPLEMENT_JSON_DOCUMENTATION(GroupTxDetail)
11219
11220 public:
11222 typedef enum
11223 {
11225 txsUndefined = 0,
11226
11228 txsTxStarted = 1,
11229
11231 txsTxEnded = 2,
11232
11234 txsNotAnAudioGroup = -1,
11235
11237 txsNotJoined = -2,
11238
11240 txsNotConnected = -3,
11241
11243 txsAlreadyTransmitting = -4,
11244
11246 txsInvalidParams = -5,
11247
11249 txsPriorityTooLow = -6,
11250
11252 txsRxActiveOnNonFdx = -7,
11253
11255 txsCannotSubscribeToInput = -8,
11256
11258 txsInvalidId = -9,
11259
11261 txsTxEndedWithFailure = -10,
11262
11264 txsBridgedButNotMultistream = -11,
11265
11267 txsAutoEndedDueToNonMultistreamBridge = -12,
11268
11270 txsReBeginWithoutPriorBegin = -13
11271 } TxStatus_t;
11272
11274 std::string id;
11275
11278
11281
11284
11287
11289 uint32_t txId;
11290
11292 {
11293 clear();
11294 }
11295
11296 void clear()
11297 {
11298 id.clear();
11299 status = txsUndefined;
11300 localPriority = 0;
11301 remotePriority = 0;
11302 nonFdxMsHangRemaining = 0;
11303 txId = 0;
11304 }
11305 };
11306
11307 static void to_json(nlohmann::json& j, const GroupTxDetail& p)
11308 {
11309 j = nlohmann::json{
11310 TOJSON_IMPL(id),
11311 TOJSON_IMPL(status),
11312 TOJSON_IMPL(localPriority),
11313 TOJSON_IMPL(txId)
11314 };
11315
11316 // Include remote priority if status is related to that
11317 if(p.status == GroupTxDetail::TxStatus_t::txsPriorityTooLow)
11318 {
11319 j["remotePriority"] = p.remotePriority;
11320 }
11321 else if(p.status == GroupTxDetail::TxStatus_t::txsRxActiveOnNonFdx)
11322 {
11323 j["nonFdxMsHangRemaining"] = p.nonFdxMsHangRemaining;
11324 }
11325 }
11326 static void from_json(const nlohmann::json& j, GroupTxDetail& p)
11327 {
11328 p.clear();
11329 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
11330 getOptional<GroupTxDetail::TxStatus_t>("status", p.status, j, GroupTxDetail::TxStatus_t::txsUndefined);
11331 getOptional<int>("localPriority", p.localPriority, j, 0);
11332 getOptional<int>("remotePriority", p.remotePriority, j, 0);
11333 getOptional<long>("nonFdxMsHangRemaining", p.nonFdxMsHangRemaining, j, 0);
11334 getOptional<uint32_t>("txId", p.txId, j, 0);
11335 }
11336
11337 //-----------------------------------------------------------
11338 JSON_SERIALIZED_CLASS(GroupCreationDetail)
11346 {
11347 IMPLEMENT_JSON_SERIALIZATION()
11348 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(GroupCreationDetail)
11349 IMPLEMENT_JSON_DOCUMENTATION(GroupCreationDetail)
11350
11351 public:
11353 typedef enum
11354 {
11356 csUndefined = 0,
11357
11359 csOk = 1,
11360
11362 csNoJson = -1,
11363
11365 csConflictingRpListAndCluster = -2,
11366
11368 csAlreadyExists = -3,
11369
11371 csInvalidConfiguration = -4,
11372
11374 csInvalidJson = -5,
11375
11377 csCryptoFailure = -6,
11378
11380 csAudioInputFailure = -7,
11381
11383 csAudioOutputFailure = -8,
11384
11386 csUnsupportedAudioEncoder = -9,
11387
11389 csNoLicense = -10,
11390
11392 csInvalidTransport = -11,
11393
11395 csAudioInputDeviceNotFound = -12,
11396
11398 csAudioOutputDeviceNotFound = -13
11399 } CreationStatus_t;
11400
11402 std::string id;
11403
11406
11408 {
11409 clear();
11410 }
11411
11412 void clear()
11413 {
11414 id.clear();
11415 status = csUndefined;
11416 }
11417 };
11418
11419 static void to_json(nlohmann::json& j, const GroupCreationDetail& p)
11420 {
11421 j = nlohmann::json{
11422 TOJSON_IMPL(id),
11423 TOJSON_IMPL(status)
11424 };
11425 }
11426 static void from_json(const nlohmann::json& j, GroupCreationDetail& p)
11427 {
11428 p.clear();
11429 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
11430 getOptional<GroupCreationDetail::CreationStatus_t>("status", p.status, j, GroupCreationDetail::CreationStatus_t::csUndefined);
11431 }
11432
11433
11434 //-----------------------------------------------------------
11435 JSON_SERIALIZED_CLASS(GroupReconfigurationDetail)
11443 {
11444 IMPLEMENT_JSON_SERIALIZATION()
11445 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(GroupReconfigurationDetail)
11446 IMPLEMENT_JSON_DOCUMENTATION(GroupReconfigurationDetail)
11447
11448 public:
11450 typedef enum
11451 {
11453 rsUndefined = 0,
11454
11456 rsOk = 1,
11457
11459 rsNoJson = -1,
11460
11462 rsInvalidConfiguration = -2,
11463
11465 rsInvalidJson = -3,
11466
11468 rsAudioInputFailure = -4,
11469
11471 rsAudioOutputFailure = -5,
11472
11474 rsDoesNotExist = -6,
11475
11477 rsAudioInputInUse = -7,
11478
11480 rsAudioDisabledForGroup = -8,
11481
11483 rsGroupIsNotAudio = -9
11484 } ReconfigurationStatus_t;
11485
11487 std::string id;
11488
11491
11493 {
11494 clear();
11495 }
11496
11497 void clear()
11498 {
11499 id.clear();
11500 status = rsUndefined;
11501 }
11502 };
11503
11504 static void to_json(nlohmann::json& j, const GroupReconfigurationDetail& p)
11505 {
11506 j = nlohmann::json{
11507 TOJSON_IMPL(id),
11508 TOJSON_IMPL(status)
11509 };
11510 }
11511 static void from_json(const nlohmann::json& j, GroupReconfigurationDetail& p)
11512 {
11513 p.clear();
11514 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
11515 getOptional<GroupReconfigurationDetail::ReconfigurationStatus_t>("status", p.status, j, GroupReconfigurationDetail::ReconfigurationStatus_t::rsUndefined);
11516 }
11517
11518
11519 //-----------------------------------------------------------
11520 JSON_SERIALIZED_CLASS(GroupHealthReport)
11528 {
11529 IMPLEMENT_JSON_SERIALIZATION()
11530 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(GroupHealthReport)
11531 IMPLEMENT_JSON_DOCUMENTATION(GroupHealthReport)
11532
11533 public:
11534 std::string id;
11535 uint64_t lastErrorTs;
11536 uint64_t decryptionErrors;
11537 uint64_t encryptionErrors;
11538 uint64_t unsupportDecoderErrors;
11539 uint64_t decoderFailures;
11540 uint64_t decoderStartFailures;
11541 uint64_t inboundRtpPacketAllocationFailures;
11542 uint64_t inboundRtpPacketLoadFailures;
11543 uint64_t latePacketsDiscarded;
11544 uint64_t jitterBufferInsertionFailures;
11545 uint64_t presenceDeserializationFailures;
11546 uint64_t notRtpErrors;
11547 uint64_t generalErrors;
11548 uint64_t inboundRtpProcessorAllocationFailures;
11549
11551 {
11552 clear();
11553 }
11554
11555 void clear()
11556 {
11557 id.clear();
11558 lastErrorTs = 0;
11559 decryptionErrors = 0;
11560 encryptionErrors = 0;
11561 unsupportDecoderErrors = 0;
11562 decoderFailures = 0;
11563 decoderStartFailures = 0;
11564 inboundRtpPacketAllocationFailures = 0;
11565 inboundRtpPacketLoadFailures = 0;
11566 latePacketsDiscarded = 0;
11567 jitterBufferInsertionFailures = 0;
11568 presenceDeserializationFailures = 0;
11569 notRtpErrors = 0;
11570 generalErrors = 0;
11571 inboundRtpProcessorAllocationFailures = 0;
11572 }
11573 };
11574
11575 static void to_json(nlohmann::json& j, const GroupHealthReport& p)
11576 {
11577 j = nlohmann::json{
11578 TOJSON_IMPL(id),
11579 TOJSON_IMPL(lastErrorTs),
11580 TOJSON_IMPL(decryptionErrors),
11581 TOJSON_IMPL(encryptionErrors),
11582 TOJSON_IMPL(unsupportDecoderErrors),
11583 TOJSON_IMPL(decoderFailures),
11584 TOJSON_IMPL(decoderStartFailures),
11585 TOJSON_IMPL(inboundRtpPacketAllocationFailures),
11586 TOJSON_IMPL(inboundRtpPacketLoadFailures),
11587 TOJSON_IMPL(latePacketsDiscarded),
11588 TOJSON_IMPL(jitterBufferInsertionFailures),
11589 TOJSON_IMPL(presenceDeserializationFailures),
11590 TOJSON_IMPL(notRtpErrors),
11591 TOJSON_IMPL(generalErrors),
11592 TOJSON_IMPL(inboundRtpProcessorAllocationFailures)
11593 };
11594 }
11595 static void from_json(const nlohmann::json& j, GroupHealthReport& p)
11596 {
11597 p.clear();
11598 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
11599 getOptional<uint64_t>("lastErrorTs", p.lastErrorTs, j, 0);
11600 getOptional<uint64_t>("decryptionErrors", p.decryptionErrors, j, 0);
11601 getOptional<uint64_t>("encryptionErrors", p.encryptionErrors, j, 0);
11602 getOptional<uint64_t>("unsupportDecoderErrors", p.unsupportDecoderErrors, j, 0);
11603 getOptional<uint64_t>("decoderFailures", p.decoderFailures, j, 0);
11604 getOptional<uint64_t>("decoderStartFailures", p.decoderStartFailures, j, 0);
11605 getOptional<uint64_t>("inboundRtpPacketAllocationFailures", p.inboundRtpPacketAllocationFailures, j, 0);
11606 getOptional<uint64_t>("inboundRtpPacketLoadFailures", p.inboundRtpPacketLoadFailures, j, 0);
11607 getOptional<uint64_t>("latePacketsDiscarded", p.latePacketsDiscarded, j, 0);
11608 getOptional<uint64_t>("jitterBufferInsertionFailures", p.jitterBufferInsertionFailures, j, 0);
11609 getOptional<uint64_t>("presenceDeserializationFailures", p.presenceDeserializationFailures, j, 0);
11610 getOptional<uint64_t>("notRtpErrors", p.notRtpErrors, j, 0);
11611 getOptional<uint64_t>("generalErrors", p.generalErrors, j, 0);
11612 getOptional<uint64_t>("inboundRtpProcessorAllocationFailures", p.inboundRtpProcessorAllocationFailures, j, 0);
11613 }
11614
11615 //-----------------------------------------------------------
11616 JSON_SERIALIZED_CLASS(InboundProcessorStats)
11624 {
11625 IMPLEMENT_JSON_SERIALIZATION()
11626 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(InboundProcessorStats)
11627 IMPLEMENT_JSON_DOCUMENTATION(InboundProcessorStats)
11628
11629 public:
11630 uint32_t ssrc;
11631 double jitter;
11632 uint64_t minRtpSamplesInQueue;
11633 uint64_t maxRtpSamplesInQueue;
11634 uint64_t totalSamplesTrimmed;
11635 uint64_t underruns;
11636 uint64_t overruns;
11637 uint64_t samplesInQueue;
11638 uint64_t totalPacketsReceived;
11639 uint64_t totalPacketsLost;
11640 uint64_t totalPacketsDiscarded;
11641
11643 {
11644 clear();
11645 }
11646
11647 void clear()
11648 {
11649 ssrc = 0;
11650 jitter = 0.0;
11651 minRtpSamplesInQueue = 0;
11652 maxRtpSamplesInQueue = 0;
11653 totalSamplesTrimmed = 0;
11654 underruns = 0;
11655 overruns = 0;
11656 samplesInQueue = 0;
11657 totalPacketsReceived = 0;
11658 totalPacketsLost = 0;
11659 totalPacketsDiscarded = 0;
11660 }
11661 };
11662
11663 static void to_json(nlohmann::json& j, const InboundProcessorStats& p)
11664 {
11665 j = nlohmann::json{
11666 TOJSON_IMPL(ssrc),
11667 TOJSON_IMPL(jitter),
11668 TOJSON_IMPL(minRtpSamplesInQueue),
11669 TOJSON_IMPL(maxRtpSamplesInQueue),
11670 TOJSON_IMPL(totalSamplesTrimmed),
11671 TOJSON_IMPL(underruns),
11672 TOJSON_IMPL(overruns),
11673 TOJSON_IMPL(samplesInQueue),
11674 TOJSON_IMPL(totalPacketsReceived),
11675 TOJSON_IMPL(totalPacketsLost),
11676 TOJSON_IMPL(totalPacketsDiscarded)
11677 };
11678 }
11679 static void from_json(const nlohmann::json& j, InboundProcessorStats& p)
11680 {
11681 p.clear();
11682 getOptional<uint32_t>("ssrc", p.ssrc, j, 0);
11683 getOptional<double>("jitter", p.jitter, j, 0.0);
11684 getOptional<uint64_t>("minRtpSamplesInQueue", p.minRtpSamplesInQueue, j, 0);
11685 getOptional<uint64_t>("maxRtpSamplesInQueue", p.maxRtpSamplesInQueue, j, 0);
11686 getOptional<uint64_t>("totalSamplesTrimmed", p.totalSamplesTrimmed, j, 0);
11687 getOptional<uint64_t>("underruns", p.underruns, j, 0);
11688 getOptional<uint64_t>("overruns", p.overruns, j, 0);
11689 getOptional<uint64_t>("samplesInQueue", p.samplesInQueue, j, 0);
11690 getOptional<uint64_t>("totalPacketsReceived", p.totalPacketsReceived, j, 0);
11691 getOptional<uint64_t>("totalPacketsLost", p.totalPacketsLost, j, 0);
11692 getOptional<uint64_t>("totalPacketsDiscarded", p.totalPacketsDiscarded, j, 0);
11693 }
11694
11695 //-----------------------------------------------------------
11696 JSON_SERIALIZED_CLASS(TrafficCounter)
11704 {
11705 IMPLEMENT_JSON_SERIALIZATION()
11706 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(TrafficCounter)
11707 IMPLEMENT_JSON_DOCUMENTATION(TrafficCounter)
11708
11709 public:
11710 uint64_t packets;
11711 uint64_t bytes;
11712 uint64_t errors;
11713
11715 {
11716 clear();
11717 }
11718
11719 void clear()
11720 {
11721 packets = 0;
11722 bytes = 0;
11723 errors = 0;
11724 }
11725 };
11726
11727 static void to_json(nlohmann::json& j, const TrafficCounter& p)
11728 {
11729 j = nlohmann::json{
11730 TOJSON_IMPL(packets),
11731 TOJSON_IMPL(bytes),
11732 TOJSON_IMPL(errors)
11733 };
11734 }
11735 static void from_json(const nlohmann::json& j, TrafficCounter& p)
11736 {
11737 p.clear();
11738 getOptional<uint64_t>("packets", p.packets, j, 0);
11739 getOptional<uint64_t>("bytes", p.bytes, j, 0);
11740 getOptional<uint64_t>("errors", p.errors, j, 0);
11741 }
11742
11743 //-----------------------------------------------------------
11744 JSON_SERIALIZED_CLASS(GroupStats)
11752 {
11753 IMPLEMENT_JSON_SERIALIZATION()
11754 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(GroupStats)
11755 IMPLEMENT_JSON_DOCUMENTATION(GroupStats)
11756
11757 public:
11758 std::string id;
11759 //std::vector<InboundProcessorStats> rtpInbounds;
11760 TrafficCounter rxTraffic;
11761 TrafficCounter txTraffic;
11762
11763 GroupStats()
11764 {
11765 clear();
11766 }
11767
11768 void clear()
11769 {
11770 id.clear();
11771 //rtpInbounds.clear();
11772 rxTraffic.clear();
11773 txTraffic.clear();
11774 }
11775 };
11776
11777 static void to_json(nlohmann::json& j, const GroupStats& p)
11778 {
11779 j = nlohmann::json{
11780 TOJSON_IMPL(id),
11781 //TOJSON_IMPL(rtpInbounds),
11782 TOJSON_IMPL(rxTraffic),
11783 TOJSON_IMPL(txTraffic)
11784 };
11785 }
11786 static void from_json(const nlohmann::json& j, GroupStats& p)
11787 {
11788 p.clear();
11789 getOptional<std::string>("id", p.id, j, EMPTY_STRING);
11790 //getOptional<std::vector<InboundProcessorStats>>("rtpInbounds", p.rtpInbounds, j);
11791 getOptional<TrafficCounter>("rxTraffic", p.rxTraffic, j);
11792 getOptional<TrafficCounter>("txTraffic", p.txTraffic, j);
11793 }
11794
11795 //-----------------------------------------------------------
11796 JSON_SERIALIZED_CLASS(RallypointConnectionDetail)
11804 {
11805 IMPLEMENT_JSON_SERIALIZATION()
11806 IMPLEMENT_WRAPPED_JSON_SERIALIZATION(RallypointConnectionDetail)
11807 IMPLEMENT_JSON_DOCUMENTATION(RallypointConnectionDetail)
11808
11809 public:
11811 std::string internalId;
11812
11814 std::string host;
11815
11817 int port;
11818
11821
11824
11826 {
11827 clear();
11828 }
11829
11830 void clear()
11831 {
11832 internalId.clear();
11833 host.clear();
11834 port = 0;
11835 msToNextConnectionAttempt = 0;
11836 serverProcessingMs = -1.0f;
11837 }
11838 };
11839
11840 static void to_json(nlohmann::json& j, const RallypointConnectionDetail& p)
11841 {
11842 j = nlohmann::json{
11843 TOJSON_IMPL(internalId),
11844 TOJSON_IMPL(host),
11845 TOJSON_IMPL(port)
11846 };
11847
11848 if(p.msToNextConnectionAttempt > 0)
11849 {
11850 j["msToNextConnectionAttempt"] = p.msToNextConnectionAttempt;
11851 }
11852
11853 if(p.serverProcessingMs >= 0.0)
11854 {
11855 j["serverProcessingMs"] = p.serverProcessingMs;
11856 }
11857 }
11858 static void from_json(const nlohmann::json& j, RallypointConnectionDetail& p)
11859 {
11860 p.clear();
11861 getOptional<std::string>("internalId", p.internalId, j, EMPTY_STRING);
11862 getOptional<std::string>("host", p.host, j, EMPTY_STRING);
11863 getOptional<int>("port", p.port, j, 0);
11864 getOptional<uint64_t>("msToNextConnectionAttempt", p.msToNextConnectionAttempt, j, 0);
11865 getOptional<float>("serverProcessingMs", p.serverProcessingMs, j, -1.0);
11866 }
11867
11868 //-----------------------------------------------------------
11869 JSON_SERIALIZED_CLASS(TranslationSession)
11880 {
11881 IMPLEMENT_JSON_SERIALIZATION()
11882 IMPLEMENT_JSON_DOCUMENTATION(TranslationSession)
11883
11884 public:
11886 std::string id;
11887
11889 std::string name;
11890
11892 std::vector<std::string> groups;
11893
11896
11898 {
11899 clear();
11900 }
11901
11902 void clear()
11903 {
11904 id.clear();
11905 name.clear();
11906 groups.clear();
11907 enabled = true;
11908 }
11909 };
11910
11911 static void to_json(nlohmann::json& j, const TranslationSession& p)
11912 {
11913 j = nlohmann::json{
11914 TOJSON_IMPL(id),
11915 TOJSON_IMPL(name),
11916 TOJSON_IMPL(groups),
11917 TOJSON_IMPL(enabled)
11918 };
11919 }
11920 static void from_json(const nlohmann::json& j, TranslationSession& p)
11921 {
11922 p.clear();
11923 FROMJSON_IMPL(id, std::string, EMPTY_STRING);
11924 FROMJSON_IMPL(name, std::string, EMPTY_STRING);
11925 getOptional<std::vector<std::string>>("groups", p.groups, j);
11926 FROMJSON_IMPL(enabled, bool, true);
11927 }
11928
11929 //-----------------------------------------------------------
11930 JSON_SERIALIZED_CLASS(TranslationConfiguration)
11941 {
11942 IMPLEMENT_JSON_SERIALIZATION()
11943 IMPLEMENT_JSON_DOCUMENTATION(TranslationConfiguration)
11944
11945 public:
11947 std::vector<TranslationSession> sessions;
11948
11950 std::vector<Group> groups;
11951
11953 {
11954 clear();
11955 }
11956
11957 void clear()
11958 {
11959 sessions.clear();
11960 groups.clear();
11961 }
11962 };
11963
11964 static void to_json(nlohmann::json& j, const TranslationConfiguration& p)
11965 {
11966 j = nlohmann::json{
11967 TOJSON_IMPL(sessions),
11968 TOJSON_IMPL(groups)
11969 };
11970 }
11971 static void from_json(const nlohmann::json& j, TranslationConfiguration& p)
11972 {
11973 p.clear();
11974 getOptional<std::vector<TranslationSession>>("sessions", p.sessions, j);
11975 getOptional<std::vector<Group>>("groups", p.groups, j);
11976 }
11977
11978 //-----------------------------------------------------------
11979 JSON_SERIALIZED_CLASS(LingoServerStatusReportConfiguration)
11990 {
11991 IMPLEMENT_JSON_SERIALIZATION()
11992 IMPLEMENT_JSON_DOCUMENTATION(LingoServerStatusReportConfiguration)
11993
11994 public:
11996 std::string fileName;
11997
12000
12003
12005 std::string runCmd;
12006
12009
12012
12015
12017 {
12018 clear();
12019 }
12020
12021 void clear()
12022 {
12023 fileName.clear();
12024 intervalSecs = 60;
12025 enabled = false;
12026 includeGroupDetail = false;
12027 includeSessionDetail = false;
12028 includeSessionGroupDetail = false;
12029 runCmd.clear();
12030 }
12031 };
12032
12033 static void to_json(nlohmann::json& j, const LingoServerStatusReportConfiguration& p)
12034 {
12035 j = nlohmann::json{
12036 TOJSON_IMPL(fileName),
12037 TOJSON_IMPL(intervalSecs),
12038 TOJSON_IMPL(enabled),
12039 TOJSON_IMPL(includeGroupDetail),
12040 TOJSON_IMPL(includeSessionDetail),
12041 TOJSON_IMPL(includeSessionGroupDetail),
12042 TOJSON_IMPL(runCmd)
12043 };
12044 }
12045 static void from_json(const nlohmann::json& j, LingoServerStatusReportConfiguration& p)
12046 {
12047 p.clear();
12048 getOptional<std::string>("fileName", p.fileName, j);
12049 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
12050 getOptional<bool>("enabled", p.enabled, j, false);
12051 getOptional<std::string>("runCmd", p.runCmd, j);
12052 getOptional<bool>("includeGroupDetail", p.includeGroupDetail, j, false);
12053 getOptional<bool>("includeSessionDetail", p.includeSessionDetail, j, false);
12054 getOptional<bool>("includeSessionGroupDetail", p.includeSessionGroupDetail, j, false);
12055 }
12056
12057 //-----------------------------------------------------------
12058 JSON_SERIALIZED_CLASS(LingoServerInternals)
12071 {
12072 IMPLEMENT_JSON_SERIALIZATION()
12073 IMPLEMENT_JSON_DOCUMENTATION(LingoServerInternals)
12074
12075 public:
12078
12081
12084
12086 {
12087 clear();
12088 }
12089
12090 void clear()
12091 {
12092 watchdog.clear();
12093 tuning.clear();
12094 housekeeperIntervalMs = 1000;
12095 }
12096 };
12097
12098 static void to_json(nlohmann::json& j, const LingoServerInternals& p)
12099 {
12100 j = nlohmann::json{
12101 TOJSON_IMPL(watchdog),
12102 TOJSON_IMPL(housekeeperIntervalMs),
12103 TOJSON_IMPL(tuning)
12104 };
12105 }
12106 static void from_json(const nlohmann::json& j, LingoServerInternals& p)
12107 {
12108 p.clear();
12109 getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
12110 getOptional<int>("housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
12111 getOptional<TuningSettings>("tuning", p.tuning, j);
12112 }
12113
12114 //-----------------------------------------------------------
12115 JSON_SERIALIZED_CLASS(LingoServerConfiguration)
12125 {
12126 IMPLEMENT_JSON_SERIALIZATION()
12127 IMPLEMENT_JSON_DOCUMENTATION(LingoServerConfiguration)
12128
12129 public:
12131 std::string id;
12132
12135
12138
12141
12144
12147
12150
12153
12156
12159
12162
12165
12168
12171
12174
12176 {
12177 clear();
12178 }
12179
12180 void clear()
12181 {
12182 id.clear();
12183 serviceConfigurationFileCheckSecs = 60;
12184 lingoConfigurationFileName.clear();
12185 lingoConfigurationFileCommand.clear();
12186 lingoConfigurationFileCheckSecs = 60;
12187 statusReport.clear();
12188 externalHealthCheckResponder.clear();
12189 internals.clear();
12190 certStoreFileName.clear();
12191 certStorePasswordHex.clear();
12192 enginePolicy.clear();
12193 configurationCheckSignalName = "rts.22f4ec3.${id}";
12194 fipsCrypto.clear();
12195 proxy.clear();
12196 nsm.clear();
12197 }
12198 };
12199
12200 static void to_json(nlohmann::json& j, const LingoServerConfiguration& p)
12201 {
12202 j = nlohmann::json{
12203 TOJSON_IMPL(id),
12204 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
12205 TOJSON_IMPL(lingoConfigurationFileName),
12206 TOJSON_IMPL(lingoConfigurationFileCommand),
12207 TOJSON_IMPL(lingoConfigurationFileCheckSecs),
12208 TOJSON_IMPL(statusReport),
12209 TOJSON_IMPL(externalHealthCheckResponder),
12210 TOJSON_IMPL(internals),
12211 TOJSON_IMPL(certStoreFileName),
12212 TOJSON_IMPL(certStorePasswordHex),
12213 TOJSON_IMPL(enginePolicy),
12214 TOJSON_IMPL(configurationCheckSignalName),
12215 TOJSON_IMPL(fipsCrypto),
12216 TOJSON_IMPL(proxy),
12217 TOJSON_IMPL(nsm)
12218 };
12219 }
12220 static void from_json(const nlohmann::json& j, LingoServerConfiguration& p)
12221 {
12222 p.clear();
12223 getOptional<std::string>("id", p.id, j);
12224 getOptional<int>("serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
12225 getOptional<std::string>("lingoConfigurationFileName", p.lingoConfigurationFileName, j);
12226 getOptional<std::string>("lingoConfigurationFileCommand", p.lingoConfigurationFileCommand, j);
12227 getOptional<int>("lingoConfigurationFileCheckSecs", p.lingoConfigurationFileCheckSecs, j, 60);
12228 getOptional<LingoServerStatusReportConfiguration>("statusReport", p.statusReport, j);
12229 getOptional<ExternalHealthCheckResponder>("externalHealthCheckResponder", p.externalHealthCheckResponder, j);
12230 getOptional<LingoServerInternals>("internals", p.internals, j);
12231 getOptional<std::string>("certStoreFileName", p.certStoreFileName, j);
12232 getOptional<std::string>("certStorePasswordHex", p.certStorePasswordHex, j);
12233 j.at("enginePolicy").get_to(p.enginePolicy);
12234 getOptional<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.22f4ec3.${id}");
12235 getOptional<FipsCryptoSettings>("fipsCrypo", p.fipsCrypto, j);
12236 getOptional<NetworkAddress>("proxy", p.proxy, j);
12237 getOptional<NsmConfiguration>("nsm", p.nsm, j);
12238 }
12239
12240
12241 //-----------------------------------------------------------
12242 JSON_SERIALIZED_CLASS(VoiceToVoiceSession)
12253 {
12254 IMPLEMENT_JSON_SERIALIZATION()
12255 IMPLEMENT_JSON_DOCUMENTATION(VoiceToVoiceSession)
12256
12257 public:
12259 std::string id;
12260
12262 std::string name;
12263
12265 std::vector<std::string> groups;
12266
12269
12271 {
12272 clear();
12273 }
12274
12275 void clear()
12276 {
12277 id.clear();
12278 name.clear();
12279 groups.clear();
12280 enabled = true;
12281 }
12282 };
12283
12284 static void to_json(nlohmann::json& j, const VoiceToVoiceSession& p)
12285 {
12286 j = nlohmann::json{
12287 TOJSON_IMPL(id),
12288 TOJSON_IMPL(name),
12289 TOJSON_IMPL(groups),
12290 TOJSON_IMPL(enabled)
12291 };
12292 }
12293 static void from_json(const nlohmann::json& j, VoiceToVoiceSession& p)
12294 {
12295 p.clear();
12296 FROMJSON_IMPL(id, std::string, EMPTY_STRING);
12297 FROMJSON_IMPL(name, std::string, EMPTY_STRING);
12298 getOptional<std::vector<std::string>>("groups", p.groups, j);
12299 FROMJSON_IMPL(enabled, bool, true);
12300 }
12301
12302 //-----------------------------------------------------------
12303 JSON_SERIALIZED_CLASS(LingoConfiguration)
12314 {
12315 IMPLEMENT_JSON_SERIALIZATION()
12316 IMPLEMENT_JSON_DOCUMENTATION(LingoConfiguration)
12317
12318 public:
12320 std::vector<VoiceToVoiceSession> voiceToVoiceSessions;
12321
12323 std::vector<Group> groups;
12324
12326 {
12327 clear();
12328 }
12329
12330 void clear()
12331 {
12332 voiceToVoiceSessions.clear();
12333 groups.clear();
12334 }
12335 };
12336
12337 static void to_json(nlohmann::json& j, const LingoConfiguration& p)
12338 {
12339 j = nlohmann::json{
12340 TOJSON_IMPL(voiceToVoiceSessions),
12341 TOJSON_IMPL(groups)
12342 };
12343 }
12344 static void from_json(const nlohmann::json& j, LingoConfiguration& p)
12345 {
12346 p.clear();
12347 getOptional<std::vector<VoiceToVoiceSession>>("voiceToVoiceSessions", p.voiceToVoiceSessions, j);
12348 getOptional<std::vector<Group>>("groups", p.groups, j);
12349 }
12350
12351 //-----------------------------------------------------------
12352 JSON_SERIALIZED_CLASS(BridgingConfiguration)
12363 {
12364 IMPLEMENT_JSON_SERIALIZATION()
12365 IMPLEMENT_JSON_DOCUMENTATION(BridgingConfiguration)
12366
12367 public:
12369 std::vector<Bridge> bridges;
12370
12372 std::vector<Group> groups;
12373
12375 {
12376 clear();
12377 }
12378
12379 void clear()
12380 {
12381 bridges.clear();
12382 groups.clear();
12383 }
12384 };
12385
12386 static void to_json(nlohmann::json& j, const BridgingConfiguration& p)
12387 {
12388 j = nlohmann::json{
12389 TOJSON_IMPL(bridges),
12390 TOJSON_IMPL(groups)
12391 };
12392 }
12393 static void from_json(const nlohmann::json& j, BridgingConfiguration& p)
12394 {
12395 p.clear();
12396 getOptional<std::vector<Bridge>>("bridges", p.bridges, j);
12397 getOptional<std::vector<Group>>("groups", p.groups, j);
12398 }
12399
12400 //-----------------------------------------------------------
12401 JSON_SERIALIZED_CLASS(BridgingServerStatusReportConfiguration)
12412 {
12413 IMPLEMENT_JSON_SERIALIZATION()
12414 IMPLEMENT_JSON_DOCUMENTATION(BridgingServerStatusReportConfiguration)
12415
12416 public:
12418 std::string fileName;
12419
12422
12425
12427 std::string runCmd;
12428
12431
12434
12437
12439 {
12440 clear();
12441 }
12442
12443 void clear()
12444 {
12445 fileName.clear();
12446 intervalSecs = 60;
12447 enabled = false;
12448 includeGroupDetail = false;
12449 includeBridgeDetail = false;
12450 includeBridgeGroupDetail = false;
12451 runCmd.clear();
12452 }
12453 };
12454
12455 static void to_json(nlohmann::json& j, const BridgingServerStatusReportConfiguration& p)
12456 {
12457 j = nlohmann::json{
12458 TOJSON_IMPL(fileName),
12459 TOJSON_IMPL(intervalSecs),
12460 TOJSON_IMPL(enabled),
12461 TOJSON_IMPL(includeGroupDetail),
12462 TOJSON_IMPL(includeBridgeDetail),
12463 TOJSON_IMPL(includeBridgeGroupDetail),
12464 TOJSON_IMPL(runCmd)
12465 };
12466 }
12467 static void from_json(const nlohmann::json& j, BridgingServerStatusReportConfiguration& p)
12468 {
12469 p.clear();
12470 getOptional<std::string>("fileName", p.fileName, j);
12471 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
12472 getOptional<bool>("enabled", p.enabled, j, false);
12473 getOptional<std::string>("runCmd", p.runCmd, j);
12474 getOptional<bool>("includeGroupDetail", p.includeGroupDetail, j, false);
12475 getOptional<bool>("includeBridgeDetail", p.includeBridgeDetail, j, false);
12476 getOptional<bool>("includeBridgeGroupDetail", p.includeBridgeGroupDetail, j, false);
12477 }
12478
12479 //-----------------------------------------------------------
12480 JSON_SERIALIZED_CLASS(BridgingServerInternals)
12493 {
12494 IMPLEMENT_JSON_SERIALIZATION()
12495 IMPLEMENT_JSON_DOCUMENTATION(BridgingServerInternals)
12496
12497 public:
12500
12503
12506
12509
12512
12514 {
12515 clear();
12516 }
12517
12518 void clear()
12519 {
12520 watchdog.clear();
12521 tuning.clear();
12522 housekeeperIntervalMs = 1000;
12523 nsmUnhealthyBridgeGraceMs = 5000;
12524 nsmResourceReleaseCooldownMs = 30000;
12525 }
12526 };
12527
12528 static void to_json(nlohmann::json& j, const BridgingServerInternals& p)
12529 {
12530 j = nlohmann::json{
12531 TOJSON_IMPL(watchdog),
12532 TOJSON_IMPL(housekeeperIntervalMs),
12533 TOJSON_IMPL(nsmUnhealthyBridgeGraceMs),
12534 TOJSON_IMPL(nsmResourceReleaseCooldownMs),
12535 TOJSON_IMPL(tuning)
12536 };
12537 }
12538 static void from_json(const nlohmann::json& j, BridgingServerInternals& p)
12539 {
12540 p.clear();
12541 getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
12542 getOptional<int>("housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
12543 getOptional<int>("nsmUnhealthyBridgeGraceMs", p.nsmUnhealthyBridgeGraceMs, j, 5000);
12544 getOptional<int>("nsmResourceReleaseCooldownMs", p.nsmResourceReleaseCooldownMs, j, 30000);
12545 getOptional<TuningSettings>("tuning", p.tuning, j);
12546 }
12547
12548 //-----------------------------------------------------------
12549 JSON_SERIALIZED_CLASS(RtiCloudSettings)
12556 {
12557 IMPLEMENT_JSON_SERIALIZATION()
12558 IMPLEMENT_JSON_DOCUMENTATION(RtiCloudSettings)
12559
12560 public:
12563
12565 std::string enrollmentCode;
12566
12569
12571 {
12572 clear();
12573 }
12574
12575 void clear()
12576 {
12577 enabled = false;
12578 enrollmentCode.clear();
12579 serviceBaseUrlPrefix = "prod.com";
12580 }
12581 };
12582
12583 static void to_json(nlohmann::json& j, const RtiCloudSettings& p)
12584 {
12585 j = nlohmann::json{
12586 TOJSON_IMPL(enabled),
12587 TOJSON_IMPL(enrollmentCode),
12588 TOJSON_IMPL(serviceBaseUrlPrefix)
12589 };
12590 }
12591 static void from_json(const nlohmann::json& j, RtiCloudSettings& p)
12592 {
12593 p.clear();
12594 getOptional<bool>("enabled", p.enabled, j, false);
12595 getOptional<std::string>("enrollmentCode", p.enrollmentCode, j);
12596 getOptional<std::string>("serviceBaseUrlPrefix", p.serviceBaseUrlPrefix, j, "prod.com");
12597 }
12598
12599 //-----------------------------------------------------------
12600 JSON_SERIALIZED_CLASS(BridgingServerConfiguration)
12610 {
12611 IMPLEMENT_JSON_SERIALIZATION()
12612 IMPLEMENT_JSON_DOCUMENTATION(BridgingServerConfiguration)
12613
12614 public:
12621 typedef enum
12622 {
12624 omRaw = 0,
12625
12628 omMultistream = 1,
12629
12632 omMixedStream = 2,
12633
12635 omADictatedByGroup = 3,
12636 } OpMode_t;
12637
12639 std::string id;
12640
12643
12646
12649
12652
12655
12658
12661
12664
12667
12670
12673
12676
12679
12682
12685
12687 {
12688 clear();
12689 }
12690
12691 void clear()
12692 {
12693 id.clear();
12694 mode = omRaw;
12695 serviceConfigurationFileCheckSecs = 60;
12696 bridgingConfigurationFileName.clear();
12697 bridgingConfigurationFileCommand.clear();
12698 bridgingConfigurationFileCheckSecs = 60;
12699 statusReport.clear();
12700 externalHealthCheckResponder.clear();
12701 internals.clear();
12702 certStoreFileName.clear();
12703 certStorePasswordHex.clear();
12704 enginePolicy.clear();
12705 configurationCheckSignalName = "rts.6cc0651.${id}";
12706 fipsCrypto.clear();
12707 nsmNode.clear();
12708 rtiCloud.clear();
12709 }
12710 };
12711
12712 static void to_json(nlohmann::json& j, const BridgingServerConfiguration& p)
12713 {
12714 j = nlohmann::json{
12715 TOJSON_IMPL(id),
12716 TOJSON_IMPL(mode),
12717 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
12718 TOJSON_IMPL(bridgingConfigurationFileName),
12719 TOJSON_IMPL(bridgingConfigurationFileCommand),
12720 TOJSON_IMPL(bridgingConfigurationFileCheckSecs),
12721 TOJSON_IMPL(statusReport),
12722 TOJSON_IMPL(externalHealthCheckResponder),
12723 TOJSON_IMPL(internals),
12724 TOJSON_IMPL(certStoreFileName),
12725 TOJSON_IMPL(certStorePasswordHex),
12726 TOJSON_IMPL(enginePolicy),
12727 TOJSON_IMPL(configurationCheckSignalName),
12728 TOJSON_IMPL(fipsCrypto),
12729 TOJSON_IMPL(nsmNode),
12730 TOJSON_IMPL(rtiCloud)
12731 };
12732 }
12733 static void from_json(const nlohmann::json& j, BridgingServerConfiguration& p)
12734 {
12735 p.clear();
12736 getOptional<std::string>("id", p.id, j);
12737 getOptional<BridgingServerConfiguration::OpMode_t>("mode", p.mode, j, BridgingServerConfiguration::OpMode_t::omRaw);
12738 getOptional<int>("serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
12739 getOptional<std::string>("bridgingConfigurationFileName", p.bridgingConfigurationFileName, j);
12740 getOptional<std::string>("bridgingConfigurationFileCommand", p.bridgingConfigurationFileCommand, j);
12741 getOptional<int>("bridgingConfigurationFileCheckSecs", p.bridgingConfigurationFileCheckSecs, j, 60);
12742 getOptional<BridgingServerStatusReportConfiguration>("statusReport", p.statusReport, j);
12743 getOptional<ExternalHealthCheckResponder>("externalHealthCheckResponder", p.externalHealthCheckResponder, j);
12744 getOptional<BridgingServerInternals>("internals", p.internals, j);
12745 getOptional<std::string>("certStoreFileName", p.certStoreFileName, j);
12746 getOptional<std::string>("certStorePasswordHex", p.certStorePasswordHex, j);
12747 j.at("enginePolicy").get_to(p.enginePolicy);
12748 getOptional<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.6cc0651.${id}");
12749 getOptional<FipsCryptoSettings>("fipsCrypto", p.fipsCrypto, j);
12750 getOptional<NsmNode>("nsmNode", p.nsmNode, j);
12751 getOptional<RtiCloudSettings>("rtiCloud", p.rtiCloud, j);
12752 }
12753
12754
12755 //-----------------------------------------------------------
12756 JSON_SERIALIZED_CLASS(EarGroupsConfiguration)
12767 {
12768 IMPLEMENT_JSON_SERIALIZATION()
12769 IMPLEMENT_JSON_DOCUMENTATION(EarGroupsConfiguration)
12770
12771 public:
12773 std::vector<Group> groups;
12774
12776 {
12777 clear();
12778 }
12779
12780 void clear()
12781 {
12782 groups.clear();
12783 }
12784 };
12785
12786 static void to_json(nlohmann::json& j, const EarGroupsConfiguration& p)
12787 {
12788 j = nlohmann::json{
12789 TOJSON_IMPL(groups)
12790 };
12791 }
12792 static void from_json(const nlohmann::json& j, EarGroupsConfiguration& p)
12793 {
12794 p.clear();
12795 getOptional<std::vector<Group>>("groups", p.groups, j);
12796 }
12797
12798 //-----------------------------------------------------------
12799 JSON_SERIALIZED_CLASS(EarServerStatusReportConfiguration)
12810 {
12811 IMPLEMENT_JSON_SERIALIZATION()
12812 IMPLEMENT_JSON_DOCUMENTATION(EarServerStatusReportConfiguration)
12813
12814 public:
12816 std::string fileName;
12817
12820
12823
12825 std::string runCmd;
12826
12829
12831 {
12832 clear();
12833 }
12834
12835 void clear()
12836 {
12837 fileName.clear();
12838 intervalSecs = 60;
12839 enabled = false;
12840 includeGroupDetail = false;
12841 runCmd.clear();
12842 }
12843 };
12844
12845 static void to_json(nlohmann::json& j, const EarServerStatusReportConfiguration& p)
12846 {
12847 j = nlohmann::json{
12848 TOJSON_IMPL(fileName),
12849 TOJSON_IMPL(intervalSecs),
12850 TOJSON_IMPL(enabled),
12851 TOJSON_IMPL(includeGroupDetail),
12852 TOJSON_IMPL(runCmd)
12853 };
12854 }
12855 static void from_json(const nlohmann::json& j, EarServerStatusReportConfiguration& p)
12856 {
12857 p.clear();
12858 getOptional<std::string>("fileName", p.fileName, j);
12859 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
12860 getOptional<bool>("enabled", p.enabled, j, false);
12861 getOptional<std::string>("runCmd", p.runCmd, j);
12862 getOptional<bool>("includeGroupDetail", p.includeGroupDetail, j, false);
12863 }
12864
12865 //-----------------------------------------------------------
12866 JSON_SERIALIZED_CLASS(EarServerInternals)
12879 {
12880 IMPLEMENT_JSON_SERIALIZATION()
12881 IMPLEMENT_JSON_DOCUMENTATION(EarServerInternals)
12882
12883 public:
12886
12889
12892
12894 {
12895 clear();
12896 }
12897
12898 void clear()
12899 {
12900 watchdog.clear();
12901 tuning.clear();
12902 housekeeperIntervalMs = 1000;
12903 }
12904 };
12905
12906 static void to_json(nlohmann::json& j, const EarServerInternals& p)
12907 {
12908 j = nlohmann::json{
12909 TOJSON_IMPL(watchdog),
12910 TOJSON_IMPL(housekeeperIntervalMs),
12911 TOJSON_IMPL(tuning)
12912 };
12913 }
12914 static void from_json(const nlohmann::json& j, EarServerInternals& p)
12915 {
12916 p.clear();
12917 getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
12918 getOptional<int>("housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
12919 getOptional<TuningSettings>("tuning", p.tuning, j);
12920 }
12921
12922 //-----------------------------------------------------------
12923 JSON_SERIALIZED_CLASS(EarServerConfiguration)
12933 {
12934 IMPLEMENT_JSON_SERIALIZATION()
12935 IMPLEMENT_JSON_DOCUMENTATION(EarServerConfiguration)
12936
12937 public:
12938
12940 std::string id;
12941
12944
12947
12950
12953
12956
12959
12962
12965
12968
12971
12974
12977
12980
12982 {
12983 clear();
12984 }
12985
12986 void clear()
12987 {
12988 id.clear();
12989 serviceConfigurationFileCheckSecs = 60;
12990 groupsConfigurationFileName.clear();
12991 groupsConfigurationFileCommand.clear();
12992 groupsConfigurationFileCheckSecs = 60;
12993 statusReport.clear();
12994 externalHealthCheckResponder.clear();
12995 internals.clear();
12996 certStoreFileName.clear();
12997 certStorePasswordHex.clear();
12998 enginePolicy.clear();
12999 configurationCheckSignalName = "rts.9a164fa.${id}";
13000 fipsCrypto.clear();
13001 nsm.clear();
13002 }
13003 };
13004
13005 static void to_json(nlohmann::json& j, const EarServerConfiguration& p)
13006 {
13007 j = nlohmann::json{
13008 TOJSON_IMPL(id),
13009 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
13010 TOJSON_IMPL(groupsConfigurationFileName),
13011 TOJSON_IMPL(groupsConfigurationFileCommand),
13012 TOJSON_IMPL(groupsConfigurationFileCheckSecs),
13013 TOJSON_IMPL(statusReport),
13014 TOJSON_IMPL(externalHealthCheckResponder),
13015 TOJSON_IMPL(internals),
13016 TOJSON_IMPL(certStoreFileName),
13017 TOJSON_IMPL(certStorePasswordHex),
13018 TOJSON_IMPL(enginePolicy),
13019 TOJSON_IMPL(configurationCheckSignalName),
13020 TOJSON_IMPL(fipsCrypto),
13021 TOJSON_IMPL(nsm)
13022 };
13023 }
13024 static void from_json(const nlohmann::json& j, EarServerConfiguration& p)
13025 {
13026 p.clear();
13027 getOptional<std::string>("id", p.id, j);
13028 getOptional<int>("serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
13029 getOptional<std::string>("groupsConfigurationFileName", p.groupsConfigurationFileName, j);
13030 getOptional<std::string>("groupsConfigurationFileCommand", p.groupsConfigurationFileCommand, j);
13031 getOptional<int>("groupsConfigurationFileCheckSecs", p.groupsConfigurationFileCheckSecs, j, 60);
13032 getOptional<EarServerStatusReportConfiguration>("statusReport", p.statusReport, j);
13033 getOptional<ExternalHealthCheckResponder>("externalHealthCheckResponder", p.externalHealthCheckResponder, j);
13034 getOptional<EarServerInternals>("internals", p.internals, j);
13035 getOptional<std::string>("certStoreFileName", p.certStoreFileName, j);
13036 getOptional<std::string>("certStorePasswordHex", p.certStorePasswordHex, j);
13037 j.at("enginePolicy").get_to(p.enginePolicy);
13038 getOptional<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.9a164fa.${id}");
13039 getOptional<FipsCryptoSettings>("fipsCrypto", p.fipsCrypto, j);
13040 getOptional<NsmConfiguration>("nsm", p.nsm, j);
13041 }
13042
13043//-----------------------------------------------------------
13044 JSON_SERIALIZED_CLASS(EngageSemGroupsConfiguration)
13055 {
13056 IMPLEMENT_JSON_SERIALIZATION()
13057 IMPLEMENT_JSON_DOCUMENTATION(EngageSemGroupsConfiguration)
13058
13059 public:
13061 std::vector<Group> groups;
13062
13064 {
13065 clear();
13066 }
13067
13068 void clear()
13069 {
13070 groups.clear();
13071 }
13072 };
13073
13074 static void to_json(nlohmann::json& j, const EngageSemGroupsConfiguration& p)
13075 {
13076 j = nlohmann::json{
13077 TOJSON_IMPL(groups)
13078 };
13079 }
13080 static void from_json(const nlohmann::json& j, EngageSemGroupsConfiguration& p)
13081 {
13082 p.clear();
13083 getOptional<std::vector<Group>>("groups", p.groups, j);
13084 }
13085
13086 //-----------------------------------------------------------
13087 JSON_SERIALIZED_CLASS(EngageSemServerStatusReportConfiguration)
13098 {
13099 IMPLEMENT_JSON_SERIALIZATION()
13100 IMPLEMENT_JSON_DOCUMENTATION(EngageSemServerStatusReportConfiguration)
13101
13102 public:
13104 std::string fileName;
13105
13108
13111
13113 std::string runCmd;
13114
13117
13119 {
13120 clear();
13121 }
13122
13123 void clear()
13124 {
13125 fileName.clear();
13126 intervalSecs = 60;
13127 enabled = false;
13128 includeGroupDetail = false;
13129 runCmd.clear();
13130 }
13131 };
13132
13133 static void to_json(nlohmann::json& j, const EngageSemServerStatusReportConfiguration& p)
13134 {
13135 j = nlohmann::json{
13136 TOJSON_IMPL(fileName),
13137 TOJSON_IMPL(intervalSecs),
13138 TOJSON_IMPL(enabled),
13139 TOJSON_IMPL(includeGroupDetail),
13140 TOJSON_IMPL(runCmd)
13141 };
13142 }
13143 static void from_json(const nlohmann::json& j, EngageSemServerStatusReportConfiguration& p)
13144 {
13145 p.clear();
13146 getOptional<std::string>("fileName", p.fileName, j);
13147 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
13148 getOptional<bool>("enabled", p.enabled, j, false);
13149 getOptional<std::string>("runCmd", p.runCmd, j);
13150 getOptional<bool>("includeGroupDetail", p.includeGroupDetail, j, false);
13151 }
13152
13153 //-----------------------------------------------------------
13154 JSON_SERIALIZED_CLASS(EngageSemServerInternals)
13167 {
13168 IMPLEMENT_JSON_SERIALIZATION()
13169 IMPLEMENT_JSON_DOCUMENTATION(EngageSemServerInternals)
13170
13171 public:
13174
13177
13180
13182 {
13183 clear();
13184 }
13185
13186 void clear()
13187 {
13188 watchdog.clear();
13189 tuning.clear();
13190 housekeeperIntervalMs = 1000;
13191 }
13192 };
13193
13194 static void to_json(nlohmann::json& j, const EngageSemServerInternals& p)
13195 {
13196 j = nlohmann::json{
13197 TOJSON_IMPL(watchdog),
13198 TOJSON_IMPL(housekeeperIntervalMs),
13199 TOJSON_IMPL(tuning)
13200 };
13201 }
13202 static void from_json(const nlohmann::json& j, EngageSemServerInternals& p)
13203 {
13204 p.clear();
13205 getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
13206 getOptional<int>("housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
13207 getOptional<TuningSettings>("tuning", p.tuning, j);
13208 }
13209
13210 //-----------------------------------------------------------
13211 JSON_SERIALIZED_CLASS(EngageSemServerConfiguration)
13221 {
13222 IMPLEMENT_JSON_SERIALIZATION()
13223 IMPLEMENT_JSON_DOCUMENTATION(EngageSemServerConfiguration)
13224
13225 public:
13226
13228 std::string id;
13229
13232
13235
13238
13241
13244
13247
13250
13253
13256
13259
13262
13265
13268
13269 int maxQueueLen;
13270 int minQueuingMs;
13271 int maxQueuingMs;
13272 int minPriority;
13273 int maxPriority;
13274
13276 {
13277 clear();
13278 }
13279
13280 void clear()
13281 {
13282 id.clear();
13283 serviceConfigurationFileCheckSecs = 60;
13284 groupsConfigurationFileName.clear();
13285 groupsConfigurationFileCommand.clear();
13286 groupsConfigurationFileCheckSecs = 60;
13287 statusReport.clear();
13288 externalHealthCheckResponder.clear();
13289 internals.clear();
13290 certStoreFileName.clear();
13291 certStorePasswordHex.clear();
13292 enginePolicy.clear();
13293 configurationCheckSignalName = "rts.9a164fa.${id}";
13294 fipsCrypto.clear();
13295 nsm.clear();
13296
13297 maxQueueLen = 64;
13298 minQueuingMs = 0;
13299 maxQueuingMs = 15000;
13300 minPriority = 0;
13301 maxPriority = 255;
13302 }
13303 };
13304
13305 static void to_json(nlohmann::json& j, const EngageSemServerConfiguration& p)
13306 {
13307 j = nlohmann::json{
13308 TOJSON_IMPL(id),
13309 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
13310 TOJSON_IMPL(groupsConfigurationFileName),
13311 TOJSON_IMPL(groupsConfigurationFileCommand),
13312 TOJSON_IMPL(groupsConfigurationFileCheckSecs),
13313 TOJSON_IMPL(statusReport),
13314 TOJSON_IMPL(externalHealthCheckResponder),
13315 TOJSON_IMPL(internals),
13316 TOJSON_IMPL(certStoreFileName),
13317 TOJSON_IMPL(certStorePasswordHex),
13318 TOJSON_IMPL(enginePolicy),
13319 TOJSON_IMPL(configurationCheckSignalName),
13320 TOJSON_IMPL(fipsCrypto),
13321 TOJSON_IMPL(nsm),
13322 TOJSON_IMPL(maxQueueLen),
13323 TOJSON_IMPL(minQueuingMs),
13324 TOJSON_IMPL(maxQueuingMs),
13325 TOJSON_IMPL(minPriority),
13326 TOJSON_IMPL(maxPriority)
13327 };
13328 }
13329 static void from_json(const nlohmann::json& j, EngageSemServerConfiguration& p)
13330 {
13331 p.clear();
13332 getOptional<std::string>("id", p.id, j);
13333 getOptional<int>("serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
13334 getOptional<std::string>("groupsConfigurationFileName", p.groupsConfigurationFileName, j);
13335 getOptional<std::string>("groupsConfigurationFileCommand", p.groupsConfigurationFileCommand, j);
13336 getOptional<int>("groupsConfigurationFileCheckSecs", p.groupsConfigurationFileCheckSecs, j, 60);
13337 getOptional<EngageSemServerStatusReportConfiguration>("statusReport", p.statusReport, j);
13338 getOptional<ExternalHealthCheckResponder>("externalHealthCheckResponder", p.externalHealthCheckResponder, j);
13339 getOptional<EngageSemServerInternals>("internals", p.internals, j);
13340 getOptional<std::string>("certStoreFileName", p.certStoreFileName, j);
13341 getOptional<std::string>("certStorePasswordHex", p.certStorePasswordHex, j);
13342 j.at("enginePolicy").get_to(p.enginePolicy);
13343 getOptional<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.9a164fa.${id}");
13344 getOptional<FipsCryptoSettings>("fipsCrypto", p.fipsCrypto, j);
13345 getOptional<NsmConfiguration>("nsm", p.nsm, j);
13346 getOptional<int>("maxQueueLen", p.maxQueueLen, j, 64);
13347 getOptional<int>("minQueuingMs", p.minQueuingMs, j, 0);
13348 getOptional<int>("maxQueuingMs", p.maxQueuingMs, j, 15000);
13349 getOptional<int>("minPriority", p.minPriority, j, 0);
13350 getOptional<int>("maxPriority", p.maxPriority, j, 255);
13351 }
13352
13353 //-----------------------------------------------------------
13354 JSON_SERIALIZED_CLASS(EngateGroup)
13364 class EngateGroup : public Group
13365 {
13366 IMPLEMENT_JSON_SERIALIZATION()
13367 IMPLEMENT_JSON_DOCUMENTATION(EngateGroup)
13368
13369 public:
13370 bool useVad;
13371 uint32_t inputHangMs;
13372 uint32_t inputActivationPowerThreshold;
13373 uint32_t inputDeactivationPowerThreshold;
13374
13375 EngateGroup()
13376 {
13377 clear();
13378 }
13379
13380 void clear()
13381 {
13382 Group::clear();
13383 useVad = false;
13384 inputHangMs = 750;
13385 inputActivationPowerThreshold = 700;
13386 inputDeactivationPowerThreshold = 125;
13387 }
13388 };
13389
13390 static void to_json(nlohmann::json& j, const EngateGroup& p)
13391 {
13392 nlohmann::json g;
13393 to_json(g, static_cast<const Group&>(p));
13394
13395 j = nlohmann::json{
13396 TOJSON_IMPL(useVad),
13397 TOJSON_IMPL(inputHangMs),
13398 TOJSON_IMPL(inputActivationPowerThreshold),
13399 TOJSON_IMPL(inputDeactivationPowerThreshold)
13400 };
13401 }
13402 static void from_json(const nlohmann::json& j, EngateGroup& p)
13403 {
13404 p.clear();
13405 from_json(j, static_cast<Group&>(p));
13406 getOptional<uint32_t>("inputHangMs", p.inputHangMs, j, 750);
13407 getOptional<uint32_t>("inputActivationPowerThreshold", p.inputActivationPowerThreshold, j, 700);
13408 getOptional<uint32_t>("inputDeactivationPowerThreshold", p.inputDeactivationPowerThreshold, j, 125);
13409 }
13410
13411 //-----------------------------------------------------------
13412 JSON_SERIALIZED_CLASS(EngateGroupsConfiguration)
13423 {
13424 IMPLEMENT_JSON_SERIALIZATION()
13425 IMPLEMENT_JSON_DOCUMENTATION(EngateGroupsConfiguration)
13426
13427 public:
13429 std::vector<EngateGroup> groups;
13430
13432 {
13433 clear();
13434 }
13435
13436 void clear()
13437 {
13438 groups.clear();
13439 }
13440 };
13441
13442 static void to_json(nlohmann::json& j, const EngateGroupsConfiguration& p)
13443 {
13444 j = nlohmann::json{
13445 TOJSON_IMPL(groups)
13446 };
13447 }
13448 static void from_json(const nlohmann::json& j, EngateGroupsConfiguration& p)
13449 {
13450 p.clear();
13451 getOptional<std::vector<EngateGroup>>("groups", p.groups, j);
13452 }
13453
13454 //-----------------------------------------------------------
13455 JSON_SERIALIZED_CLASS(EngateServerStatusReportConfiguration)
13466 {
13467 IMPLEMENT_JSON_SERIALIZATION()
13468 IMPLEMENT_JSON_DOCUMENTATION(EngateServerStatusReportConfiguration)
13469
13470 public:
13472 std::string fileName;
13473
13476
13479
13481 std::string runCmd;
13482
13485
13487 {
13488 clear();
13489 }
13490
13491 void clear()
13492 {
13493 fileName.clear();
13494 intervalSecs = 60;
13495 enabled = false;
13496 includeGroupDetail = false;
13497 runCmd.clear();
13498 }
13499 };
13500
13501 static void to_json(nlohmann::json& j, const EngateServerStatusReportConfiguration& p)
13502 {
13503 j = nlohmann::json{
13504 TOJSON_IMPL(fileName),
13505 TOJSON_IMPL(intervalSecs),
13506 TOJSON_IMPL(enabled),
13507 TOJSON_IMPL(includeGroupDetail),
13508 TOJSON_IMPL(runCmd)
13509 };
13510 }
13511 static void from_json(const nlohmann::json& j, EngateServerStatusReportConfiguration& p)
13512 {
13513 p.clear();
13514 getOptional<std::string>("fileName", p.fileName, j);
13515 getOptional<int>("intervalSecs", p.intervalSecs, j, 60);
13516 getOptional<bool>("enabled", p.enabled, j, false);
13517 getOptional<std::string>("runCmd", p.runCmd, j);
13518 getOptional<bool>("includeGroupDetail", p.includeGroupDetail, j, false);
13519 }
13520
13521 //-----------------------------------------------------------
13522 JSON_SERIALIZED_CLASS(EngateServerInternals)
13535 {
13536 IMPLEMENT_JSON_SERIALIZATION()
13537 IMPLEMENT_JSON_DOCUMENTATION(EngateServerInternals)
13538
13539 public:
13542
13545
13548
13550 {
13551 clear();
13552 }
13553
13554 void clear()
13555 {
13556 watchdog.clear();
13557 tuning.clear();
13558 housekeeperIntervalMs = 1000;
13559 }
13560 };
13561
13562 static void to_json(nlohmann::json& j, const EngateServerInternals& p)
13563 {
13564 j = nlohmann::json{
13565 TOJSON_IMPL(watchdog),
13566 TOJSON_IMPL(housekeeperIntervalMs),
13567 TOJSON_IMPL(tuning)
13568 };
13569 }
13570 static void from_json(const nlohmann::json& j, EngateServerInternals& p)
13571 {
13572 p.clear();
13573 getOptional<WatchdogSettings>("watchdog", p.watchdog, j);
13574 getOptional<int>("housekeeperIntervalMs", p.housekeeperIntervalMs, j, 1000);
13575 getOptional<TuningSettings>("tuning", p.tuning, j);
13576 }
13577
13578 //-----------------------------------------------------------
13579 JSON_SERIALIZED_CLASS(EngateServerConfiguration)
13589 {
13590 IMPLEMENT_JSON_SERIALIZATION()
13591 IMPLEMENT_JSON_DOCUMENTATION(EngateServerConfiguration)
13592
13593 public:
13594
13596 std::string id;
13597
13600
13603
13606
13609
13612
13615
13618
13621
13624
13627
13630
13633
13636
13638 {
13639 clear();
13640 }
13641
13642 void clear()
13643 {
13644 id.clear();
13645 serviceConfigurationFileCheckSecs = 60;
13646 groupsConfigurationFileName.clear();
13647 groupsConfigurationFileCommand.clear();
13648 groupsConfigurationFileCheckSecs = 60;
13649 statusReport.clear();
13650 externalHealthCheckResponder.clear();
13651 internals.clear();
13652 certStoreFileName.clear();
13653 certStorePasswordHex.clear();
13654 enginePolicy.clear();
13655 configurationCheckSignalName = "rts.9a164fa.${id}";
13656 fipsCrypto.clear();
13657 nsm.clear();
13658 }
13659 };
13660
13661 static void to_json(nlohmann::json& j, const EngateServerConfiguration& p)
13662 {
13663 j = nlohmann::json{
13664 TOJSON_IMPL(id),
13665 TOJSON_IMPL(serviceConfigurationFileCheckSecs),
13666 TOJSON_IMPL(groupsConfigurationFileName),
13667 TOJSON_IMPL(groupsConfigurationFileCommand),
13668 TOJSON_IMPL(groupsConfigurationFileCheckSecs),
13669 TOJSON_IMPL(statusReport),
13670 TOJSON_IMPL(externalHealthCheckResponder),
13671 TOJSON_IMPL(internals),
13672 TOJSON_IMPL(certStoreFileName),
13673 TOJSON_IMPL(certStorePasswordHex),
13674 TOJSON_IMPL(enginePolicy),
13675 TOJSON_IMPL(configurationCheckSignalName),
13676 TOJSON_IMPL(fipsCrypto),
13677 TOJSON_IMPL(nsm)
13678 };
13679 }
13680 static void from_json(const nlohmann::json& j, EngateServerConfiguration& p)
13681 {
13682 p.clear();
13683 getOptional<std::string>("id", p.id, j);
13684 getOptional<int>("serviceConfigurationFileCheckSecs", p.serviceConfigurationFileCheckSecs, j, 60);
13685 getOptional<std::string>("groupsConfigurationFileName", p.groupsConfigurationFileName, j);
13686 getOptional<std::string>("groupsConfigurationFileCommand", p.groupsConfigurationFileCommand, j);
13687 getOptional<int>("groupsConfigurationFileCheckSecs", p.groupsConfigurationFileCheckSecs, j, 60);
13688 getOptional<EngateServerStatusReportConfiguration>("statusReport", p.statusReport, j);
13689 getOptional<ExternalHealthCheckResponder>("externalHealthCheckResponder", p.externalHealthCheckResponder, j);
13690 getOptional<EngateServerInternals>("internals", p.internals, j);
13691 getOptional<std::string>("certStoreFileName", p.certStoreFileName, j);
13692 getOptional<std::string>("certStorePasswordHex", p.certStorePasswordHex, j);
13693 j.at("enginePolicy").get_to(p.enginePolicy);
13694 getOptional<std::string>("configurationCheckSignalName", p.configurationCheckSignalName, j, "rts.9a164fa.${id}");
13695 getOptional<FipsCryptoSettings>("fipsCrypto", p.fipsCrypto, j);
13696 getOptional<NsmConfiguration>("nsm", p.nsm, j);
13697 }
13698
13699 //-----------------------------------------------------------
13700 static inline void dumpExampleConfigurations(const char *path)
13701 {
13702 WatchdogSettings::document();
13703 FileRecordingRequest::document();
13704 Feature::document();
13705 Featureset::document();
13706 Agc::document();
13707 RtpPayloadTypeTranslation::document();
13708 NetworkInterfaceDevice::document();
13709 ListOfNetworkInterfaceDevice::document();
13710 RtpHeader::document();
13711 BlobInfo::document();
13712 TxAudioUri::document();
13713 AdvancedTxParams::document();
13714 Identity::document();
13715 Location::document();
13716 Power::document();
13717 Connectivity::document();
13718 PresenceDescriptorGroupItem::document();
13719 PresenceDescriptor::document();
13720 NetworkTxOptions::document();
13721 TcpNetworkTxOptions::document();
13722 NetworkAddress::document();
13723 NetworkAddressRxTx::document();
13724 NetworkAddressRestrictionList::document();
13725 StringRestrictionList::document();
13726 Rallypoint::document();
13727 RallypointCluster::document();
13728 NetworkDeviceDescriptor::document();
13729 TxAudio::document();
13730 AudioDeviceDescriptor::document();
13731 ListOfAudioDeviceDescriptor::document();
13732 Audio::document();
13733 TalkerInformation::document();
13734 GroupTalkers::document();
13735 Presence::document();
13736 Advertising::document();
13737 GroupPriorityTranslation::document();
13738 GroupTimeline::document();
13739 GroupAppTransport::document();
13740 RtpProfile::document();
13741 Group::document();
13742 Mission::document();
13743 LicenseDescriptor::document();
13744 EngineNetworkingRpUdpStreaming::document();
13745 EnginePolicyNetworking::document();
13746 Aec::document();
13747 Vad::document();
13748 Bridge::document();
13749 AndroidAudio::document();
13750 EnginePolicyAudio::document();
13751 SecurityCertificate::document();
13752 EnginePolicySecurity::document();
13753 EnginePolicyLogging::document();
13754 EnginePolicyDatabase::document();
13755 NamedAudioDevice::document();
13756 EnginePolicyNamedAudioDevices::document();
13757 Licensing::document();
13758 DiscoveryMagellan::document();
13759 DiscoverySsdp::document();
13760 DiscoverySap::document();
13761 DiscoveryCistech::document();
13762 DiscoveryTrellisware::document();
13763 DiscoveryConfiguration::document();
13764 EnginePolicyInternals::document();
13765 EnginePolicyTimelines::document();
13766 RtpMapEntry::document();
13767 ExternalModule::document();
13768 ExternalCodecDescriptor::document();
13769 EnginePolicy::document();
13770 TalkgroupAsset::document();
13771 EngageDiscoveredGroup::document();
13772 RallypointPeer::document();
13773 RallypointServerLimits::document();
13774 RallypointServerStatusReportConfiguration::document();
13775 RallypointServerLinkGraph::document();
13776 ExternalHealthCheckResponder::document();
13777 Tls::document();
13778 PeeringConfiguration::document();
13779 IgmpSnooping::document();
13780 RallypointReflector::document();
13781 RallypointUdpStreaming::document();
13782 RallypointServer::document();
13783 PlatformDiscoveredService::document();
13784 TimelineQueryParameters::document();
13785 CertStoreCertificate::document();
13786 CertStore::document();
13787 CertStoreCertificateElement::document();
13788 CertStoreDescriptor::document();
13789 CertificateDescriptor::document();
13790 BridgeCreationDetail::document();
13791 GroupConnectionDetail::document();
13792 GroupTxDetail::document();
13793 GroupCreationDetail::document();
13794 GroupReconfigurationDetail::document();
13795 GroupHealthReport::document();
13796 InboundProcessorStats::document();
13797 TrafficCounter::document();
13798 GroupStats::document();
13799 RallypointConnectionDetail::document();
13800 BridgingConfiguration::document();
13801 BridgingServerStatusReportConfiguration::document();
13802 BridgingServerInternals::document();
13803 RtiCloudSettings::document();
13804 BridgingServerConfiguration::document();
13805 EarGroupsConfiguration::document();
13806 EarServerStatusReportConfiguration::document();
13807 EarServerInternals::document();
13808 EarServerConfiguration::document();
13809 RangerPackets::document();
13810 TransportImpairment::document();
13811
13812 EngageSemGroupsConfiguration::document();
13813 EngageSemServerStatusReportConfiguration::document();
13814 EngageSemServerInternals::document();
13815 EngageSemServerConfiguration::document();
13816 }
13817}
13818
13819#ifndef WIN32
13820 #pragma GCC diagnostic pop
13821#endif
13822
13823#endif /* ConfigurationObjects_h */
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.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
NsmConfiguration nsm
[Optional] Settings for NSM.
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....
NsmConfiguration nsm
[Optional] Settings for NSM.
std::string groupsConfigurationFileCommand
Command-line to execute that returns a configuration.
ExternalHealthCheckResponder externalHealthCheckResponder
Details concerning the server's interaction with an external health-checker such as a load-balancer.
EngageSemServerInternals internals
Internal settings.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
int groupsConfigurationFileCheckSecs
Number of seconds between checks to see if the configuration has been updated. Default is 60.
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.
EngateServerInternals internals
Internal settings.
int groupsConfigurationFileCheckSecs
Number of seconds between checks to see if the configuration has been updated. Default is 60.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
std::string certStoreFileName
Path to the certificate store.
NsmConfiguration nsm
[Optional] Settings for NSM.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
EnginePolicy enginePolicy
The policy to be used for the underlying Engage Engine.
int serviceConfigurationFileCheckSecs
Number of seconds between checks to see if the service configuration has been updated....
std::string id
A unqiue identifier for the EAR server.
std::string groupsConfigurationFileCommand
Command-line to execute that returns a configuration.
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 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.
NsmConfiguration nsm
[Optional] Settings for NSM.
std::string certStorePasswordHex
Hex password for the certificate store (if any)
std::string lingoConfigurationFileCommand
Command-line to execute that returns a linguistics configuration.
LingoServerInternals internals
Internal settings.
EnginePolicy enginePolicy
The policy to be used for the underlying Engage Engine.
int lingoConfigurationFileCheckSecs
Number of seconds between checks to see if the linguistics configuration has been updated....
std::string certStoreFileName
Path to the certificate store.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
NetworkAddress proxy
Address and port of the proxy.
int serviceConfigurationFileCheckSecs
Number of seconds between checks to see if the service configuration has been updated....
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).
Cursor-on-Target envelope for NSM wire payloads (optional).
std::string detailJson
Optional JSON object serialized as string for extra CoT detail elements.
Configuration for a Nsm node.
FipsCryptoSettings fipsCrypto
[Optional] Settings for the FIPS crypto.
std::string configurationCheckSignalName
Name to use for signalling a configuration check.
NsmNodeStatusReportConfiguration statusReport
Details for producing a status report.
std::string domainName
Logical domain label for status and monitoring.
WatchdogSettings watchdog
[Optional] Settings for the node's watchdog.
NsmNodeLogging logging
Console / syslog logging.
Licensing licensing
Licensing settings.
Featureset featureset
Optional feature set.
std::string id
Unique identifier for this process instance (also used as default state machine id when stateMachine....
int defaultPriority
[Optional, Default: 0] Election priority byte when a resource omits priority or uses -1 (see NsmNodeR...
bool dashboardToken
[Optional, Default: false] When true with dashboard logging, show resource token in the UI.
std::vector< NsmNodePeriodic > periodics
Periodic commands (JSON output, external token range, etc.).
PacketCapturer txCapture
Details for capture of transmitted packets
NsmNodeScripts scripts
Lifecycle hook scripts.
std::string multicastInterfaceName
Multicast bind / subscription NIC (SO_BINDTODEVICE / IP_ADD_MEMBERSHIP).
std::string name
Human-readable label for operators.
IpFamilyType_t ipFamily
[Optional, Default IpFamilyType_t::ifIp4] Address family for interface validation and logging.
int fixedToken
[Optional, Default: -1] Fixed global token for testing; >= 0 forces that token, -1 uses random per el...
TuningSettings tuning
[Optional] Low-level tuning
PacketCapturer rxCapture
Details for capture of received packets
NsmNodeCotSettings cot
Optional CoT wrapping for wire payloads.
NsmConfiguration stateMachine
Core NSM protocol and networking configuration (UDP, tokens, timing).
Console / syslog logging behaviour for nsmd.
bool dashboard
[Optional, Default: false] Full-screen dashboard instead of line logs.
int level
[Optional, Default: 3] ILogger level (fatal=0 ... debug=5).
Scheduled command (e.g. external token range discovery).
One logical resource in the NSM state machine with its election priority (high byte of token).
int priority
[Optional, Default: -1] Priority byte for token MSB; -1 means use NsmNode.defaultPriority when loaded...
External hook scripts for state transitions and reporting.
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.
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.
NsmConfiguration nsm
[Optional] Settings for NSM.
bool disableLoopDetection
If true, turns off loop detection.
std::vector< std::string > blockedDomains
[Optional] List of domains that explictly MAY NOT connect to this RP
std::vector< std::string > allowedDomains
[Optional] List of domains that explicitly MAY connect to this RP
std::string certStoreFileName
Path to the certificate store.
int peeringConfigurationFileCheckSecs
Number of seconds between checks to see if the peering configuration has been updated....
Tls tls
Details concerning Transport Layer Security.
TODO: Configuration for Rallypoint limits.
uint32_t maxQOpsPerSec
Maximum number of queue operations per second (0 = unlimited)
uint32_t maxInboundBacklog
Maximum number of inbound backlog requests the Rallypoint will accept.
uint32_t normalPriorityQueueThreshold
Number of normal priority queue operations after which new connections will not be accepted.
uint32_t maxPeers
Maximum number of peers (0 = unlimited)
uint32_t maxTxBytesPerSec
Maximum number of bytes transmitted per second (0 = unlimited)
uint32_t maxTxPacketsPerSec
Maximum number of packets transmitted per second (0 = unlimited)
uint32_t maxRegisteredStreams
Maximum number of registered streams (0 = unlimited)
uint32_t maxClients
Maximum number of clients (0 = unlimited)
uint32_t maxMulticastReflectors
Maximum number of multicastReflectors (0 = unlimited)
uint32_t maxStreamPaths
Maximum number of bidirectional stream paths (0 = unlimited)
uint32_t lowPriorityQueueThreshold
Number of low priority queue operations after which new connections will not be accepted.
uint32_t maxRxBytesPerSec
Maximum number of bytes received per second (0 = unlimited)
uint32_t denyNewConnectionCpuThreshold
The CPU utilization threshold percentage (0-100) beyond which new connections are denied.
uint32_t maxRxPacketsPerSec
Maximum number of packets received per second (0 = unlimited)
uint32_t warnAtCpuThreshold
The CPU utilization threshold percentage (0-100) beyond which warnings are logged.
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 for Engage Bridging Service and other products.
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...