-
Notifications
You must be signed in to change notification settings - Fork 337
/
ddsi__cfgelems.h
2258 lines (2202 loc) · 101 KB
/
ddsi__cfgelems.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright(c) 2020 to 2022 ZettaScale Technology and others
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// http://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
// v. 1.0 which is available at
// http://www.eclipse.org/org/documents/edl-v10.php.
//
// SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
#ifndef DDSI__CFGELEMS_H
#define DDSI__CFGELEMS_H
#include "dds/features.h"
static struct cfgelem network_interface_attributes[] = {
STRING("autodetermine", NULL, 1, "false",
MEMBEROF(ddsi_config_network_interface_listelem, cfg.automatic),
FUNCTIONS(0, uf_boolean, 0, pf_boolean),
DESCRIPTION(
"<p>If set to \"true\" an interface is automatically selected. Specifying "
"a name or an address when automatic is set is considered an error.</p>"
)),
STRING("name", NULL, 1, "",
MEMBEROF(ddsi_config_network_interface_listelem, cfg.name),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This attribute specifies the name of the interface. </p>"
)),
STRING("address", NULL, 1, "",
MEMBEROF(ddsi_config_network_interface_listelem, cfg.address),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This attribute specifies the address of the interface. With ipv4 allows "
" matching on the network part if the host part is set to zero. </p>"
)),
STRING("priority", NULL, 1, "default",
MEMBEROF(ddsi_config_network_interface_listelem, cfg.priority),
FUNCTIONS(0, uf_maybe_int32, 0, pf_maybe_int32),
DESCRIPTION(
"<p>This attribute specifies the interface priority (decimal integer or "
"<i>default</i>). The default value for loopback interfaces is 2, for all "
"other interfaces it is 0.</p>"
)),
BOOL("prefer_multicast", NULL, 1, "false",
MEMBEROF(ddsi_config_network_interface_listelem, cfg.prefer_multicast),
FUNCTIONS(0, uf_boolean, 0, pf_boolean),
DESCRIPTION(
"<p>When false (default), Cyclone DDS uses unicast for data whenever "
"a single unicast suffices. Setting this to true makes it prefer "
"multicasting data, falling back to unicast only when no multicast "
"is available.</p>"
)),
BOOL("presence_required", NULL, 1, "true",
MEMBEROF(ddsi_config_network_interface_listelem, cfg.presence_required),
FUNCTIONS(0, uf_boolean, 0, pf_boolean),
DESCRIPTION(
"<p>By default, all specified network interfaces must be present; if they "
"are missing Cyclone will not start. By explicitly setting this setting "
"for an interface, you can instruct Cyclone to ignore that interface if "
"it is not present.</p>"
)),
STRING("multicast", NULL, 1, "default",
MEMBEROF(ddsi_config_network_interface_listelem, cfg.multicast),
FUNCTIONS(0, uf_boolean_default, 0, pf_boolean_default),
DESCRIPTION(
"<p>This attribute specifies whether the interface should use multicast. "
"On its default setting, 'default', it will use the value as return by the operating "
"system. If set to 'true', the interface will be assumed to be multicast capable "
"even when the interface flags returned by the operating system state it is not "
"(this provides a workaround for some platforms). If set to 'false', the interface "
"will never be used for multicast.</p>"
)),
LIST("allow_multicast", NULL, 1, "default",
MEMBEROF(ddsi_config_network_interface_listelem, cfg.allow_multicast),
FUNCTIONS(0, uf_allow_multicast, 0, pf_allow_multicast),
DESCRIPTION(
"<p>This element controls whether Cyclone DDS uses multicasts for data "
"traffic on this interface.</p>\n"
"<p>It is a comma-separated list of some of the following keywords: "
"\"spdp\", \"asm\", \"ssm\", or either of \"false\" or \"true\", or "
"\"default\".</p>\n"
"<ul>\n"
"<li><i>spdp</i>: "
"enables the use of ASM (any-source multicast) for participant "
"discovery, joining the multicast group on the discovery socket, "
"transmitting SPDP messages to this group, but never advertising nor "
"using any multicast address in any discovery message, thus forcing "
"unicast communications for all endpoint discovery and user data."
"</li>\n"
"<li><i>asm</i>: "
"enables the use of ASM for all traffic, including receiving SPDP but "
"not transmitting SPDP messages via multicast"
"</li>\n"
"<li><i>ssm</i>: "
"enables the use of SSM (source-specific multicast) for all non-SPDP "
"traffic (if supported)"
"</li></ul>\n"
"<p>When set to \"false\" all multicasting is disabled; \"true\""
"enables the full use of multicasts. Listening for multicasts can "
"be controlled by General/MulticastRecvNetworkInterfaceAddresses.</p>\n"
"<p>The special value \"default\" takes the value from the global"
"General/AllowMulticast setting.</p>"),
VALUES("false","spdp","asm","ssm","true","default")),
END_MARKER
};
static struct cfgelem psmx_attributes[] = {
STRING("name", NULL, 1, "",
MEMBEROF(ddsi_config_psmx_listelem, cfg.name),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This attribute specifies the name of the interface. </p>"
)),
STRING("library", NULL, 1, "",
MEMBEROF(ddsi_config_psmx_listelem, cfg.library),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This attribute specifies the filename of the interface library. </p>"
)),
STRING("priority", NULL, 1, "default",
MEMBEROF(ddsi_config_psmx_listelem, cfg.priority),
FUNCTIONS(0, uf_maybe_int32, 0, pf_maybe_int32),
DESCRIPTION(
"<p>This attribute specifies the interface priority (decimal integer or "
"<i>default</i>). The default value for a PSMX is 0.</p>"
)),
STRING("config", NULL, 1, "",
MEMBEROF(ddsi_config_psmx_listelem, cfg.config),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This attribute specifies any configuration data for the PSMX instance."
"This has no meaning in CycloneDDS itself, and its parsing is deferred to the"
"PSMX implementation.</p>"
)),
END_MARKER
};
static struct cfgelem interfaces_cfgelems[] = {
GROUP("NetworkInterface", NULL, network_interface_attributes, INT_MAX,
MEMBER(network_interfaces),
FUNCTIONS(if_network_interfaces, 0, 0, 0),
DESCRIPTION(
"<p>This element defines a network interface. You can set autodetermine=\"true\" "
"to autoselect the interface CycloneDDS considers the highest quality. If "
"autodetermine=\"false\" (the default), you must specify the name and/or address "
"attribute. If you specify both, they must match the same interface.</p>")),
GROUP("PubSubMessageExchange", NULL, psmx_attributes, INT_MAX,
MEMBER(psmx_instances),
FUNCTIONS(if_psmx, 0, 0, 0),
DESCRIPTION(
"<p>This element defines a PSMX.</p>")),
END_MARKER
};
static struct cfgelem entity_autonaming_attributes[] = {
STRING("seed", NULL, 1, "",
MEMBER(entity_naming_seed),
FUNCTIONS(0, uf_random_seed, 0, pf_random_seed),
DESCRIPTION(
"<p>Provide an initial seed for the entity naming. Your string will be "
"hashed to provide the random state. When provided, the same sequence of "
"names is generated every run. Creating your entities in the same "
"order will ensure they are the same between runs. If you run multiple "
"nodes, set this via environment variable to ensure every node generates "
"unique names. A random starting seed is chosen when left empty, (the default). </p>"
)),
END_MARKER
};
static struct cfgelem general_cfgelems[] = {
STRING("MulticastRecvNetworkInterfaceAddresses", NULL, 1, "preferred",
MEMBER(networkRecvAddressStrings),
FUNCTIONS(0, uf_networkAddresses, ff_networkAddresses, pf_networkAddresses),
DESCRIPTION(
"<p>This element specifies which network interfaces Cyclone DDS "
"listens to multicasts. The following options are available:</p>\n"
"<ul>\n"
"<li><i>all</i>: "
"listen for multicasts on all multicast-capable interfaces; or"
"</li>\n"
"<li><i>any</i>: "
"listen for multicasts on the operating system default interface; or"
"</li>\n"
"<li><i>preferred</i>: "
"listen for multicasts on the preferred interface "
"(General/Interface/NetworkInterface with the highest priority); or"
"</li>\n"
"<li><i>none</i>: "
"does not listen for multicasts on any interface; or"
"</li>\n"
"<li>a comma-separated list of network addresses: configures Cyclone DDS to "
"listen for multicasts on all listed addresses."
"</li>\n"
"</ul>\n"
"<p>If Cyclone DDS is in IPv6 mode and the address of the preferred network "
"interface is a link-local address, \"all\" is treated as a synonym for "
"\"preferred\" and a comma-separated list is treated as \"preferred\" "
"if it contains the preferred interface and as \"none\" if not.</p>"
)),
GROUP("Interfaces", interfaces_cfgelems, NULL, 1,
NOMEMBER,
NOFUNCTIONS,
DESCRIPTION(
"<p>This element specifies the network interfaces for use by Cyclone "
"DDS. Multiple interfaces can be specified with an assigned priority. "
"The list in use will be sorted by priority. If interfaces have an "
"equal priority, the specification order will be preserved.</p>"
)),
STRING(DEPRECATED("NetworkInterfaceAddress"), NULL, 1, "auto",
MEMBER(depr_networkAddressString),
FUNCTIONS(0, uf_networkAddress, ff_free, pf_networkAddress),
DESCRIPTION(
"<p>This configuration option is deprecated. Use General/Interfaces "
" instead. "
" This element specifies the preferred network interface for use by "
"Cyclone DDS. The preferred network interface determines the IP address "
"that Cyclone DDS advertises in the discovery protocol (but see also "
"General/ExternalNetworkAddress), and is also the only interface over "
"which multicasts are transmitted. The interface can be identified by "
"its IP address, network interface name or network portion of the "
"address. If the value \"auto\" is entered here, Cyclone DDS will "
"select what it considers the most suitable interface.</p>"
)),
STRING("ExternalNetworkAddress", NULL, 1, "auto",
MEMBER(externalAddressString),
FUNCTIONS(0, uf_networkAddress, ff_free, pf_networkAddress),
DESCRIPTION(
"<p>This element allows explicitly overruling the network address "
"Cyclone DDS advertises in the discovery protocol, which by default is "
"the address of the preferred network interface "
"(General/NetworkInterfaceAddress), to allow Cyclone DDS to communicate "
"across a Network Address Translation (NAT) device.</p>")),
STRING("ExternalNetworkMask", NULL, 1, "0.0.0.0",
MEMBER(externalMaskString),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This element specifies the network mask of the external network "
"address. This element is relevant only when an external network "
"address (General/ExternalNetworkAddress) is explicitly configured. In "
"this case locators received via the discovery protocol that are "
"within the same external subnet (as defined by this mask) will be "
"translated to an internal address by replacing the network portion of "
"the external address with the corresponding portion of the preferred "
"network interface address. This option is IPv4-only.</p>")),
LIST("AllowMulticast", NULL, 1, "default",
MEMBER(allowMulticast),
FUNCTIONS(0, uf_allow_multicast, 0, pf_allow_multicast),
DESCRIPTION(
"<p>This element controls the default for the per-network interface "
"setting whether Cyclone DDS uses multicasts for discovery and data "
"traffic.</p>\n"
"<p>It is a comma-separated list of some of the following keywords: "
"\"spdp\", \"asm\", \"ssm\", or either of \"false\" or \"true\", or "
"\"default\".</p>\n"
"<ul>\n"
"<li><i>spdp</i>: "
"enables the use of ASM (any-source multicast) for participant "
"discovery, joining the multicast group on the discovery socket, "
"transmitting SPDP messages to this group, but never advertising nor "
"using any multicast address in any discovery message, thus forcing "
"unicast communications for all endpoint discovery and user data."
"</li>\n"
"<li><i>asm</i>: "
"enables the use of ASM for all traffic, including receiving SPDP but "
"not transmitting SPDP messages via multicast"
"</li>\n"
"<li><i>ssm</i>: "
"enables the use of SSM (source-specific multicast) for all non-SPDP "
"traffic (if supported)"
"</li></ul>\n"
"<p>When set to \"false\" all multicasting is disabled; \"true\""
"enables the full use of multicasts. Listening for multicasts can "
"be controlled by General/MulticastRecvNetworkInterfaceAddresses.</p>\n"
"<p>The special value \"default\" maps on spdp if the network is a "
"WiFi network, on true if it is a wired network</p>"),
VALUES("false","spdp","asm","ssm","true","default")),
BOOL(DEPRECATED("PreferMulticast"), NULL, 1, "false",
MEMBER(depr_prefer_multicast),
FUNCTIONS(0, uf_boolean, 0, pf_boolean),
DESCRIPTION(
"<p>Deprecated, use Interfaces/NetworkInterface[@multicast_cost] instead. "
"When false (default) Cyclone DDS uses unicast for data whenever "
"there a single unicast suffices. Setting this to true makes it prefer "
"multicasting data, falling back to unicast only when no multicast "
"address is available.</p>")),
INT("MulticastTimeToLive", NULL, 1, "32",
MEMBER(multicast_ttl),
FUNCTIONS(0, uf_natint_255, 0, pf_int),
DESCRIPTION(
"<p>This element specifies the time-to-live setting for outgoing "
"multicast packets.</p>"),
RANGE("0;255")),
BOOL("DontRoute", NULL, 1, "false",
MEMBER(dontRoute),
FUNCTIONS(0, uf_boolean, 0, pf_boolean),
DESCRIPTION(
"<p>This element allows setting the SO_DONTROUTE option for outgoing "
"packets to bypass the local routing tables. This is generally useful "
"only when the routing tables cannot be trusted, which is highly "
"unusual.</p>")),
ENUM("UseIPv6", NULL, 1, "default",
MEMBER(compat_use_ipv6),
FUNCTIONS(0, uf_boolean_default, 0, pf_nop),
DESCRIPTION("<p>Deprecated (use Transport instead)</p>"),
VALUES("false","true","default")),
ENUM("Transport", NULL, 1, "default",
MEMBER(transport_selector),
FUNCTIONS(0, uf_transport_selector, 0, pf_transport_selector),
DESCRIPTION(
"<p>This element allows selecting the transport to be used (udp, udp6, "
"tcp, tcp6, raweth)</p>"),
VALUES("default","udp","udp6","tcp","tcp6","raweth")),
BOOL("EnableMulticastLoopback", NULL, 1, "true",
MEMBER(enableMulticastLoopback),
FUNCTIONS(0, uf_boolean, 0, pf_boolean),
DESCRIPTION(
"<p>This element specifies whether Cyclone DDS allows IP multicast "
"packets to be visible to all DDSI participants in the same node, "
"including itself. It must be \"true\" for intra-node multicast "
"communications. However, if a node runs only a single Cyclone DDS service "
"and does not host any other DDSI-capable programs, it should be set "
"to \"false\" for improved performance.</p>")),
STRING("MaxMessageSize", NULL, 1, "14720 B",
MEMBER(max_msg_size),
FUNCTIONS(0, uf_memsize, 0, pf_memsize),
DESCRIPTION(
"<p>This element specifies the maximum size of the UDP payload that "
"Cyclone DDS will generate. Cyclone DDS will try to maintain this limit within "
"the bounds of the DDSI specification, which means that in some cases "
"(especially for very low values of MaxMessageSize) larger payloads "
"may sporadically be observed (currently up to 1192 B).</p>\n"
"<p>On some networks it may be necessary to set this item to keep the "
"packetsize below the MTU to prevent IP fragmentation.</p>"),
UNIT("memsize")),
STRING("MaxRexmitMessageSize", NULL, 1, "1456 B",
MEMBER(max_rexmit_msg_size),
FUNCTIONS(0, uf_memsize, 0, pf_memsize),
DESCRIPTION(
"<p>This element specifies the maximum size of the UDP payload that "
"Cyclone DDS will generate for a retransmit. Cyclone DDS will try to "
"maintain this limit within the bounds of the DDSI specification, which "
"means that in some cases (especially for very low values) larger payloads "
"may sporadically be observed (currently up to 1192 B).</p>\n"
"<p>On some networks it may be necessary to set this item to keep the "
"packetsize below the MTU to prevent IP fragmentation.</p>"),
UNIT("memsize")),
STRING("FragmentSize", NULL, 1, "1344 B",
MEMBER(fragment_size),
FUNCTIONS(0, uf_memsize16, 0, pf_memsize16),
DESCRIPTION(
"<p>This element specifies the size of DDSI sample fragments generated "
"by Cyclone DDS. Samples larger than FragmentSize are fragmented into "
"fragments of FragmentSize bytes each, except the last one, which may "
"be smaller. The DDSI spec mandates a minimum fragment size of 1025 "
"bytes, but Cyclone DDS will do whatever size is requested, accepting "
"fragments of which the size is at least the minimum of 1025 and "
"FragmentSize.</p>"),
UNIT("memsize")),
BOOL("RedundantNetworking", NULL, 1, "false",
MEMBER(redundant_networking),
FUNCTIONS(0, uf_boolean, 0, pf_boolean),
DESCRIPTION(
"<p>When enabled, use selected network interfaces in parallel for "
"redundancy.</p>")),
ENUM("EntityAutoNaming", entity_autonaming_attributes, 1, "empty",
MEMBER(entity_naming_mode),
FUNCTIONS(0, uf_entity_naming_mode, 0, pf_entity_naming_mode),
DESCRIPTION(
"<p>This element specifies the entity autonaming mode. By default set "
"to 'empty' which means no name will be set (but you can still use "
"dds_qset_entity_name). When set to 'fancy' participants, publishers, "
"subscribers, writers, and readers will get randomly generated names. "
"An autonamed entity will share a 3-letter prefix with their parent "
"entity.</p>"),
VALUES("empty","fancy")),
END_MARKER
};
#ifdef DDS_HAS_SECURITY
static struct cfgelem authentication_library_attributes[] = {
STRING("path", NULL, 1, "dds_security_auth",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.authentication_plugin.library_path),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This element points to the path of the Authentication plugin library.</p>\n"
"<p>It can be either absolute path excluding file extension "
"( /usr/lib/dds_security_auth ) or single file without extension "
"( dds_security_auth ).</p>\n"
"<p>If a single file is supplied, the library is located by the "
"current working directory, or LD_LIBRARY_PATH for Unix systems, and "
"PATH for Windows systems.</p>"
)),
STRING("initFunction", NULL, 1, "init_authentication",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.authentication_plugin.library_init),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This element names the initialization function of the Authentication "
"plugin. This function is called after loading the plugin library for "
"instantiation purposes. The Init function must return an object that "
"implements the DDS Security Authentication interface.</p>"
)),
STRING("finalizeFunction", NULL, 1, "finalize_authentication",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.authentication_plugin.library_finalize),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This element names the finalization function of the Authentication "
"plugin. This function is called to let the plugin release its "
"resources.</p>"
)),
END_MARKER
};
static struct cfgelem access_control_library_attributes[] = {
STRING("path", NULL, 1, "dds_security_ac",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.access_control_plugin.library_path),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This element points to the path of Access Control plugin library.</p>\n"
"<p>It can be either absolute path excluding file extension "
"( /usr/lib/dds_security_ac ) or single file without extension "
"( dds_security_ac ).</p>\n"
"<p>If a single file is supplied, the library is located by the "
"current working directory, or LD_LIBRARY_PATH for Unix systems, and "
"PATH for Windows systems.</p>"
)),
STRING("initFunction", NULL, 1, "init_access_control",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.access_control_plugin.library_init),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This element names the initialization function of Access Control "
"plugin. This function is called after loading the plugin library for "
"instantiation purposes. The Init function must return an object that "
"implements the DDS Security Access Control interface.</p>"
)),
STRING("finalizeFunction", NULL, 1, "finalize_access_control",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.access_control_plugin.library_finalize),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This element names the finalization function of Access Control "
"plugin. This function is called to let the plugin release its "
"resources.</p>"
)),
END_MARKER
};
static struct cfgelem cryptography_library_attributes[] = {
STRING("path", NULL, 1, "dds_security_crypto",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.cryptography_plugin.library_path),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This element points to the path of the Cryptographic plugin library.</p>\n"
"<p>It can be either absolute path excluding file extension "
"( /usr/lib/dds_security_crypto ) or single file without extension "
"( dds_security_crypto ).</p>\n"
"<p>If a single file is supplied, the is library located by the "
"current working directory, or LD_LIBRARY_PATH for Unix systems, and "
"PATH for Windows systems.</p>"
)),
STRING("initFunction", NULL, 1, "init_crypto",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.cryptography_plugin.library_init),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This element names the initialization function of the Cryptographic "
"plugin. This function is called after loading the plugin library for "
"instantiation purposes. The Init function must return an object that "
"implements the DDS Security Cryptographic interface.</p>"
)),
STRING("finalizeFunction", NULL, 1, "finalize_crypto",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.cryptography_plugin.library_finalize),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This element names the finalization function of the Cryptographic "
"plugin. This function is called to let the plugin release its "
"resources.</p>"
)),
END_MARKER
};
static struct cfgelem authentication_config_elements[] = {
STRING("Library", authentication_library_attributes, 1, "",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.authentication_plugin),
FUNCTIONS(0, 0, 0, pf_string),
DESCRIPTION(
"<p>This element specifies the library to be loaded as the DDS "
"Security Access Control plugin.</p>"
)),
STRING("IdentityCertificate", NULL, 1, NULL,
MEMBEROF(ddsi_config_omg_security_listelem, cfg.authentication_properties.identity_certificate),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>An identity certificate will identify all participants "
"in the OSPL instance.<br>The content is URI to an X509 "
"certificate signed by the IdentityCA in PEM format containing the "
"signed public key.</p>\n"
"<p>Supported URI schemes: file, data</p>\n"
"<p>Examples:</p>\n"
"<p><IdentityCertificate>file:participant1_identity_cert.pem</IdentityCertificate></p>\n"
"<p><IdentityCertificate>data:,-----BEGIN CERTIFICATE-----<br>\n"
"MIIDjjCCAnYCCQDCEu9...6rmT87dhTo=<br>\n"
"-----END CERTIFICATE-----</IdentityCertificate></p>"
)),
STRING("IdentityCA", NULL, 1, NULL,
MEMBEROF(ddsi_config_omg_security_listelem, cfg.authentication_properties.identity_ca),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>URI to the X509 certificate [39] of the Identity CA that is the "
"signer of Identity Certificate.</p>\n"
"<p>Supported URI schemes: file, data</p>\n"
"<p>The file and data schemas shall refer to a X.509 v3 certificate "
"(see X.509 v3 ITU-T Recommendation X.509 (2005) [39]) in PEM format.</p>\n"
"<p>Examples:</p>\n"
"<p><IdentityCA>file:identity_ca.pem</IdentityCA></p>\n"
"<p><IdentityCA>data:,-----BEGIN CERTIFICATE-----<br>\n"
"MIIC3DCCAcQCCQCWE5x+Z...PhovK0mp2ohhRLYI0ZiyYQ==<br>\n"
"-----END CERTIFICATE-----</IdentityCA></p>"
)),
STRING("PrivateKey", NULL, 1, NULL,
MEMBEROF(ddsi_config_omg_security_listelem, cfg.authentication_properties.private_key),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>URI to access the private Private Key for all of the participants "
"in the OSPL federation.</p>\n"
"<p>Supported URI schemes: file, data</p>\n"
"<p>Examples:</p>\n"
"<p><PrivateKey>file:identity_ca_private_key.pem</PrivateKey></p>\n"
"<p><PrivateKey>data:,-----BEGIN RSA PRIVATE KEY-----<br>\n"
"MIIEpAIBAAKCAQEA3HIh...AOBaaqSV37XBUJg==<br>\n"
"-----END RSA PRIVATE KEY-----</PrivateKey></p>"
)),
STRING("Password", NULL, 1, "",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.authentication_properties.password),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>A password is used to decrypt the private_key.</p>\n"
"<p>The value of the password property shall be interpreted as the "
"Base64 encoding of the AES-128 key that shall be used to decrypt the "
"private_key using AES128-CBC.</p>\n"
"<p>If the password property is not present, then the value supplied in "
"the private_key property must contain the unencrypted private key.</p>"
)),
STRING("TrustedCADirectory", NULL, 1, "",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.authentication_properties.trusted_ca_dir),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>Trusted CA Directory which contains trusted CA certificates as "
"separated files.</p>"
)),
STRING("CRL", NULL, 1, "",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.authentication_properties.crl),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>Optional URI to load an X509 Certificate Revocation List</p>\n"
"<p>Supported URI schemes: file, data</p>\n"
"<p>Examples:</p>\n"
"<p><CRL>file:crl.pem</CRL></p>\n"
"<p><CRL>data:,-----BEGIN X509 CRL-----<br>\n"
"MIIEpAIBAAKCAQEA3HIh...AOBaaqSV37XBUJg=<br>\n"
"-----END X509 CRL-----</CRL></p>"
)),
BOOL("IncludeOptionalFields", NULL, 1, "false",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.authentication_properties.include_optional_fields),
FUNCTIONS(0, uf_boolean, 0, pf_boolean),
DESCRIPTION(
"<p>The authentication handshake tokens may contain optional fields to "
"be included for finding interoperability problems. If this parameter "
"is set to true the optional fields are included in the handshake token "
"exchange.</p>"
)),
END_MARKER
};
static struct cfgelem access_control_config_elements[] = {
STRING("Library", access_control_library_attributes, 1, "",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.access_control_plugin),
FUNCTIONS(0, 0, 0, pf_string),
DESCRIPTION(
"<p>This element specifies the library to be loaded as the "
"DDS Security Access Control plugin.</p>"
)),
STRING("PermissionsCA", NULL, 1, "",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.access_control_properties.permissions_ca),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>URI to an X509 certificate for the PermissionsCA in PEM format.</p>\n"
"<p>Supported URI schemes: file, data</p>\n"
"<p>The file and data schemas shall refer to a X.509 v3 certificate "
"(see X.509 v3 ITU-T Recommendation X.509 (2005) [39]) in PEM format.</p><br>\n"
"<p>Examples:</p><br>\n"
"<p><PermissionsCA>file:permissions_ca.pem</PermissionsCA></p>\n"
"<p><PermissionsCA>file:/home/myuser/permissions_ca.pem</PermissionsCA></p><br>\n"
"<p><PermissionsCA>data:<strong>,</strong>-----BEGIN CERTIFICATE-----</p>\n"
"<p>MIIC3DCCAcQCCQCWE5x+Z ... PhovK0mp2ohhRLYI0ZiyYQ==</p>\n"
"<p>-----END CERTIFICATE-----</PermissionsCA></p>"
)),
STRING("Governance", NULL, 1, "",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.access_control_properties.governance),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>URI to the shared Governance Document signed by the Permissions CA in S/MIME format</p>\n"
"<p>URI schemes: file, data</p><br>\n"
"<p>Examples file URIs:</p>\n"
"<p><Governance>file:governance.smime</Governance></p>\n"
"<p><Governance>file:/home/myuser/governance.smime</Governance></p><br>\n"
"<p><Governance><![CDATA[data:,MIME-Version: 1.0</p>\n"
"<p>Content-Type: multipart/signed; protocol=\"application/x-pkcs7-signature\"; micalg=\"sha-256\"; boundary=\"----F9A8A198D6F08E1285A292ADF14DD04F\"</p>\n"
"<p>This is an S/MIME signed message </p>\n"
"<p>------F9A8A198D6F08E1285A292ADF14DD04F</p>\n"
"<p><?xml version=\"1.0\" encoding=\"UTF-8\"?></p>\n"
"<p><dds xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"</p>\n"
"<p>xsi:noNamespaceSchemaLocation=\"omg_shared_ca_governance.xsd\"></p>\n"
"<p><domain_access_rules></p>\n"
"<p> . . . </p>\n"
"<p></domain_access_rules></p>\n"
"<p></dds></p>\n"
"<p>...</p>\n"
"<p>------F9A8A198D6F08E1285A292ADF14DD04F</p>\n"
"<p>Content-Type: application/x-pkcs7-signature; name=\"smime.p7s\"</p>\n"
"<p>Content-Transfer-Encoding: base64</p>\n"
"<p>Content-Disposition: attachment; filename=\"smime.p7s\"</p>\n"
"<p>MIIDuAYJKoZIhv ...al5s=</p>\n"
"<p>------F9A8A198D6F08E1285A292ADF14DD04F-]]</Governance></p>"
)),
STRING("Permissions", NULL, 1, "",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.access_control_properties.permissions),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>URI to the DomainParticipant permissions document signed by the "
"Permissions CA in S/MIME format</p>\n"
"<p>The permissions document specifies the permissions to be applied to a domain.</p><br>\n"
"<p>Example file URIs:</p>\n"
"<p><Permissions>file:permissions_document.p7s</Permissions></p>\n"
"<p><Permissions>file:/path_to/permissions_document.p7s</Permissions></p>\n"
"<p>Example data URI:</p>\n"
"<p><Permissions><![CDATA[data:,.........]]</Permissions></p>"
)),
END_MARKER
};
static struct cfgelem cryptography_config_elements[] = {
STRING("Library", cryptography_library_attributes, 1, "",
MEMBEROF(ddsi_config_omg_security_listelem, cfg.cryptography_plugin),
FUNCTIONS(0, 0, 0, pf_string),
DESCRIPTION(
"<p>This element specifies the library to be loaded as the DDS Security Cryptographic plugin.</p>"
)),
END_MARKER
};
static struct cfgelem security_omg_config_elements[] = {
GROUP("Authentication", authentication_config_elements, NULL, 1,
NOMEMBER,
NOFUNCTIONS,
DESCRIPTION(
"<p>This element configures the Authentication plugin of the DDS Security specification.</p>"
)),
GROUP("AccessControl", access_control_config_elements, NULL, 1,
NOMEMBER,
NOFUNCTIONS,
DESCRIPTION(
"<p>This element configures the Access Control plugin of the DDS Security specification.</p>"
)),
GROUP("Cryptographic", cryptography_config_elements, NULL, 1,
NOMEMBER,
NOFUNCTIONS,
DESCRIPTION(
"<p>This element configures the Cryptographic plugin of the DDS Security specification.</p>"
)),
END_MARKER
};
#endif /* DDS_HAS_SECURITY */
#ifdef DDS_HAS_NETWORK_PARTITIONS
static struct cfgelem networkpartition_cfgattrs[] = {
STRING("Name", NULL, 1, NULL,
MEMBEROF(ddsi_config_networkpartition_listelem, name),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This attribute specifies the name of this Cyclone DDS network "
"partition. Two network partitions cannot have the same name. "
"Partition mappings (cf. Partitioning/PartitionMappings) refer to "
"network partitions using these names.</p>")),
STRING("Address", NULL, 1, NULL,
MEMBEROF(ddsi_config_networkpartition_listelem, address_string),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This attribute specifies the addresses associated with "
"the network partition as a comma-separated list. The addresses "
"are typically multicast addresses. Non-multicast addresses are "
"allowed, provided the \"Interface\" attribute is not used:</p>"
"<ul>"
"<li>An address matching the address or the \"external address\" "
"(see General/ExternalNetworkAddress; default is the actual "
"address) of a configured interface results in adding the "
"corresponding \"external\" address to the set of advertised "
"unicast addresses.</li>"
"<li>An address corresponding to the (external) address of a "
"configured interface, but not the address of the host itself, "
"for example, a match when masking the addresses with the netmask "
"for IPv4, results in adding the external address. For IPv4, "
"this requires the host part to be all-zero.</li>"
"</ul>"
"<p>Readers matching this network partition (cf. "
"Partitioning/PartitionMappings) will advertise all addresses "
"listed to the matching writers via the discovery protocol and "
"will join the specified multicast groups. The writers will select "
"the most suitable address from the addresses advertised by the "
"readers.</p>"
"<p>The unicast addresses advertised by a reader are the only "
"unicast addresses a writer will use to send data to it and are "
"used to select the subset of network interfaces to use for "
"transmitting multicast data with the intent of reaching it.</p>")),
STRING("Interface", NULL, 1, "",
MEMBEROF(ddsi_config_networkpartition_listelem, interface_names),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This attribute takes a comma-separated list of interface "
"name that the reader is willing to receive data on. This is "
"implemented by adding the interface addresses to the set address "
"set configured using the sibling \"Address\" attribute. See "
"there for more details.</p>")),
END_MARKER
};
static struct cfgelem networkpartitions_cfgelems[] = {
STRING("NetworkPartition", networkpartition_cfgattrs, INT_MAX, 0,
MEMBER(networkPartitions),
FUNCTIONS(if_network_partition, 0, 0, 0),
DESCRIPTION(
"<p>This element defines a Cyclone DDS network partition.</p>"
)),
END_MARKER
};
static struct cfgelem ignoredpartitions_cfgattrs[] = {
STRING("DCPSPartitionTopic", NULL, 1, NULL,
MEMBEROF(ddsi_config_ignoredpartition_listelem, DCPSPartitionTopic),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This attribute specifies a partition and a topic expression, "
"separated by a single '.', which are used to determine if a given "
"partition and topic will be ignored or not. The expressions may use "
"the usual wildcards '*' and '?'. Cyclone DDS will consider a wildcard "
"DCPS partition to match an expression if a string that satisfies "
"both expressions exists.</p>"
)),
END_MARKER
};
static struct cfgelem ignoredpartitions_cfgelems[] = {
STRING("IgnoredPartition", ignoredpartitions_cfgattrs, INT_MAX, 0,
MEMBER(ignoredPartitions),
FUNCTIONS(if_ignored_partition, 0, 0, 0),
DESCRIPTION(
"<p>This element can prevent certain combinations of DCPS "
"partition and topic from being transmitted over the network. Cyclone DDS "
"will completely ignore readers and writers for which all DCPS "
"partitions as well as their topic is ignored, not even creating DDSI "
"readers and writers to mirror the DCPS ones.</p>"
)),
END_MARKER
};
static struct cfgelem partitionmappings_cfgattrs[] = {
STRING("NetworkPartition", NULL, 1, NULL,
MEMBEROF(ddsi_config_partitionmapping_listelem, networkPartition),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This attribute specifies which Cyclone DDS network partition is to be "
"used for DCPS partition/topic combinations matching the "
"DCPSPartitionTopic attribute within this PartitionMapping element.</p>"
)),
STRING("DCPSPartitionTopic", NULL, 1, NULL,
MEMBEROF(ddsi_config_partitionmapping_listelem, DCPSPartitionTopic),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>This attribute specifies a partition and a topic expression, "
"separated by a single '.', which are used to determine if a given "
"partition and topic maps to the Cyclone DDS network partition named by the "
"NetworkPartition attribute in this PartitionMapping element. The "
"expressions may use the usual wildcards '*' and '?'. Cyclone DDS will "
"consider a wildcard DCPS partition to match an expression if there "
"exists a string that satisfies both expressions.</p>"
)),
END_MARKER
};
static struct cfgelem partitionmappings_cfgelems[] = {
STRING("PartitionMapping", partitionmappings_cfgattrs, INT_MAX, 0,
MEMBER(partitionMappings),
FUNCTIONS(if_partition_mapping, 0, 0, 0),
DESCRIPTION(
"<p>This element defines a mapping from a DCPS partition/topic "
"combination to a Cyclone DDS network partition. This allows partitioning "
"data flows by using special multicast addresses for part of the data "
"and possibly encrypting the data flow.</p>"
)),
END_MARKER
};
static struct cfgelem partitioning_cfgelems[] = {
GROUP("NetworkPartitions", networkpartitions_cfgelems, NULL, 1,
NOMEMBER,
NOFUNCTIONS,
DESCRIPTION(
"<p>The NetworkPartitions element specifies the Cyclone DDS network "
"partitions.</p>"
)),
GROUP("IgnoredPartitions", ignoredpartitions_cfgelems, NULL, 1,
NOMEMBER,
NOFUNCTIONS,
DESCRIPTION(
"<p>The IgnoredPartitions element specifies DCPS partition/topic "
"combinations that are not distributed over the network.</p>"
)),
GROUP("PartitionMappings", partitionmappings_cfgelems, NULL, 1,
NOMEMBER,
NOFUNCTIONS,
DESCRIPTION(
"<p>The PartitionMappings element specifies the mapping from DCPS "
"partition/topic combinations to Cyclone DDS network partitions.</p>"
)),
END_MARKER
};
#endif /* DDS_HAS_NETWORK_PARTITIONS */
static struct cfgelem thread_properties_sched_cfgelems[] = {
ENUM("Class", NULL, 1, "default",
MEMBEROF(ddsi_config_thread_properties_listelem, sched_class),
FUNCTIONS(0, uf_sched_class, 0, pf_sched_class),
DESCRIPTION(
"<p>This element specifies the thread scheduling class "
"(<i>realtime</i>, <i>timeshare</i> or <i>default</i>). The user may "
"need special privileges from the underlying operating system to be "
"able to assign some of the privileged scheduling classes.</p>"),
VALUES("realtime","timeshare","default")),
STRING("Priority", NULL, 1, "default",
MEMBEROF(ddsi_config_thread_properties_listelem, schedule_priority),
FUNCTIONS(0, uf_maybe_int32, 0, pf_maybe_int32),
DESCRIPTION(
"<p>This element specifies the thread priority (decimal integer or "
"<i>default</i>). Only priorities supported by the underlying "
"operating system can be assigned to this element. The user may need "
"special privileges from the underlying operating system to be able to "
"assign some of the privileged priorities.</p>"
)),
END_MARKER
};
static struct cfgelem thread_properties_cfgattrs[] = {
STRING("Name", NULL, 1, NULL,
MEMBEROF(ddsi_config_thread_properties_listelem, name),
FUNCTIONS(0, uf_string, ff_free, pf_string),
DESCRIPTION(
"<p>The Name of the thread for which properties are being set. The "
"following threads exist:</p>\n"
"<ul>\n"
"<li><i>gc</i>: "
"garbage collector thread involved in deleting entities;</li>\n"
"<li><i>recv</i>: "
"receive thread, taking data from the network and running the protocol "
"state machine;</li>\n"
"<li><i>dq.builtins</i>: "
"delivery thread for DDSI-builtin data, primarily for discovery;</li>\n"
"<li><i>lease</i>: "
"DDSI liveliness monitoring;</li>\n"
"<li><i>tev</i>: "
"general timed-event handling, retransmits and discovery;</li>\n"
"<li><i>fsm</i>: "
"finite state machine thread for handling security handshake;</li>\n"
"<li><i>xmit.CHAN</i>: "
"transmit thread for channel CHAN;</li>\n"
"<li><i>dq.CHAN</i>: "
"delivery thread for channel CHAN;</li>\n"
"<li><i>tev.CHAN</i>: "
"timed-event thread for channel CHAN.</li></ul>"
)),
END_MARKER
};
static struct cfgelem thread_properties_cfgelems[] = {
GROUP("Scheduling", thread_properties_sched_cfgelems, NULL, 1,
NOMEMBER,
NOFUNCTIONS,
DESCRIPTION(
"<p>This element configures the scheduling properties of the thread.</p>"
)),
STRING("StackSize", NULL, 1, "default",
MEMBEROF(ddsi_config_thread_properties_listelem, stack_size),
FUNCTIONS(0, uf_maybe_memsize, 0, pf_maybe_memsize),
DESCRIPTION(
"<p>This element configures the stack size for this thread. The "
"default value <i>default</i> leaves the stack size at the operating "
"system default.</p>"),
UNIT("memsize")),
END_MARKER
};
static struct cfgelem threads_cfgelems[] = {
GROUP("Thread", thread_properties_cfgelems, thread_properties_cfgattrs, INT_MAX,
MEMBER(thread_properties),
FUNCTIONS(if_thread_properties, 0, 0, 0),
DESCRIPTION("<p>This element is used to set thread properties.</p>")),
END_MARKER
};
static struct cfgelem compatibility_cfgelems[] = {
ENUM("StandardsConformance", NULL, 1, "lax",
MEMBER(standards_conformance),
FUNCTIONS(0, uf_standards_conformance, 0, pf_standards_conformance),
DESCRIPTION(
"<p>This element sets the level of standards conformance of this "
"instance of the Cyclone DDS Service. Stricter conformance typically means "
"less interoperability with other implementations. Currently, three "
"modes are defined:</p>\n"
"<ul><li><i>pedantic</i>: very strictly conform to the specification, "
"ultimately for compliance testing, but currently of little value "
"because it adheres even to what will most likely turn out to be "
"editing errors in the DDSI standard. Arguably, as long as no errata "
"have been published, the current text is in effect, and "
"that is what pedantic currently does.</li>\n"
"<li><i>strict</i>: a relatively less strict view of the standard than "
"does pedantic: it follows the established behaviour where the "
"standard is obviously in error.</li>\n"
"<li><i>lax</i>: attempt to provide the smoothest possible "
"interoperability, anticipating future revisions of elements in the "
"standard in areas that other implementations do not adhere to, even "
"though there is no good reason not to.</li></ul>"),
VALUES("lax","strict","pedantic")),
BOOL("ExplicitlyPublishQosSetToDefault", NULL, 1, "false",
MEMBER(explicitly_publish_qos_set_to_default),
FUNCTIONS(0, uf_boolean, 0, pf_boolean),
DESCRIPTION(
"<p>This element specifies whether QoS settings set to default values "
"are explicitly published in the discovery protocol. Implementations "
"are to use the default value for QoS settings not published, which "
"allows a significant reduction of the amount of data that needs to be "
"exchanged for the discovery protocol, but this requires all "
"implementations to adhere to the default values specified by the "
"specifications.</p>\n"
"<p>When interoperability is required with an implementation that does "
"not follow the specifications in this regard, setting this option to "
"true will help.</p>"
)),
ENUM("ManySocketsMode", NULL, 1, "single",
MEMBER(many_sockets_mode),
FUNCTIONS(0, uf_many_sockets_mode, 0, pf_many_sockets_mode),
DESCRIPTION(
"<p>This option specifies whether a network socket will be created for "
"each domain participant on a host. The specification seems to assume "
"that each participant has a unique address, and setting this option "
"will ensure this to be the case. This is not the default.</p>\n"
"<p>Disabling it slightly improves performance and reduces network "
"traffic somewhat. It also causes the set of port numbers needed by "
"Cyclone DDS to become predictable, which may be useful for firewall and "
"NAT configuration.</p>"),
VALUES("false","true","single","none","many")),
BOOL("AssumeRtiHasPmdEndpoints", NULL, 1, "false",
MEMBER(assume_rti_has_pmd_endpoints),
FUNCTIONS(0, uf_boolean, 0, pf_boolean),
DESCRIPTION(
"<p>This option assumes ParticipantMessageData endpoints required by "
"the liveliness protocol are present in RTI participants even when not "
"properly advertised by the participant discovery protocol.</p>"
)),
END_MARKER
};
static struct cfgelem internal_test_cfgelems[] = {
INT("XmitLossiness", NULL, 1, "0",
MEMBER(xmit_lossiness),
FUNCTIONS(0, uf_int, 0, pf_int),
DESCRIPTION(
"<p>This element controls the fraction of outgoing packets to drop, "
"specified as samples per thousand.</p>"
)),
END_MARKER
};
static struct cfgelem internal_watermarks_cfgelems[] = {
STRING("WhcLow", NULL, 1, "1 kB",
MEMBER(whc_lowwater_mark),
FUNCTIONS(0, uf_memsize, 0, pf_memsize),
DESCRIPTION(
"<p>This element sets the low-water mark for the Cyclone DDS WHCs, "
"expressed in bytes. A suspended writer resumes transmitting when its "
"Cyclone DDS WHC shrinks to this size.</p>"),
UNIT("memsize")),
STRING("WhcHigh", NULL, 1, "500 kB",
MEMBER(whc_highwater_mark),
FUNCTIONS(0, uf_memsize, 0, pf_memsize),
DESCRIPTION(
"<p>This element sets the maximum allowed high-water mark for the "
"Cyclone DDS WHCs, expressed in bytes. A writer is suspended when the WHC "
"reaches this size.</p>"),
UNIT("memsize")),
STRING("WhcHighInit", NULL, 1, "30 kB",
MEMBER(whc_init_highwater_mark),