The unit must be specified explicitly. Recognised units: Xb/s, Xbps for bits/s or XB/s, XBps for bytes/s; where X is an optional prefix: k for 103, Ki for 210, M for 106, Mi for 220, G for 109, Gi for 230.
", - "memsize" => "\nThe unit must be specified explicitly. Recognised units: B (bytes), kB & KiB (210 bytes), MB & MiB (220 bytes), GB & GiB (230 bytes).
", - "duration" => "\nThe unit must be specified explicitly. Recognised units: ns, us, ms, s, min, hr, day.
", - "duration_inf" => "\nValid values are finite durations with an explicit unit or the keyword 'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, day.
"); - -my %unit_patterns = - ("memsize" => '0|(\d+(\.\d*)?([Ee][\-+]?\d+)?|\.\d+([Ee][\-+]?\d+)?) *([kMG]i?)?B', - "bandwidth" => '0|(\d+(\.\d*)?([Ee][\-+]?\d+)?|\.\d+([Ee][\-+]?\d+)?) *([kMG]i?)?[Bb][p/]s', - "duration" => '0|(\d+(\.\d*)?([Ee][\-+]?\d+)?|\.\d+([Ee][\-+]?\d+)?) *([num]?s|min|hr|day)', - "duration_inf" => 'inf|0|(\d+(\.\d*)?([Ee][\-+]?\d+)?|\.\d+([Ee][\-+]?\d+)?) *([num]?s|min|hr|day)'); - -while (my ($k, $v) = each %typehint2xmltype) { - die "script error: values of enum type $k unknown\n" if $v eq "Enum" && $enum_values{$k} eq ""; -} - -my %elem; -my %typehint_seen; - -my %tables; - -my @root = read_config ($input); - -{ - open my $fh, ">:unix", "$output_rnc" or die "can't open $output_rnc"; - print $fh "default namespace = \"https://cdds.io/config\"\n"; - print $fh "namespace a = \"http://relaxng.org/ns/compatibility/annotations/1.0\"\n"; - print $fh "grammar {\n"; - print $fh " start =\n"; - my $isfirst = 1; - conv_table($fh, \&conv_to_rnc, \@root, "/", " ", "", \$isfirst); - for (sort keys %unit_patterns) { - printf $fh " %s = xsd:token { pattern = \"%s\" }\n", $_, $unit_patterns{$_}; - } - print $fh "}\n"; - close $fh; -} - -{ - open my $fh, ">:unix", "$output_md" or die "can't open $output_md"; - my $sep_blurb = ""; - conv_table($fh, \&conv_to_md, \@root, "/", " ", "", \$sep_blurb); - close $fh; -} - -exit 0; - -sub clean_description { - my ($desc) = @_; - $desc =~ s/^\s*BLURB\s*\(\s*//s; - $desc =~ s/^\s*"//s; - $desc =~ s/\s*"(\s*\))? *(\}\s*,\s*$)?$//s; - $desc =~ s/\\"/"/g; - $desc =~ s/\\n\s*\\/\n/g; - $desc =~ s/\\\\/\\/g; - $desc =~ s/\n\n/\n/g; - # should fix the source ... - $desc =~ s/DDSI2E?/Cyclone DDS/g; - return $desc; -} - -sub html_to_md { - my ($desc) = @_; - $desc =~ s/^\<\/p\>//gs; - $desc =~ s/\<\/p\>//gs; - $desc =~ s//^/s; - $desc =~ s/<\/sup>//s; - $desc =~ s/\The default value is: "$defaultvalue".
" if defined $defaultvalue; - my $fs; - push @{$tables{$table}}, { table => $table, name => $name, - kind => $kind, kstr => $kstr, - subtables => $subtables, multiplicity => $multiplicity, - min_occ => $min_occ, max_occ => $max_occ, root => 0, - defaultvalue => $defaultvalue, typehint => $typehint, - description => $desc }; - # typehint_seen is for verifying no bogus type hints are defined in this script - $typehint_seen{$typehint} = 1; -} - -sub fmtblurb { - my ($blurb) = @_; - my $isbullet = ($blurb =~ s/^\* //); - my $maxlen = $isbullet ? 78 : 74; - my @words = split ' ', $blurb; - my @lines = (); - while (@words > 0) { - my $x = shift @words; - while (@words > 0 && (length $x) + 1 + (length $words[0]) < $maxlen) { - $x .= " " . shift @words; - } - push @lines, "$x"; - } - my $sep = "\n" . ($isbullet ? " " : ""); - return ($isbullet ? "* " : "") . join $sep, @lines; -} - -sub print_description_rnc { - my ($fh, $desc, $indent) = @_; - my $x = $desc; - my @xs = split /\n+/, $x; - $_ = fmtblurb ($_) for @xs; - $x = join "\n\n", @xs; - return 0 if $x =~ /^\s$/s; - print $fh "[ a:documentation [ xml:lang=\"en\" \"\"\"\n$x\"\"\" ] ]\n"; - return 1; -} - -sub print_description_md { - my ($fh, $desc, $indent) = @_; - my $x = html_to_md ($desc); - my @xs = split /\n+/, $x; - $_ = fmtblurb ($_) for @xs; - $x = join "\n\n", @xs; - return 0 if $x =~ /^\s$/s; - print $fh "$x\n"; - return 1; -} - -sub conv_to_rnc { - my ($fh, $fs, $name, $fqname, $indent, $prefix, $isfirstref) = @_; - - printf $fh "${indent}%s", ($$isfirstref ? "" : "& "); - print_description_rnc ($fh, $fs->{description}, $indent); - printf $fh "${indent}%s %s {\n", ($fs->{kind} eq "ATTR" ? "attribute" : "element"), $name; - - my $sub_isfirst = 1; - conv_table($fh, \&conv_to_rnc, $fs->{subtables}, $fqname, "${indent} ", $prefix, \$sub_isfirst); - my $sep = $sub_isfirst ? "" : "& "; - - if ($fs->{kind} eq "GROUP" || $fs->{kind} eq "MGROUP") { - printf $fh "${indent} ${sep}empty\n" if $sub_isfirst; - } elsif ($fs->{kstr} eq "Boolean") { - printf $fh "${indent} ${sep}xsd:boolean\n"; - } elsif ($fs->{kstr} eq "Comma") { - die unless exists $comma_values{$fs->{typehint}}; - my $pat = ""; - my @xs = split /\|/, $comma_values{$fs->{typehint}}; - my $allowempty = 0; - for (@xs) { - if ($_ eq "") { $allowempty = 1; next; } - (my $vs = $_) =~ s/;/|/g; - $pat .= "|" unless $pat eq ""; - if ($vs =~ /\|/) { - $pat .= "(($vs)(,($vs))*)"; - } else { - $pat .= $vs; - } - } - $pat .= "|" if $allowempty; - printf $fh "${indent} ${sep}xsd:token { pattern = \"%s\" }\n", $pat; - } elsif ($fs->{kstr} eq "Enum") { - die unless exists $enum_values{$fs->{typehint}}; - my @vs = split /;/, $enum_values{$fs->{typehint}}; - printf $fh "${indent} ${sep}(%s)\n", (join '|', map { "\"$_\"" } @vs); - } elsif ($fs->{kstr} eq "Int") { - printf $fh "${indent} ${sep}xsd:integer\n"; - #if (exists $range{$lctn} || exists $range{$fs->{typehint}}) { - # # integer with range - # my $rr = exists $range{$lctn} ? $range{$lctn} : $range{$fs->{typehint}}; - # my @vs = split /;/, $range{$lctn}; - #} - } elsif ($typehint2unit{$fs->{typehint}}) { - # number with unit - printf $fh "${indent} ${sep}$typehint2unit{$fs->{typehint}}\n"; - } elsif ($typehint2xmltype{$fs->{typehint}} =~ /String$/) { - printf $fh "${indent} ${sep}text\n"; - } else { - die; - } - - my $suffix; - if ($fs->{min_occ} == 0) { - $suffix = ($fs->{max_occ} == 1) ? "?" : "*"; - } else { - $suffix = ($fs->{max_occ} == 1) ? "" : "+"; - } - printf $fh "${indent}}%s\n", $suffix; - $$isfirstref = 0; -} - -sub list_children_md { - my ($fh, $fs, $name, $fqname, $indent, $prefix, $children) = @_; - if ($fs->{kind} eq "ATTR") { - push @{$children->{attributes}}, $name; - } else { - push @{$children->{elements}}, $name; - } -} - -sub conv_to_md { - my ($fh, $fs, $name, $fqname, $indent, $prefix, $separator_blurb_ref) = @_; - - print $fh $$separator_blurb_ref; - $$separator_blurb_ref = "\n\n"; - - # Print fully-qualified element/attribute name as a heading, with the heading level - # determined by the nesting level. The nesting level can be computed from the number of - # slashes :) - (my $slashes = $fqname) =~ s/[^\/]//g; - die unless length $slashes >= 2; - my $level = (length $slashes) - 1; - printf $fh "%s $fqname\n", ("#"x$level); - - # Describe type (boolean, integer, &c.); for a group list its attributes and children as - # links to their descriptions - { - my %children = ("attributes" => [], "elements" => []); - conv_table($fh, \&list_children_md, $fs->{subtables}, "", "${indent} ", $prefix, \%children); - if (@{$children{attributes}} > 0) { - my @xs = sort @{$children{attributes}}; - my @ys = map { my $lt = lc "$fqname\[\@$_]"; $lt =~ s/[^a-z0-9]//g; "[$_](#$lt)" } @xs; - printf $fh "Attributes: %s\n\n", (join ', ', @ys); - } - if (@{$children{elements}} > 0) { - my @xs = sort @{$children{elements}}; - my @ys = map { my $lt = lc "$fqname\[\@$_]"; $lt =~ s/[^a-z0-9]//g; "[$_](#$lt)" } @xs; - printf $fh "Children: %s\n\n", (join ', ', @ys); - } - } - - if ($fs->{kind} eq "GROUP" || $fs->{kind} eq "MGROUP") { - # nothing to see here - } elsif ($fs->{kstr} eq "Boolean") { - printf $fh "Boolean\n"; - } elsif ($fs->{kstr} eq "Comma") { - die unless exists $comma_values{$fs->{typehint}}; - my $pat = ""; - my @xs = split /\|/, $comma_values{$fs->{typehint}}; - if (@xs > 1) { - printf $fh "One of:\n"; - } - my $allowempty = 0; - for (@xs) { - if ($_ eq "") { $allowempty = 1; next; } - my @vs = split /;/, $_; - if (@vs > 1) { - printf $fh "* Comma-separated list of: %s\n", (join ', ', @vs); - } else { - printf $fh "* Keyword: %s\n", $vs[0]; - } - } - printf $fh "* Or empty\n" if $allowempty; - } elsif ($fs->{kstr} eq "Enum") { - die unless exists $enum_values{$fs->{typehint}}; - my @vs = split /;/, $enum_values{$fs->{typehint}}; - printf $fh "One of: %s\n", (join ', ', @vs); - } elsif ($fs->{kstr} eq "Int") { - printf $fh "Integer\n"; - #if (exists $range{$lctn} || exists $range{$fs->{typehint}}) { - # # integer with range - # my $rr = exists $range{$lctn} ? $range{$lctn} : $range{$fs->{typehint}}; - # my @vs = split /;/, $range{$lctn}; - #} - } elsif ($typehint2unit{$fs->{typehint}}) { - # number with unit - printf $fh "Number-with-unit\n"; - } elsif ($typehint2xmltype{$fs->{typehint}} =~ /String$/) { - printf $fh "Text\n"; - } else { - die; - } - - # Descriptive text - printf $fh "\n"; - print_description_md ($fh, $fs->{description}, $indent); - - # Generate attributes & children - conv_table($fh, \&conv_to_md, $fs->{subtables}, $fqname, "${indent} ", $prefix, $separator_blurb_ref); -} - -sub conv_table { - my ($fh, $convsub, $tablenames, $fqname, $indent, $prefix, $closure) = @_; - my $elems = 0; - for (@$tablenames) { - next unless exists $tables{$_}; - for my $fs (sort { $a->{name} cmp $b->{name} } @{$tables{$_}}) { - my $fqname1; - if ($fs->{kind} eq "ATTR") { - die unless $elems == 0; - $fqname1 = "${fqname}[\@$fs->{name}]"; - } else { - $fqname1 = "$fqname/$fs->{name}"; - $elems++; - } - my $prefix1 = ($fs->{table} eq "internal_cfgelems") ? "Internal" : $prefix; - &$convsub ($fh, $fs, $fs->{name}, $fqname1, $indent, $prefix1, $closure); - } - } -} - -sub read_config { - my %incl = (# included options - 'DDSI_INCLUDE_SSL' => 1, - 'DDSI_INCLUDE_NETWORK_PARTITIONS' => 1, - 'DDSI_INCLUDE_SSM' => 1, - 'DDSI_INCLUDE_SECURITY' => 1, - # excluded options - 'DDSI_INCLUDE_NETWORK_CHANNELS' => 0, - 'DDSI_INCLUDE_BANDWIDTH_LIMITING' => 0); - my ($input) = @_; - my ($name, $table, $kind, @subtables, $multiplicity, $defaultvalue, $typehint, $description); - my ($gobbling_description, $in_table, $rest, $deprecated); - my @stk = (); # stack of conditional nesting, for each: copy/discard/ignore - open FH, "<", $input or die "can't open $input\n"; - while (The General element specifying Domain related settings.
""" ] ] element Domain { [ a:documentation [ xml:lang="en" """ -Domain id this configuration applies to, or "any" if it applies to all -domain ids.
The default value is: "any".
""" ] ] +Domain id this configuration applies to, or "any" if it applies to all domain ids.
+The default value is: "any".
""" ] ] attribute Id { text }? & [ a:documentation [ xml:lang="en" """ -The Compatibility elements allows specifying various settings related -to compatability with standards and with other DDSI implementations.
""" ] ] +The Compatibility elements allows specifying various settings related to compatability with standards and with other DDSI implementations.
""" ] ] element Compatibility { [ a:documentation [ xml:lang="en" """ -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.
The -default value is: "false".
""" ] ] +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.
+The default value is: "false".
""" ] ] element AssumeRtiHasPmdEndpoints { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -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.
- -When interoperability is required with an implementation that does not -follow the specifications in this regard, setting this option to true -will help.
The default value is: "false".
""" ] ] +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.
+When interoperability is required with an implementation that does not follow the specifications in this regard, setting this option to true will help.
+The default value is: "false".
""" ] ] element ExplicitlyPublishQosSetToDefault { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -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.
- -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.
The default value is: "single".
""" ] ] +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.
+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.
+The default value is: "single".
""" ] ] element ManySocketsMode { ("false"|"true"|"single"|"none"|"many") }? & [ a:documentation [ xml:lang="en" """ -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:
- -The default setting is "lax".
The default value is: -"lax".
""" ] ] +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:
+The default value is: "lax".
""" ] ] element StandardsConformance { ("lax"|"strict"|"pedantic") }? - }* + }? & [ a:documentation [ xml:lang="en" """ -This element is used to configure Cyclone DDS with the DDS Security -specification plugins and settings.
""" ] ] - element DDSSecurity { - [ a:documentation [ xml:lang="en" """ -This element configures the Access Control plugin of the DDS Security -specification.
""" ] ] - element AccessControl { - [ a:documentation [ xml:lang="en" """ -URI to the shared Governance Document signed by the Permissions CA in -S/MIME format
- -URI schemes: file, data
Examples file URIs:
- -Content-Type: multipart/signed;
-protocol="application/x-pkcs7-signature"; micalg="sha-256";
-boundary="----F9A8A198D6F08E1285A292ADF14DD04F" This is an S/MIME signed message ------F9A8A198D6F08E1285A292ADF14DD04F xsi:noNamespaceSchemaLocation="omg_shared_ca_governance.xsd"> . . . ... ------F9A8A198D6F08E1285A292ADF14DD04F Content-Type: application/x-pkcs7-signature; name="smime.p7s" Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="smime.p7s" MIIDuAYJKoZIhv ...al5s= ------F9A8A198D6F08E1285A292ADF14DD04F-]]
The -default value is: "".
""" ] ] - element Governance { - text - }? - & [ a:documentation [ xml:lang="en" """ -This element specifies the library to be loaded as the DDS Security -Access Control plugin.
""" ] ] - element Library { - [ a:documentation [ xml:lang="en" """ -This element names the finalization function of Access Control plugin. -This function is called to let the plugin release its -resources.
The default value is: -"finalize_access_control".
""" ] ] - attribute finalizeFunction { - text - }? - & [ a:documentation [ xml:lang="en" """ -This element names the initialization function of Access Control -plugin. This function is called after loading the plugin library for -instantiation purposes. Init function must return an object that -implements DDS Security Access Control interface.
The default value -is: "init_access_control".
""" ] ] - attribute initFunction { - text - }? - & [ a:documentation [ xml:lang="en" """ -This element points to the path of Access Control plugin library.
- -It can be either absolute path excluding file extension ( -/usr/lib/dds_security_ac ) or single file without extension ( -dds_security_ac ).
- -If single file is supplied, the library located by way of the current -working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for -Windows systems.
The default value is: -"dds_security_ac".
""" ] ] - attribute path { - text - }? - }? - & [ a:documentation [ xml:lang="en" """ -URI to the DomainParticipant permissions document signed by the -Permissions CA in S/MIME format
- -The permissions document specifies the permissions to be applied to a -domain.
Example file URIs:
- -Example data URI:
- -The -default value is: "".
""" ] ] - element Permissions { - text - }? - & [ a:documentation [ xml:lang="en" """ -URI to a X509 certificate for the PermissionsCA in PEM format.
- -Supported URI schemes: file, data
- -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.
Examples:
MIIC3DCCAcQCCQCWE5x+Z ... PhovK0mp2ohhRLYI0ZiyYQ==
- ------END CERTIFICATE-----
The default value is: -"".
""" ] ] - element PermissionsCA { - text - }? - }? - & [ a:documentation [ xml:lang="en" """ -This element configures the Authentication plugin of the DDS Security -specification.
""" ] ] - element Authentication { - [ a:documentation [ xml:lang="en" """ -URI to the X509 certificate [39] of the Identity CA that is the signer -of Identity Certificate.
- -Supported URI schemes: file, data
- -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.
- -Examples:
- -
-
-MIIC3DCCAcQCCQCWE5x+Z...PhovK0mp2ohhRLYI0ZiyYQ==
-
------END CERTIFICATE-----
Identity certificate that will be used for identifying all
-participants in the OSPL instance.
The content is URI to a X509
-certificate signed by the IdentityCA in PEM format containing the signed
-public key.
Supported URI schemes: file, data
- -Examples:
- -
-
-MIIDjjCCAnYCCQDCEu9...6rmT87dhTo=
-
------END CERTIFICATE-----
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.
The default value is: -"false".
""" ] ] - element IncludeOptionalFields { - xsd:boolean - }? - & [ a:documentation [ xml:lang="en" """ -This element specifies the library to be loaded as the DDS Security -Access Control plugin.
""" ] ] - element Library { - [ a:documentation [ xml:lang="en" """ -This element names the finalization function of Authentication plugin. -This function is called to let the plugin release its -resources.
The default value is: -"finalize_authentication".
""" ] ] - attribute finalizeFunction { - text - }? - & [ a:documentation [ xml:lang="en" """ -This element names the initialization function of Authentication -plugin. This function is called after loading the plugin library for -instantiation purposes. Init function must return an object that -implements DDS Security Authentication interface.
The default value -is: "init_authentication".
""" ] ] - attribute initFunction { - text - }? - & [ a:documentation [ xml:lang="en" """ -This element points to the path of Authentication plugin library.
- -It can be either absolute path excluding file extension ( -/usr/lib/dds_security_auth ) or single file without extension ( -dds_security_auth ).
- -If single file is supplied, the library located by way of the current -working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for -Windows systems.
The default value is: -"dds_security_auth".
""" ] ] - attribute path { - text - }? - }? - & [ a:documentation [ xml:lang="en" """ -A password used to decrypt the private_key.
- -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. - -If the password property is not present, then the value supplied in the -private_key property must contain the unencrypted private key.The -default value is: "".
""" ] ] - element Password { - text - }? - & [ a:documentation [ xml:lang="en" """ -URI to access the private Private Key for all of the participants in -the OSPL federation.
- -Supported URI schemes: file, data
- -Examples:
- -
-
-MIIEpAIBAAKCAQEA3HIh...AOBaaqSV37XBUJg==
-
------END RSA PRIVATE KEY-----
Trusted CA Directory which contains trusted CA certificates as -separated files.
The default value is: "".
""" ] ] - element TrustedCADirectory { - text - }? - }? - & [ a:documentation [ xml:lang="en" """ -This element configures the Cryptographic plugin of the DDS Security -specification.
""" ] ] - element Cryptographic { - [ a:documentation [ xml:lang="en" """ -This element specifies the library to be loaded as the DDS Security -Cryptographic plugin.
""" ] ] - element Library { - [ a:documentation [ xml:lang="en" """ -This element names the finalization function of Cryptographic plugin. -This function is called to let the plugin release its -resources.
The default value is: "finalize_crypto".
""" ] ] - attribute finalizeFunction { - text - }? - & [ a:documentation [ xml:lang="en" """ -This element names the initialization function of Cryptographic -plugin. This function is called after loading the plugin library for -instantiation purposes. Init function must return an object that -implements DDS Security Cryptographic interface.
The default value -is: "init_crypto".
""" ] ] - attribute initFunction { - text - }? - & [ a:documentation [ xml:lang="en" """ -This element points to the path of Cryptographic plugin library.
- -It can be either absolute path excluding file extension ( -/usr/lib/dds_security_crypto ) or single file without extension ( -dds_security_crypto ).
- -If single file is supplied, the library located by way of the current -working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for -Windows systems.
The default value is: -"dds_security_crypto".
""" ] ] - attribute path { - text - }? - }? - }? - }* - & [ a:documentation [ xml:lang="en" """ -The Discovery element allows specifying various parameters related to -the discovery of peers.
""" ] ] +The Discovery element allows specifying various parameters related to the discovery of peers.
""" ] ] element Discovery { [ a:documentation [ xml:lang="en" """ -This setting controls for how long endpoints discovered via a Cloud -discovery service will survive after the discovery service disappeared, -allowing reconnect without loss of data when the discovery service -restarts (or another instance takes over).
- -Valid values are finite durations with an explicit unit or the keyword -'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, -day.
The default value is: "30 s".
""" ] ] +This setting controls for how long endpoints discovered via a Cloud discovery service will survive after the discovery service disappeared, allowing reconnect without loss of data when the discovery service restarts (or another instance takes over).
+Valid values are finite durations with an explicit unit or the keyword 'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "30 s".
""" ] ] element DSGracePeriod { duration_inf }? & [ a:documentation [ xml:lang="en" """ -This element specifies the default multicast address for all traffic -other than participant discovery packets. It defaults to -Discovery/SPDPMulticastAddress.
The default value is: -"auto".
""" ] ] +This element specifies the default multicast address for all traffic other than participant discovery packets. It defaults to Discovery/SPDPMulticastAddress.
+The default value is: "auto".
""" ] ] element DefaultMulticastAddress { text }? & [ a:documentation [ xml:lang="en" """ -An override for the domain id, to be used in discovery and for -determining the port number mapping. This allows creating multiple -domains in a single process while making them appear as a single domain -on the network. The value "default" disables the override.
The -default value is: "default".
""" ] ] +An override for the domain id, to be used in discovery and for determining the port number mapping. This allows creating multiple domains in a single process while making them appear as a single domain on the network. The value "default" disables the override.
+The default value is: "default".
""" ] ] element ExternalDomainId { text }? & [ a:documentation [ xml:lang="en" """ -This element specifies the maximum DDSI participant index selected by -this instance of the Cyclone DDS service if the -Discovery/ParticipantIndex is "auto".
The default value is: -"9".
""" ] ] +This element specifies the maximum DDSI participant index selected by this instance of the Cyclone DDS service if the Discovery/ParticipantIndex is "auto".
+The default value is: "9".
""" ] ] element MaxAutoParticipantIndex { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This element specifies the DDSI participant index used by this -instance of the Cyclone DDS service for discovery purposes. Only one such -participant id is used, independent of the number of actual -DomainParticipants on the node. It is either:
- -This element specifies the DDSI participant index used by this instance of the Cyclone DDS service for discovery purposes. Only one such participant id is used, independent of the number of actual DomainParticipants on the node. It is either:
+The default is auto. The participant index is part of the port -number calculation and if predictable port numbers are needed and fixing -the participant index has no adverse effects, it is recommended that the -second be option be used.
The default value is: -"none".
""" ] ] +The default is auto. The participant index is part of the port number calculation and if predictable port numbers are needed and fixing the participant index has no adverse effects, it is recommended that the second be option be used.
+The default value is: "none".
""" ] ] element ParticipantIndex { text }? & [ a:documentation [ xml:lang="en" """ -This element statically configures addresses for discovery.
- -Valid values are finite durations with an explicit unit or the keyword -'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, day.
""" ] ] +This element statically configures addresses for discovery.
""" ] ] element Peers { [ a:documentation [ xml:lang="en" """ -This element statically configures a fault tolerant group of addresses -for discovery. Each member of the group is tried in sequence until one -succeeds.
""" ] ] +This element statically configures a fault tolerant group of addresses for discovery. Each member of the group is tried in sequence until one succeeds.
""" ] ] element Group { [ a:documentation [ xml:lang="en" """This element statically configures an addresses for discovery.
""" ] ] element Peer { [ a:documentation [ xml:lang="en" """ -This element specifies an IP address to which discovery packets must -be sent, in addition to the default multicast address (see also -General/AllowMulticast). Both a hostnames and a numerical IP address is -accepted; the hostname or IP address may be suffixed with :PORT to -explicitly set the port to which it must be sent. Multiple Peers may be -specified.
""" ] ] +This element specifies an IP address to which discovery packets must be sent, in addition to the default multicast address (see also General/AllowMulticast). Both a hostnames and a numerical IP address is accepted; the hostname or IP address may be suffixed with :PORT to explicitly set the port to which it must be sent. Multiple Peers may be specified.
+The default value is: "".
""" ] ] attribute Address { text } }* - }* + }? & [ a:documentation [ xml:lang="en" """This element statically configures an addresses for discovery.
""" ] ] element Peer { [ a:documentation [ xml:lang="en" """ -This element specifies an IP address to which discovery packets must -be sent, in addition to the default multicast address (see also -General/AllowMulticast). Both a hostnames and a numerical IP address is -accepted; the hostname or IP address may be suffixed with :PORT to -explicitly set the port to which it must be sent. Multiple Peers may be -specified.
""" ] ] +This element specifies an IP address to which discovery packets must be sent, in addition to the default multicast address (see also General/AllowMulticast). Both a hostnames and a numerical IP address is accepted; the hostname or IP address may be suffixed with :PORT to explicitly set the port to which it must be sent. Multiple Peers may be specified.
+The default value is: "".
""" ] ] attribute Address { text } }* }? & [ a:documentation [ xml:lang="en" """ -The Ports element allows specifying various parameters related to the -port numbers used for discovery. These all have default values specified -by the DDSI 2.1 specification and rarely need to be changed.
""" ] ] +The Ports element allows specifying various parameters related to the port numbers used for discovery. These all have default values specified by the DDSI 2.1 specification and rarely need to be changed.
""" ] ] element Ports { [ a:documentation [ xml:lang="en" """ -This element specifies the base port number (refer to the DDSI 2.1 -specification, section 9.6.1, constant PB).
The default value is: -"7400".
""" ] ] +This element specifies the base port number (refer to the DDSI 2.1 specification, section 9.6.1, constant PB).
+The default value is: "7400".
""" ] ] element Base { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This element specifies the domain gain, relating domain ids to sets of -port numbers (refer to the DDSI 2.1 specification, section 9.6.1, -constant DG).
The default value is: "250".
""" ] ] +This element specifies the domain gain, relating domain ids to sets of port numbers (refer to the DDSI 2.1 specification, section 9.6.1, constant DG).
+The default value is: "250".
""" ] ] element DomainGain { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This element specifies the port number for multicast data traffic -(refer to the DDSI 2.1 specification, section 9.6.1, constant -d2).
The default value is: "1".
""" ] ] +This element specifies the port number for multicast data traffic (refer to the DDSI 2.1 specification, section 9.6.1, constant d2).
+The default value is: "1".
""" ] ] element MulticastDataOffset { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This element specifies the port number for multicast meta traffic -(refer to the DDSI 2.1 specification, section 9.6.1, constant -d0).
The default value is: "0".
""" ] ] +This element specifies the port number for multicast meta traffic (refer to the DDSI 2.1 specification, section 9.6.1, constant d0).
+The default value is: "0".
""" ] ] element MulticastMetaOffset { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This element specifies the participant gain, relating p0, participant -index to sets of port numbers (refer to the DDSI 2.1 specification, -section 9.6.1, constant PG).
The default value is: -"2".
""" ] ] +This element specifies the participant gain, relating p0, participant index to sets of port numbers (refer to the DDSI 2.1 specification, section 9.6.1, constant PG).
+The default value is: "2".
""" ] ] element ParticipantGain { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This element specifies the port number for unicast data traffic (refer -to the DDSI 2.1 specification, section 9.6.1, constant d3).
The -default value is: "11".
""" ] ] +This element specifies the port number for unicast data traffic (refer to the DDSI 2.1 specification, section 9.6.1, constant d3).
+The default value is: "11".
""" ] ] element UnicastDataOffset { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This element specifies the port number for unicast meta traffic (refer -to the DDSI 2.1 specification, section 9.6.1, constant d1).
The -default value is: "10".
""" ] ] +This element specifies the port number for unicast meta traffic (refer to the DDSI 2.1 specification, section 9.6.1, constant d1).
+The default value is: "10".
""" ] ] element UnicastMetaOffset { xsd:integer }? }? & [ a:documentation [ xml:lang="en" """ -This element specifies the interval between spontaneous transmissions -of participant discovery packets.
- -The unit must be specified explicitly. Recognised units: ns, us, ms, -s, min, hr, day.
The default value is: "30 s".
""" ] ] +This element specifies the interval between spontaneous transmissions of participant discovery packets.
+The unit must be specified explicitly. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "30 s".
""" ] ] element SPDPInterval { duration }? & [ a:documentation [ xml:lang="en" """ -This element specifies the multicast address that is used as the -destination for the participant discovery packets. In IPv4 mode the -default is the (standardised) 239.255.0.1, in IPv6 mode it becomes -ff02::ffff:239.255.0.1, which is a non-standardised link-local multicast -address.
The default value is: "239.255.0.1".
""" ] ] +This element specifies the multicast address that is used as the destination for the participant discovery packets. In IPv4 mode the default is the (standardised) 239.255.0.1, in IPv6 mode it becomes ff02::ffff:239.255.0.1, which is a non-standardised link-local multicast address.
+The default value is: "239.255.0.1".
""" ] ] element SPDPMulticastAddress { text }? & [ a:documentation [ xml:lang="en" """ -String extension for domain id that remote participants must match to -be discovered.
The default value is: "".
""" ] ] +String extension for domain id that remote participants must match to be discovered.
+The default value is: "".
""" ] ] element Tag { text }? - }* + }? & [ a:documentation [ xml:lang="en" """ -The General element specifies overall Cyclone DDS service -settings.
""" ] ] +The General element specifies overall Cyclone DDS service settings.
""" ] ] element General { [ a:documentation [ xml:lang="en" """ -This element controls whether Cyclone DDS uses multicasts for data -traffic.
- -It is a comma-separated list of some of the following keywords: -"spdp", "asm", "ssm", or either of "false" or "true", or "default".
- +This element controls whether Cyclone DDS uses multicasts for data traffic.
+It is a comma-separated list of some of the following keywords: "spdp", "asm", "ssm", or either of "false" or "true", or "default".
When set to "false" all multicasting is disabled. The default, "true" -enables full use of multicasts. Listening for multicasts can be -controlled by General/MulticastRecvNetworkInterfaceAddresses.
- -"default" maps on spdp if the network is a WiFi network, on true if it -is a wired network
The default value is: "default".
""" ] ] +When set to "false" all multicasting is disabled. The default, "true" enables full use of multicasts. Listening for multicasts can be controlled by General/MulticastRecvNetworkInterfaceAddresses.
+"default" maps on spdp if the network is a WiFi network, on true if it is a wired network
+The default value is: "default".
""" ] ] element AllowMulticast { xsd:token { pattern = "default|((false|spdp|asm|ssm|true)(,(false|spdp|asm|ssm|true))*)" } }? & [ a:documentation [ xml:lang="en" """ -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.
The default value is: "false".
""" ] ] +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.
+The default value is: "false".
""" ] ] element DontRoute { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -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, but 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.
The default value is: "true".
""" ] ] +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, but 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.
+The default value is: "true".
""" ] ] element EnableMulticastLoopback { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -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.
The default value is: "auto".
""" ] ] +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.
+The default value is: "auto".
""" ] ] element ExternalNetworkAddress { text }? & [ a:documentation [ xml:lang="en" """ -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.
The default value is: -"0.0.0.0".
""" ] ] +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.
+The default value is: "0.0.0.0".
""" ] ] element ExternalNetworkMask { text }? & [ a:documentation [ xml:lang="en" """ -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.
- -The unit must be specified explicitly. Recognised units: B (bytes), kB -& KiB (210 bytes), MB & MiB (220 bytes), GB & GiB -(230 bytes).
The default value is: "1280 -B".
""" ] ] +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.
+The unit must be specified explicitly. Recognised units: B (bytes), kB & KiB (210 bytes), MB & MiB (220 bytes), GB & GiB (230 bytes).
+The default value is: "1280 B".
""" ] ] element FragmentSize { memsize }? & [ a:documentation [ xml:lang="en" """ -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).
- -On some networks it may be necessary to set this item to keep the -packetsize below the MTU to prevent IP fragmentation. In those cases, it -is generally advisable to also consider reducing -Internal/FragmentSize.
- -The unit must be specified explicitly. Recognised units: B (bytes), kB -& KiB (210 bytes), MB & MiB (220 bytes), GB & GiB -(230 bytes).
The default value is: "4096 -B".
""" ] ] +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).
+On some networks it may be necessary to set this item to keep the packetsize below the MTU to prevent IP fragmentation. In those cases, it is generally advisable to also consider reducing Internal/FragmentSize.
+The unit must be specified explicitly. Recognised units: B (bytes), kB & KiB (210 bytes), MB & MiB (220 bytes), GB & GiB (230 bytes).
+The default value is: "4096 B".
""" ] ] element MaxMessageSize { memsize }? & [ a:documentation [ xml:lang="en" """ -This element specifies on which network interfaces Cyclone DDS listens -to multicasts. The following options are available:
- +This element specifies on which network interfaces Cyclone DDS listens to multicasts. The following options are available:
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.
The -default value is: "preferred".
""" ] ] +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.
+The default value is: "preferred".
""" ] ] element MulticastRecvNetworkInterfaceAddresses { text }? & [ a:documentation [ xml:lang="en" """ -This element specifies the time-to-live setting for outgoing multicast -packets.
The default value is: "32".
""" ] ] +This element specifies the time-to-live setting for outgoing multicast packets.
+The default value is: "32".
""" ] ] element MulticastTimeToLive { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -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.
The default value is: -"auto".
""" ] ] +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.
+The default value is: "auto".
""" ] ] element NetworkInterfaceAddress { text }? & [ a:documentation [ xml:lang="en" """ -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.
The default value is: "false".
""" ] ] +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.
+The default value is: "false".
""" ] ] element PreferMulticast { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -This element allows selecting the transport to be used (udp, udp6, -tcp, tcp6, raweth)
The default value is: "default".
""" ] ] +This element allows selecting the transport to be used (udp, udp6, tcp, tcp6, raweth)
+The default value is: "default".
""" ] ] element Transport { ("default"|"udp"|"udp6"|"tcp"|"tcp6"|"raweth") }? & [ a:documentation [ xml:lang="en" """ -Deprecated (use Transport instead)
The default value is: -"default".
""" ] ] +Deprecated (use Transport instead)
+The default value is: "default".
""" ] ] element UseIPv6 { ("false"|"true"|"default") }? }? & [ a:documentation [ xml:lang="en" """ -The Internal elements deal with a variety of settings that evolving -and that are not necessarily fully supported. For the vast majority of -the Internal settings, the functionality per-se is supported, but the -right to change the way the options control the functionality is -reserved. This includes renaming or moving options.
""" ] ] +The Internal elements deal with a variety of settings that evolving and that are not necessarily fully supported. For the vast majority of the Internal settings, the functionality per-se is supported, but the right to change the way the options control the functionality is reserved. This includes renaming or moving options.
""" ] ] element Internal { [ a:documentation [ xml:lang="en" """ -Proxy readers that are assumed to sill be retrieving historical data -get this many samples retransmitted when they NACK something, even if -some of these samples have sequence numbers outside the set covered by -the NACK.
The default value is: "0".
""" ] ] +Proxy readers that are assumed to sill be retrieving historical data get this many samples retransmitted when they NACK something, even if some of these samples have sequence numbers outside the set covered by the NACK.
+The default value is: "0".
""" ] ] element AccelerateRexmitBlockSize { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This element controls which network interfaces are assumed to be -capable of multicasting even when the interface flags returned by the -operating system state it is not (this provides a workaround for some -platforms). It is a comma-separated lists of patterns (with ? and * -wildcards) against which the interface names are matched.
The -default value is: "".
""" ] ] +This element controls which network interfaces are assumed to be capable of multicasting even when the interface flags returned by the operating system state it is not (this provides a workaround for some platforms). It is a comma-separated lists of patterns (with ? and * wildcards) against which the interface names are matched.
+The default value is: "".
""" ] ] element AssumeMulticastCapable { text }? & [ a:documentation [ xml:lang="en" """ -This setting controls the interval with which a reader will continue -NACK'ing missing samples in the absence of a response from the writer, as -a protection mechanism against writers incorrectly stopping the sending -of HEARTBEAT messages.
- -Valid values are finite durations with an explicit unit or the keyword -'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, -day.
The default value is: "1 s".
""" ] ] +This setting controls the interval with which a reader will continue NACK'ing missing samples in the absence of a response from the writer, as a protection mechanism against writers incorrectly stopping the sending of HEARTBEAT messages.
+Valid values are finite durations with an explicit unit or the keyword 'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "1 s".
""" ] ] element AutoReschedNackDelay { duration_inf }? & [ a:documentation [ xml:lang="en" """ -This element controls which participants will have which built-in -endpoints for the discovery and liveliness protocols. Valid values -are:
- +This element controls which participants will have which built-in endpoints for the discovery and liveliness protocols. Valid values are:
The default is writers, as this is thought to be compliant and -reasonably efficient. Minimal may or may not be compliant but is -most efficient, and full is inefficient but certain to be -compliant. See also Internal/ConservativeBuiltinReaderStartup.
The -default value is: "writers".
""" ] ] +The default is writers, as this is thought to be compliant and reasonably efficient. Minimal may or may not be compliant but is most efficient, and full is inefficient but certain to be compliant. See also Internal/ConservativeBuiltinReaderStartup.
+The default value is: "writers".
""" ] ] element BuiltinEndpointSet { ("full"|"writers"|"minimal") }? & [ a:documentation [ xml:lang="en" """ -The ControlTopic element allows configured whether Cyclone DDS -provides a special control interface via a predefined topic or not.
""" ] ] +
The ControlTopic element allows configured whether Cyclone DDS provides a special control interface via a predefined topic or not.
""" ] ] element ControlTopic { empty }? & [ a:documentation [ xml:lang="en" """ -
This element sets the maximum number of extra threads for an -experimental, undocumented and unsupported direct mode.
The default -value is: "1".
""" ] ] +This element sets the maximum number of extra threads for an experimental, undocumented and unsupported direct mode.
+The default value is: "1".
""" ] ] element DDSI2DirectMaxThreads { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This element sets the maximum number of samples that can be -defragmented simultaneously for a reliable writer. This has to be large -enough to handle retransmissions of historical data in addition to new -samples.
The default value is: "16".
""" ] ] +This element sets the maximum number of samples that can be defragmented simultaneously for a reliable writer. This has to be large enough to handle retransmissions of historical data in addition to new samples.
+The default value is: "16".
""" ] ] element DefragReliableMaxSamples { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This element sets the maximum number of samples that can be -defragmented simultaneously for a best-effort writers.
The default -value is: "4".
""" ] ] +This element sets the maximum number of samples that can be defragmented simultaneously for a best-effort writers.
+The default value is: "4".
""" ] ] element DefragUnreliableMaxSamples { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This element controls the Maximum size of a delivery queue, expressed -in samples. Once a delivery queue is full, incoming samples destined for -that queue are dropped until space becomes available again.
The -default value is: "256".
""" ] ] +This element controls the Maximum size of a delivery queue, expressed in samples. Once a delivery queue is full, incoming samples destined for that queue are dropped until space becomes available again.
+The default value is: "256".
""" ] ] element DeliveryQueueMaxSamples { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This element enables expensive checks in builds with assertions -enabled and is ignored otherwise. Recognised categories are:
- -This element enables expensive checks in builds with assertions enabled and is ignored otherwise. Recognised categories are:
+In addition, there is the keyword all that enables all -checks.
The default value is: "".
""" ] ] +In addition, there is the keyword all that enables all checks.
+The default value is: "".
""" ] ] element EnableExpensiveChecks { xsd:token { pattern = "((whc|rhc|all)(,(whc|rhc|all))*)|" } }? & [ a:documentation [ xml:lang="en" """ -When true, include keyhashes in outgoing data for topics with -keys.
The default value is: "false".
""" ] ] +When true, include keyhashes in outgoing data for topics with keys.
+The default value is: "false".
""" ] ] element GenerateKeyhash { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -This element allows configuring the base interval for sending writer -heartbeats and the bounds within which it can vary.
- -Valid values are finite durations with an explicit unit or the keyword -'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, -day.
The default value is: "100 ms".
""" ] ] +This element allows configuring the base interval for sending writer heartbeats and the bounds within which it can vary.
+Valid values are finite durations with an explicit unit or the keyword 'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "100 ms".
""" ] ] element HeartbeatInterval { [ a:documentation [ xml:lang="en" """This attribute sets the maximum interval for periodic heartbeats.
- -Valid values are finite durations with an explicit unit or the keyword -'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, -day.
The default value is: "8 s".
""" ] ] +Valid values are finite durations with an explicit unit or the keyword 'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "8 s".
""" ] ] attribute max { duration_inf }? & [ a:documentation [ xml:lang="en" """ -This attribute sets the minimum interval that must have passed since -the most recent heartbeat from a writer, before another asynchronous (not -directly related to writing) will be sent.
- -Valid values are finite durations with an explicit unit or the keyword -'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, -day.
The default value is: "5 ms".
""" ] ] +This attribute sets the minimum interval that must have passed since the most recent heartbeat from a writer, before another asynchronous (not directly related to writing) will be sent.
+Valid values are finite durations with an explicit unit or the keyword 'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "5 ms".
""" ] ] attribute min { duration_inf }? & [ a:documentation [ xml:lang="en" """ -This attribute sets the minimum interval for periodic heartbeats. -Other events may still cause heartbeats to go out.
- -Valid values are finite durations with an explicit unit or the keyword -'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, -day.
The default value is: "20 ms".
""" ] ] +This attribute sets the minimum interval for periodic heartbeats. Other events may still cause heartbeats to go out.
+Valid values are finite durations with an explicit unit or the keyword 'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "20 ms".
""" ] ] attribute minsched { duration_inf }? & duration_inf }? & [ a:documentation [ xml:lang="en" """ -Ack a sample only when it has been delivered, instead of when -committed to delivering it.
The default value is: -"false".
""" ] ] +Ack a sample only when it has been delivered, instead of when committed to delivering it.
+The default value is: "false".
""" ] ] element LateAckMode { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -This setting controls the default participant lease duration.
- -
The unit must be specified explicitly. Recognised units: ns, us, ms, -s, min, hr, day.
The default value is: "10 s".
""" ] ] +This setting controls the default participant lease duration.
+
The unit must be specified explicitly. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "10 s".
""" ] ] element LeaseDuration { duration }? & [ a:documentation [ xml:lang="en" """ -This element controls whether or not implementation should internally -monitor its own liveliness. If liveliness monitoring is enabled, stack -traces can be dumped automatically when some thread appears to have -stopped making progress.
The default value is: -"false".
""" ] ] +This element controls whether or not implementation should internally monitor its own liveliness. If liveliness monitoring is enabled, stack traces can be dumped automatically when some thread appears to have stopped making progress.
+The default value is: "false".
""" ] ] element LivelinessMonitoring { [ a:documentation [ xml:lang="en" """ -This element controls the interval at which to check whether threads -have been making progress.
- -The unit must be specified explicitly. Recognised units: ns, us, ms, -s, min, hr, day.
The default value is: "1s".
""" ] ] +This element controls the interval at which to check whether threads have been making progress.
+The unit must be specified explicitly. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "1s".
""" ] ] attribute Interval { duration }? & [ a:documentation [ xml:lang="en" """ -This element controls whether or not to write stack traces to the -Cyclone DDS trace when a thread fails to make progress (on select -platforms only).
The default value is: "true".
""" ] ] +This element controls whether or not to write stack traces to the DDSI2 trace when a thread fails to make progress (on select platforms only).
+The default value is: "true".
""" ] ] attribute StackTraces { xsd:boolean }? & xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -This elements configures the maximum number of DCPS domain -participants this Cyclone DDS instance is willing to service. 0 is -unlimited.
The default value is: "0".
""" ] ] +This elements configures the maximum number of DCPS domain participants this Cyclone DDS instance is willing to service. 0 is unlimited.
+The default value is: "0".
""" ] ] element MaxParticipants { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This setting limits the maximum number of bytes queued for -retransmission. The default value of 0 is unlimited unless an -AuxiliaryBandwidthLimit has been set, in which case it becomes NackDelay -* AuxiliaryBandwidthLimit. It must be large enough to contain the largest -sample that may need to be retransmitted.
- -The unit must be specified explicitly. Recognised units: B (bytes), kB -& KiB (210 bytes), MB & MiB (220 bytes), GB & GiB -(230 bytes).
The default value is: "50 -kB".
""" ] ] +This setting limits the maximum number of bytes queued for retransmission. The default value of 0 is unlimited unless an AuxiliaryBandwidthLimit has been set, in which case it becomes NackDelay * AuxiliaryBandwidthLimit. It must be large enough to contain the largest sample that may need to be retransmitted.
+The unit must be specified explicitly. Recognised units: B (bytes), kB & KiB (210 bytes), MB & MiB (220 bytes), GB & GiB (230 bytes).
+The default value is: "50 kB".
""" ] ] element MaxQueuedRexmitBytes { memsize }? & [ a:documentation [ xml:lang="en" """ -This settings limits the maximum number of samples queued for -retransmission.
The default value is: "200".
""" ] ] +This settings limits the maximum number of samples queued for retransmission.
+The default value is: "200".
""" ] ] element MaxQueuedRexmitMessages { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This setting controls the maximum (CDR) serialised size of samples -that Cyclone DDS will forward in either direction. Samples larger than -this are discarded with a warning.
- -The unit must be specified explicitly. Recognised units: B (bytes), kB -& KiB (210 bytes), MB & MiB (220 bytes), GB & GiB -(230 bytes).
The default value is: "2147483647 -B".
""" ] ] +This setting controls the maximum (CDR) serialised size of samples that Cyclone DDS will forward in either direction. Samples larger than this are discarded with a warning.
+The unit must be specified explicitly. Recognised units: B (bytes), kB & KiB (210 bytes), MB & MiB (220 bytes), GB & GiB (230 bytes).
+The default value is: "2147483647 B".
""" ] ] element MaxSampleSize { memsize }? & [ a:documentation [ xml:lang="en" """ -This element enables heartbeat-to-ack latency among Cyclone DDS -services by prepending timestamps to Heartbeat and AckNack messages and -calculating round trip times. This is non-standard behaviour. The -measured latencies are quite noisy and are currently not used -anywhere.
The default value is: "false".
""" ] ] +This element enables heartbeat-to-ack latency among Cyclone DDS services by prepending timestamps to Heartbeat and AckNack messages and calculating round trip times. This is non-standard behaviour. The measured latencies are quite noisy and are currently not used anywhere.
+The default value is: "false".
""" ] ] element MeasureHbToAckLatency { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -This setting controls the minimum size of socket receive buffers. The -operating system provides some size receive buffer upon creation of the -socket, this option can be used to increase the size of the buffer beyond -that initially provided by the operating system. If the buffer size -cannot be increased to the specified size, an error is reported.
- -The default setting is the word "default", which means Cyclone DDS -will attempt to increase the buffer size to 1MB, but will silently accept -a smaller buffer should that attempt fail.
- -The unit must be specified explicitly. Recognised units: B (bytes), kB -& KiB (210 bytes), MB & MiB (220 bytes), GB & GiB -(230 bytes).
The default value is: -"default".
""" ] ] +This setting controls the minimum size of socket receive buffers. The operating system provides some size receive buffer upon creation of the socket, this option can be used to increase the size of the buffer beyond that initially provided by the operating system. If the buffer size cannot be increased to the specified size, an error is reported.
+The default setting is the word "default", which means Cyclone DDS will attempt to increase the buffer size to 1MB, but will silently accept a smaller buffer should that attempt fail.
+The unit must be specified explicitly. Recognised units: B (bytes), kB & KiB (210 bytes), MB & MiB (220 bytes), GB & GiB (230 bytes).
+The default value is: "default".
""" ] ] element MinimumSocketReceiveBufferSize { memsize }? & [ a:documentation [ xml:lang="en" """ -This setting controls the minimum size of socket send buffers. This -setting can only increase the size of the send buffer, if the operating -system by default creates a larger buffer, it is left unchanged.
- -The unit must be specified explicitly. Recognised units: B (bytes), kB -& KiB (210 bytes), MB & MiB (220 bytes), GB & GiB -(230 bytes).
The default value is: "64 -KiB".
""" ] ] +This setting controls the minimum size of socket send buffers. This setting can only increase the size of the send buffer, if the operating system by default creates a larger buffer, it is left unchanged.
+The unit must be specified explicitly. Recognised units: B (bytes), kB & KiB (210 bytes), MB & MiB (220 bytes), GB & GiB (230 bytes).
+The default value is: "64 KiB".
""" ] ] element MinimumSocketSendBufferSize { memsize }? & [ a:documentation [ xml:lang="en" """ -This element allows configuring a service that dumps a text -description of part the internal state to TCP clients. By default (-1), -this is disabled; specifying 0 means a kernel-allocated port is used; a -positive number is used as the TCP port number.
The default value -is: "-1".
""" ] ] +This element allows configuring a service that dumps a text description of part the internal state to TCP clients. By default (-1), this is disabled; specifying 0 means a kernel-allocated port is used; a positive number is used as the TCP port number.
+The default value is: "-1".
""" ] ] element MonitorPort { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This element controls whether all traffic is handled by a single -receive thread (false) or whether multiple receive threads may be used to -improve latency (true). By default it is disabled on Windows because it -appears that one cannot count on being able to send packets to oneself, -which is necessary to stop the thread during shutdown. Currently multiple -receive threads are only used for connectionless transport (e.g., UDP) -and ManySocketsMode not set to single (the default).
The default -value is: "default".
""" ] ] +This element controls whether all traffic is handled by a single receive thread (false) or whether multiple receive threads may be used to improve latency (true). By default it is disabled on Windows because it appears that one cannot count on being able to send packets to oneself, which is necessary to stop the thread during shutdown. Currently multiple receive threads are only used for connectionless transport (e.g., UDP) and ManySocketsMode not set to single (the default).
+The default value is: "default".
""" ] ] element MultipleReceiveThreads { [ a:documentation [ xml:lang="en" """ -Receive threads dedicated to a single socket can only be triggered for -termination by sending a packet. Reception of any packet will do, so -termination failure due to packet loss is exceedingly unlikely, but to -eliminate all risks, it will retry as many times as specified by this -attribute before aborting.
The default value is: -"4294967295".
""" ] ] +Receive threads dedicated to a single socket can only be triggered for termination by sending a packet. Reception of any packet will do, so termination failure due to packet loss is exceedingly unlikely, but to eliminate all risks, it will retry as many times as specified by this attribute before aborting.
+The default value is: "4294967295".
""" ] ] attribute maxretries { xsd:integer }? & ("false"|"true"|"default") }? & [ a:documentation [ xml:lang="en" """ -This setting controls the delay between receipt of a HEARTBEAT -indicating missing samples and a NACK (ignored when the HEARTBEAT -requires an answer). However, no NACK is sent if a NACK had been -scheduled already for a response earlier than the delay requests: then -that NACK will incorporate the latest information.
- -The unit must be specified explicitly. Recognised units: ns, us, ms, -s, min, hr, day.
The default value is: "10 ms".
""" ] ] +This setting controls the delay between receipt of a HEARTBEAT indicating missing samples and a NACK (ignored when the HEARTBEAT requires an answer). However, no NACK is sent if a NACK had been scheduled already for a response earlier than the delay requests: then that NACK will incorporate the latest information.
+The unit must be specified explicitly. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "10 ms".
""" ] ] element NackDelay { duration }? & [ a:documentation [ xml:lang="en" """ -This setting controls the delay between the discovering a remote -writer and sending a pre-emptive AckNack to discover the range of data -available.
- -The unit must be specified explicitly. Recognised units: ns, us, ms, -s, min, hr, day.
The default value is: "10 ms".
""" ] ] +This setting controls the delay between the discovering a remote writer and sending a pre-emptive AckNack to discover the range of data available.
+The unit must be specified explicitly. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "10 ms".
""" ] ] element PreEmptiveAckDelay { duration }? & [ a:documentation [ xml:lang="en" """ -This element sets the maximum size in samples of a primary re-order -administration. Each proxy writer has one primary re-order administration -to buffer the packet flow in case some packets arrive out of order. Old -samples are forwarded to secondary re-order administrations associated -with readers in need of historical data.
The default value is: -"128".
""" ] ] +This element sets the maximum size in samples of a primary re-order administration. Each proxy writer has one primary re-order administration to buffer the packet flow in case some packets arrive out of order. Old samples are forwarded to secondary re-order administrations associated with readers in need of historical data.
+The default value is: "128".
""" ] ] element PrimaryReorderMaxSamples { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This element controls whether retransmits are prioritized over new -data, speeding up recovery.
The default value is: -"true".
""" ] ] +This element controls whether retransmits are prioritized over new data, speeding up recovery.
+The default value is: "true".
""" ] ] element PrioritizeRetransmit { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -This element controls for how long a remote participant that was -previously deleted will remain on a blacklist to prevent rediscovery, -giving the software on a node time to perform any cleanup actions it -needs to do. To some extent this delay is required internally by Cyclone -DDS, but in the default configuration with the 'enforce' attribute set to -false, Cyclone DDS will reallow rediscovery as soon as it has cleared its -internal administration. Setting it to too small a value may result in -the entry being pruned from the blacklist before Cyclone DDS is ready, it -is therefore recommended to set it to at least several seconds.
- -Valid values are finite durations with an explicit unit or the keyword -'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, -day.
The default value is: "0s".
""" ] ] +This element controls for how long a remote participant that was previously deleted will remain on a blacklist to prevent rediscovery, giving the software on a node time to perform any cleanup actions it needs to do. To some extent this delay is required internally by Cyclone DDS, but in the default configuration with the 'enforce' attribute set to false, Cyclone DDS will reallow rediscovery as soon as it has cleared its internal administration. Setting it to too small a value may result in the entry being pruned from the blacklist before Cyclone DDS is ready, it is therefore recommended to set it to at least several seconds.
+Valid values are finite durations with an explicit unit or the keyword 'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "0s".
""" ] ] element RediscoveryBlacklistDuration { [ a:documentation [ xml:lang="en" """ -This attribute controls whether the configured time during which -recently deleted participants will not be rediscovered (i.e., "black -listed") is enforced and following complete removal of the participant in -Cyclone DDS, or whether it can be rediscovered earlier provided all -traces of that participant have been removed already.
The default -value is: "false".
""" ] ] +This attribute controls whether the configured time during which recently deleted participants will not be rediscovered (i.e., "black listed") is enforced and following complete removal of the participant in Cyclone DDS, or whether it can be rediscovered earlier provided all traces of that participant have been removed already.
+The default value is: "false".
""" ] ] attribute enforce { xsd:boolean }? & duration_inf }? & [ a:documentation [ xml:lang="en" """ -This elements controls the addressing and timing of retransmits. -Possible values are:
- +This elements controls the addressing and timing of retransmits. Possible values are:
The default is never. See also -Internal/RetransmitMergingPeriod.
The default value is: -"never".
""" ] ] +The default is never. See also Internal/RetransmitMergingPeriod.
+The default value is: "never".
""" ] ] element RetransmitMerging { ("never"|"adaptive"|"always") }? & [ a:documentation [ xml:lang="en" """ -This setting determines the size of the time window in which a NACK of -some sample is ignored because a retransmit of that sample has been -multicasted too recently. This setting has no effect on unicasted -retransmits.
- +This setting determines the size of the time window in which a NACK of some sample is ignored because a retransmit of that sample has been multicasted too recently. This setting has no effect on unicasted retransmits.
See also Internal/RetransmitMerging.
- -The unit must be specified explicitly. Recognised units: ns, us, ms, -s, min, hr, day.
The default value is: "5 ms".
""" ] ] +The unit must be specified explicitly. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "5 ms".
""" ] ] element RetransmitMergingPeriod { duration }? & [ a:documentation [ xml:lang="en" """ -Whether or not to locally retry pushing a received best-effort sample -into the reader caches when resource limits are reached.
The -default value is: "false".
""" ] ] +Whether or not to locally retry pushing a received best-effort sample into the reader caches when resource limits are reached.
+The default value is: "false".
""" ] ] element RetryOnRejectBestEffort { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -Maximum pseudo-random delay in milliseconds between discovering a -remote participant and responding to it.
- -The unit must be specified explicitly. Recognised units: ns, us, ms, -s, min, hr, day.
The default value is: "0 ms".
""" ] ] +Maximum pseudo-random delay in milliseconds between discovering aremote participant and responding to it.
+The unit must be specified explicitly. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "0 ms".
""" ] ] element SPDPResponseMaxDelay { duration }? & [ a:documentation [ xml:lang="en" """ -This setting allows the timing of scheduled events to be rounded up so -that more events can be handled in a single cycle of the event queue. The -default is 0 and causes no rounding at all, i.e. are scheduled exactly, -whereas a value of 10ms would mean that events are rounded up to the -nearest 10 milliseconds.
- -The unit must be specified explicitly. Recognised units: ns, us, ms, -s, min, hr, day.
The default value is: "0 ms".
""" ] ] +This setting allows the timing of scheduled events to be rounded up so that more events can be handled in a single cycle of the event queue. The default is 0 and causes no rounding at all, i.e. are scheduled exactly, whereas a value of 10ms would mean that events are rounded up to the nearest 10 milliseconds.
+The unit must be specified explicitly. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "0 ms".
""" ] ] element ScheduleTimeRounding { duration }? & [ a:documentation [ xml:lang="en" """ -This element sets the maximum size in samples of a secondary re-order -administration. The secondary re-order administration is per reader in -need of historical data.
The default value is: "128".
""" ] ] +This element sets the maximum size in samples of a secondary re-order administration. The secondary re-order administration is per reader in need of historical data.
+The default value is: "128".
""" ] ] element SecondaryReorderMaxSamples { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This element controls whether the actual sending of packets occurs on -the same thread that prepares them, or is done asynchronously by another -thread.
The default value is: "false".
""" ] ] +This element controls whether the actual sending of packets occurs on the same thread that prepares them, or is done asynchronously by another thread.
+The default value is: "false".
""" ] ] element SendAsync { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -This element controls whether Cyclone DDS advertises all the domain -participants it serves in DDSI (when set to false), or rather only -one domain participant (the one corresponding to the Cyclone DDS process; -when set to true). In the latter case Cyclone DDS becomes the -virtual owner of all readers and writers of all domain participants, -dramatically reducing discovery traffic (a similar effect can be obtained -by setting Internal/BuiltinEndpointSet to "minimal" but with less loss of -information).
The default value is: "false".
""" ] ] +This element controls whether Cyclone DDS advertises all the domain participants it serves in DDSI (when set to false), or rather only one domain participant (the one corresponding to the Cyclone DDS process; when set to true). In the latter case Cyclone DDS becomes the virtual owner of all readers and writers of all domain participants, dramatically reducing discovery traffic (a similar effect can be obtained by setting Internal/BuiltinEndpointSet to "minimal" but with less loss of information).
+The default value is: "false".
""" ] ] element SquashParticipants { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -This element controls whether samples sent by a writer with QoS -settings transport_priority >= SynchronousDeliveryPriorityThreshold and a -latency_budget at most this element's value will be delivered -synchronously from the "recv" thread, all others will be delivered -asynchronously through delivery queues. This reduces latency at the -expense of aggregate bandwidth.
- -Valid values are finite durations with an explicit unit or the keyword -'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, -day.
The default value is: "inf".
""" ] ] +This element controls whether samples sent by a writer with QoS settings transport_priority >= SynchronousDeliveryPriorityThreshold and a latency_budget at most this element's value will be delivered synchronously from the "recv" thread, all others will be delivered asynchronously through delivery queues. This reduces latency at the expense of aggregate bandwidth.
+Valid values are finite durations with an explicit unit or the keyword 'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "inf".
""" ] ] element SynchronousDeliveryLatencyBound { duration_inf }? & [ a:documentation [ xml:lang="en" """ -This element controls whether samples sent by a writer with QoS -settings latency_budget <= SynchronousDeliveryLatencyBound and -transport_priority greater than or equal to this element's value will be -delivered synchronously from the "recv" thread, all others will be -delivered asynchronously through delivery queues. This reduces latency at -the expense of aggregate bandwidth.
The default value is: -"0".
""" ] ] +This element controls whether samples sent by a writer with QoS settings latency_budget <= SynchronousDeliveryLatencyBound and transport_priority greater than or equal to this element's value will be delivered synchronously from the "recv" thread, all others will be delivered asynchronously through delivery queues. This reduces latency at the expense of aggregate bandwidth.
+The default value is: "0".
""" ] ] element SynchronousDeliveryPriorityThreshold { xsd:integer }? @@ -1242,23 +594,21 @@ the expense of aggregate bandwidth.The default value is:
Testing options.
""" ] ] element Test { [ a:documentation [ xml:lang="en" """ -This element controls the fraction of outgoing packets to drop, -specified as samples per thousand.
The default value is: -"0".
""" ] ] +This element controls the fraction of outgoing packets to drop, specified as samples per thousand.
+The default value is: "0".
""" ] ] element XmitLossiness { xsd:integer }? }? & [ a:documentation [ xml:lang="en" """ -This element controls whether the response to a newly discovered -participant is sent as a unicasted SPDP packet, instead of rescheduling -the periodic multicasted one. There is no known benefit to setting this -to false.
The default value is: "true".
""" ] ] +This element controls whether the response to a newly discovered participant is sent as a unicasted SPDP packet, instead of rescheduling the periodic multicasted one. There is no known benefit to setting this to false.
+The default value is: "true".
""" ] ] element UnicastResponseToSPDPMessages { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -Do not use.
The default value is: "0".
""" ] ] +Do not use.
+The default value is: "0".
""" ] ] element UseMulticastIfMreqn { xsd:integer }? @@ -1266,333 +616,456 @@ to false.The default value is: "true".
""" ] ]Watermarks for flow-control.
""" ] ] element Watermarks { [ a:documentation [ xml:lang="en" """ -This element controls whether Cyclone DDS will adapt the high-water -mark to current traffic conditions, based on retransmit requests and -transmit pressure.
The default value is: "true".
""" ] ] +This element controls whether Cyclone DDS will adapt the high-water mark to current traffic conditions, based on retransmit requests and transmit pressure.
+The default value is: "true".
""" ] ] element WhcAdaptive { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -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.
- -The unit must be specified explicitly. Recognised units: B (bytes), kB -& KiB (210 bytes), MB & MiB (220 bytes), GB & GiB -(230 bytes).
The default value is: "100 -kB".
""" ] ] +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.
+The unit must be specified explicitly. Recognised units: B (bytes), kB & KiB (210 bytes), MB & MiB (220 bytes), GB & GiB (230 bytes).
+The default value is: "100 kB".
""" ] ] element WhcHigh { memsize }? & [ a:documentation [ xml:lang="en" """ -This element sets the initial level of the high-water mark for the -Cyclone DDS WHCs, expressed in bytes.
- -The unit must be specified explicitly. Recognised units: B (bytes), kB -& KiB (210 bytes), MB & MiB (220 bytes), GB & GiB -(230 bytes).
The default value is: "30 -kB".
""" ] ] +This element sets the initial level of the high-water mark for the Cyclone DDS WHCs, expressed in bytes.
+The unit must be specified explicitly. Recognised units: B (bytes), kB & KiB (210 bytes), MB & MiB (220 bytes), GB & GiB (230 bytes).
+The default value is: "30 kB".
""" ] ] element WhcHighInit { memsize }? & [ a:documentation [ xml:lang="en" """ -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.
- -The unit must be specified explicitly. Recognised units: B (bytes), kB -& KiB (210 bytes), MB & MiB (220 bytes), GB & GiB -(230 bytes).
The default value is: "1 kB".
""" ] ] +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.
+The unit must be specified explicitly. Recognised units: B (bytes), kB & KiB (210 bytes), MB & MiB (220 bytes), GB & GiB (230 bytes).
+The default value is: "1 kB".
""" ] ] element WhcLow { memsize }? }? & [ a:documentation [ xml:lang="en" """ -This element enables the batching of write operations. By default each -write operation writes through the write cache and out onto the -transport. Enabling write batching causes multiple small write operations -to be aggregated within the write cache into a single larger write. This -gives greater throughput at the expense of latency. Currently there is no -mechanism for the write cache to automatically flush itself, so that if -write batching is enabled, the application may have to use the -dds_write_flush function to ensure that all samples are -written.
The default value is: "false".
""" ] ] +This element enables the batching of write operations. By default each write operation writes through the write cache and out onto the transport. Enabling write batching causes multiple small write operations to be aggregated within the write cache into a single larger write. This gives greater throughput at the expense of latency. Currently there is no mechanism for the write cache to automatically flush itself, so that if write batching is enabled, the application may have to use the dds_write_flush function to ensure that all samples are written.
+The default value is: "false".
""" ] ] element WriteBatch { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -This setting controls the maximum duration for which actual deletion -of a reliable writer with unacknowledged data in its history will be -postponed to provide proper reliable transmission.
- -
The unit must be specified explicitly. Recognised units: ns, us, ms, -s, min, hr, day.
The default value is: "1 s".
""" ] ] +This setting controls the maximum duration for which actual deletion of a reliable writer with unacknowledged data in its history will be postponed to provide proper reliable transmission.
+
The unit must be specified explicitly. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "1 s".
""" ] ] element WriterLingerDuration { duration }? - }* + }? & [ a:documentation [ xml:lang="en" """ -The Partitioning element specifies Cyclone DDS network partitions and -how DCPS partition/topic combinations are mapped onto the network -partitions.
""" ] ] +The Partitioning element specifies Cyclone DDS network partitions and how DCPS partition/topic combinations are mapped onto the network partitions.
""" ] ] element Partitioning { [ a:documentation [ xml:lang="en" """ -The IgnoredPartitions element specifies DCPS partition/topic -combinations that are not distributed over the network.
""" ] ] +The IgnoredPartitions element specifies DCPS partition/topic combinations that are not distributed over the network.
""" ] ] element IgnoredPartitions { [ a:documentation [ xml:lang="en" """ -This element can be used to prevent certain combinations of DCPS -partition and topic from being transmitted over the network. Cyclone DDS -will complete 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.
""" ] ] +This element can be used to prevent certain combinations of DCPS partition and topic from being transmitted over the network. Cyclone DDS will complete 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.
+The default value is: "".
""" ] ] element IgnoredPartition { [ a:documentation [ xml:lang="en" """ -This attribute specifies a partition and a topic expression, separated -by a single '.', that 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 an wildcard DCPS partition to -match an expression iff there exists a string that satisfies both -expressions.
""" ] ] +This attribute specifies a partition and a topic expression, separated by a single '.', that 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 an wildcard DCPS partition to match an expression iff there exists a string that satisfies both expressions.
+The default value is: "".
""" ] ] attribute DCPSPartitionTopic { text } }* - }* + }? & [ a:documentation [ xml:lang="en" """ -The NetworkPartitions element specifies the Cyclone DDS network -partitions.
""" ] ] +The NetworkPartitions element specifies the Cyclone DDS network partitions.
""" ] ] element NetworkPartitions { [ a:documentation [ xml:lang="en" """ -This element defines a Cyclone DDS network partition.
""" ] ] +This element defines a Cyclone DDS network partition.
+The default value is: "".
""" ] ] element NetworkPartition { [ a:documentation [ xml:lang="en" """ -This attribute specifies the multicast addresses associated with the -network partition as a comma-separated list. Readers matching this -network partition (cf. Partitioning/PartitionMappings) will listen for -multicasts on all of these addresses and advertise them in the discovery -protocol. The writers will select the most suitable address from the -addresses advertised by the readers.
""" ] ] +This attribute specifies the multicast addresses associated with the network partition as a comma-separated list. Readers matching this network partition (cf. Partitioning/PartitionMappings) will listen for multicasts on all of these addresses and advertise them in the discovery protocol. The writers will select the most suitable address from the addresses advertised by the readers.
+The default value is: "".
""" ] ] attribute Address { text } & [ a:documentation [ xml:lang="en" """ -This attribute is a placeholder.
The default value is: -"true".
""" ] ] +This attribute is a placeholder.
+The default value is: "true".
""" ] ] attribute Connected { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -This attribute specifies the name of this Cyclone DDS network -partition. Two network partitions cannot have the same name.
""" ] ] +This attribute specifies the name of this Cyclone DDS network partition. Two network partitions cannot have the same name.
+The default value is: "".
""" ] ] attribute Name { text } }* - }* + }? & [ a:documentation [ xml:lang="en" """ -The PartitionMappings element specifies the mapping from DCPS -partition/topic combinations to Cyclone DDS network partitions.
""" ] ] +The PartitionMappings element specifies the mapping from DCPS partition/topic combinations to Cyclone DDS network partitions.
""" ] ] element PartitionMappings { [ a:documentation [ xml:lang="en" """ -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 -also encrypting the data flow.
""" ] ] +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 also encrypting the data flow.
+The default value is: "".
""" ] ] element PartitionMapping { [ a:documentation [ xml:lang="en" """ -This attribute specifies a partition and a topic expression, separated -by a single '.', that 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.
""" ] ] +This attribute specifies a partition and a topic expression, separated by a single '.', that 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.
+The default value is: "".
""" ] ] attribute DCPSPartitionTopic { text } & [ a:documentation [ xml:lang="en" """ -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.
""" ] ] +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.
+The default value is: "".
""" ] ] attribute NetworkPartition { text } }* - }* - }* + }? + }? & [ a:documentation [ xml:lang="en" """ -The SSL element allows specifying various parameters related to using -SSL/TLS for DDSI over TCP.
""" ] ] +The SSL element allows specifying various parameters related to using SSL/TLS for DDSI over TCP.
""" ] ] element SSL { [ a:documentation [ xml:lang="en" """ -If disabled this allows SSL connections to occur even if an X509 -certificate fails verification.
The default value is: -"true".
""" ] ] +If disabled this allows SSL connections to occur even if an X509 certificate fails verification.
+The default value is: "true".
""" ] ] element CertificateVerification { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -The set of ciphers used by SSL/TLS
The default value is: -"ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH".
""" ] ] +The set of ciphers used by SSL/TLS
+The default value is: "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH".
""" ] ] element Ciphers { text }? & [ a:documentation [ xml:lang="en" """ -This enables SSL/TLS for TCP.
The default value is: -"false".
""" ] ] +This enables SSL/TLS for TCP.
+The default value is: "false".
""" ] ] element Enable { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -The SSL/TLS random entropy file name.
The default value is: -"".
""" ] ] +The SSL/TLS random entropy file name.
+The default value is: "".
""" ] ] element EntropyFile { text }? & [ a:documentation [ xml:lang="en" """ -The SSL/TLS key pass phrase for encrypted keys.
The default -value is: "secret".
""" ] ] +The SSL/TLS key pass phrase for encrypted keys.
+The default value is: "secret".
""" ] ] element KeyPassphrase { text }? & [ a:documentation [ xml:lang="en" """ -The SSL/TLS key and certificate store file name. The keystore must be -in PEM format.
The default value is: "keystore".
""" ] ] +The SSL/TLS key and certificate store file name. The keystore must be in PEM format.
+The default value is: "keystore".
""" ] ] element KeystoreFile { text }? & [ a:documentation [ xml:lang="en" """ -The minimum TLS version that may be negotiated, valid values are 1.2 -and 1.3.
The default value is: "1.3".
""" ] ] +The minimum TLS version that may be negotiated, valid values are 1.2 and 1.3.
+The default value is: "1.3".
""" ] ] element MinimumTLSVersion { text }? & [ a:documentation [ xml:lang="en" """ -This enables the use of self signed X509 certificates.
The -default value is: "false".
""" ] ] +This enables the use of self signed X509 certificates.
+The default value is: "false".
""" ] ] element SelfSignedCertificates { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -This enables an SSL server checking the X509 certificate of a -connecting client.
The default value is: "true".
""" ] ] +This enables an SSL server checking the X509 certificate of a connecting client.
+The default value is: "true".
""" ] ] element VerifyClient { xsd:boolean }? + }? + & [ a:documentation [ xml:lang="en" """ +This element is used to configure Cyclone DDS with the DDS Security specification plugins and settings.
""" ] ] + element Security { + [ a:documentation [ xml:lang="en" """ +This element configures the Access Control plugin of the DDS Security specification.
""" ] ] + element AccessControl { + [ a:documentation [ xml:lang="en" """ +URI to the shared Governance Document signed by the Permissions CA in S/MIME format
+URI schemes: file, data
Examples file URIs:
+Content-Type: multipart/signed; protocol="application/x-pkcs7-signature"; micalg="sha-256"; boundary="----F9A8A198D6F08E1285A292ADF14DD04F" This is an S/MIME signed message ------F9A8A198D6F08E1285A292ADF14DD04F xsi:noNamespaceSchemaLocation="omg_shared_ca_governance.xsd"> . . . ... ------F9A8A198D6F08E1285A292ADF14DD04F Content-Type: application/x-pkcs7-signature; name="smime.p7s" Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="smime.p7s" MIIDuAYJKoZIhv ...al5s= ------F9A8A198D6F08E1285A292ADF14DD04F-]]
The default value is: "".
""" ] ] + element Governance { + text + }? + & [ a:documentation [ xml:lang="en" """ +This element specifies the library to be loaded as the DDS Security Access Control plugin.
+The default value is: "".
""" ] ] + element Library { + [ a:documentation [ xml:lang="en" """ +This element names the finalization function of Access Control plugin. This function is called to let the plugin release its resources.
+The default value is: "finalize_access_control".
""" ] ] + attribute finalizeFunction { + text + }? + & [ a:documentation [ xml:lang="en" """ +This element names the initialization function of Access Control plugin. This function is called after loading the plugin library for instantiation purposes. Init function must return an object that implements DDS Security Access Control interface.
+The default value is: "init_access_control".
""" ] ] + attribute initFunction { + text + }? + & [ a:documentation [ xml:lang="en" """ +This element points to the path of Access Control plugin library.
+It can be either absolute path excluding file extension ( /usr/lib/dds_security_ac ) or single file without extension ( dds_security_ac ).
+If single file is supplied, the library located by way of the current working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for Windows systems.
+The default value is: "dds_security_ac".
""" ] ] + attribute path { + text + }? + }? + & [ a:documentation [ xml:lang="en" """ +URI to the DomainParticipant permissions document signed by the Permissions CA in S/MIME format
+The permissions document specifies the permissions to be applied to a domain.
Example file URIs:
+Example data URI:
+The default value is: "".
""" ] ] + element Permissions { + text + }? + & [ a:documentation [ xml:lang="en" """ +URI to a X509 certificate for the PermissionsCA in PEM format.
+Supported URI schemes: file, data
+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.
Examples:
MIIC3DCCAcQCCQCWE5x+Z ... PhovK0mp2ohhRLYI0ZiyYQ==
+-----END CERTIFICATE-----
+The default value is: "".
""" ] ] + element PermissionsCA { + text + }? + }? + & [ a:documentation [ xml:lang="en" """ +This element configures the Authentication plugin of the DDS Security specification.
""" ] ] + element Authentication { + [ a:documentation [ xml:lang="en" """ +URI to the X509 certificate [39] of the Identity CA that is the signer of Identity Certificate.
+Supported URI schemes: file, data
+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.
+Examples:
+
+MIIC3DCCAcQCCQCWE5x+Z...PhovK0mp2ohhRLYI0ZiyYQ==
+-----END CERTIFICATE-----
The default value is: "".
""" ] ] + element IdentityCA { + text + } + & [ a:documentation [ xml:lang="en" """ +Identity certificate that will be used for identifying all participants in the OSPL instance.
The content is URI to a X509 certificate signed by the IdentityCA in PEM format containing the signed public key.
Supported URI schemes: file, data
+Examples:
+
+MIIDjjCCAnYCCQDCEu9...6rmT87dhTo=
+-----END CERTIFICATE-----
The default value is: "".
""" ] ] + element IdentityCertificate { + text + } + & [ a:documentation [ xml:lang="en" """ +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.
+The default value is: "false".
""" ] ] + element IncludeOptionalFields { + xsd:boolean + }? + & [ a:documentation [ xml:lang="en" """ +This element specifies the library to be loaded as the DDS Security Access Control plugin.
+The default value is: "".
""" ] ] + element Library { + [ a:documentation [ xml:lang="en" """ +This element names the finalization function of Authentication plugin. This function is called to let the plugin release its resources.
+The default value is: "finalize_authentication".
""" ] ] + attribute finalizeFunction { + text + }? + & [ a:documentation [ xml:lang="en" """ +This element names the initialization function of Authentication plugin. This function is called after loading the plugin library for instantiation purposes. Init function must return an object that implements DDS Security Authentication interface.
+The default value is: "init_authentication".
""" ] ] + attribute initFunction { + text + }? + & [ a:documentation [ xml:lang="en" """ +This element points to the path of Authentication plugin library.
+It can be either absolute path excluding file extension ( /usr/lib/dds_security_auth ) or single file without extension ( dds_security_auth ).
+If single file is supplied, the library located by way of the current working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for Windows system.
+The default value is: "dds_security_auth".
""" ] ] + attribute path { + text + }? + }? + & [ a:documentation [ xml:lang="en" """ +A password used to decrypt the private_key.
+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.
+If the password property is not present, then the value supplied in the private_key property must contain the unencrypted private key.
+The default value is: "".
""" ] ] + element Password { + text + }? + & [ a:documentation [ xml:lang="en" """ +URI to access the private Private Key for all of the participants in the OSPL federation.
+Supported URI schemes: file, data
+Examples:
+
+MIIEpAIBAAKCAQEA3HIh...AOBaaqSV37XBUJg==
+-----END RSA PRIVATE KEY-----
The default value is: "".
""" ] ] + element PrivateKey { + text + } + & [ a:documentation [ xml:lang="en" """ +Trusted CA Directory which contains trusted CA certificates as separated files.
+The default value is: "".
""" ] ] + element TrustedCADirectory { + text + }? + }? + & [ a:documentation [ xml:lang="en" """ +This element configures the Cryptographic plugin of the DDS Security specification.
""" ] ] + element Cryptographic { + [ a:documentation [ xml:lang="en" """ +This element specifies the library to be loaded as the DDS Security Cryptographic plugin.
+The default value is: "".
""" ] ] + element Library { + [ a:documentation [ xml:lang="en" """ +This element names the finalization function of Cryptographic plugin. This function is called to let the plugin release its resources.
+The default value is: "finalize_crypto".
""" ] ] + attribute finalizeFunction { + text + }? + & [ a:documentation [ xml:lang="en" """ +This element names the initialization function of Cryptographic plugin. This function is called after loading the plugin library for instantiation purposes. Init function must return an object that implements DDS Security Cryptographic interface.
+The default value is: "init_crypto".
""" ] ] + attribute initFunction { + text + }? + & [ a:documentation [ xml:lang="en" """ +This element points to the path of Cryptographic plugin library.
+It can be either absolute path excluding file extension ( /usr/lib/dds_security_crypto ) or single file without extension ( dds_security_crypto ).
+If single file is supplied, the library located by way of the current working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for Windows systems.
+The default value is: "dds_security_crypto".
""" ] ] + attribute path { + text + }? + }? + }? }* & [ a:documentation [ xml:lang="en" """ -The Sizing element specifies a variety of configuration settings -dealing with expected system sizes, buffer sizes, &c.
""" ] ] +The Sizing element specifies a variety of configuration settings dealing with expected system sizes, buffer sizes, &c.
""" ] ] element Sizing { [ a:documentation [ xml:lang="en" """ -This element specifies the size of one allocation unit in the receive -buffer. Must be greater than the maximum packet size by a modest amount -(too large packets are dropped). Each allocation is shrunk immediately -after processing a message, or freed straightaway.
- -The unit must be specified explicitly. Recognised units: B (bytes), kB -& KiB (210 bytes), MB & MiB (220 bytes), GB & GiB -(230 bytes).
The default value is: "128 -KiB".
""" ] ] +This element specifies the size of one allocation unit in the receive buffer. Must be greater than the maximum packet size by a modest amount (too large packets are dropped). Each allocation is shrunk immediately after processing a message, or freed straightaway.
+The unit must be specified explicitly. Recognised units: B (bytes), kB & KiB (210 bytes), MB & MiB (220 bytes), GB & GiB (230 bytes).
+The default value is: "128 KiB".
""" ] ] element ReceiveBufferChunkSize { memsize }? & [ a:documentation [ xml:lang="en" """ -This element sets the size of a single receive buffer. Many receive -buffers may be needed. The minimum workable size a little bit larger than -Sizing/ReceiveBufferChunkSize, and the value used is taken as the -configured value and the actual minimum workable size.
- -The unit must be specified explicitly. Recognised units: B (bytes), kB -& KiB (210 bytes), MB & MiB (220 bytes), GB & GiB -(230 bytes).
The default value is: "1 -MiB".
""" ] ] +This element sets the size of a single receive buffer. Many receive buffers may be needed. The minimum workable size a little bit larger than Sizing/ReceiveBufferChunkSize, and the value used is taken as the configured value and the actual minimum workable size.
+The unit must be specified explicitly. Recognised units: B (bytes), kB & KiB (210 bytes), MB & MiB (220 bytes), GB & GiB (230 bytes).
+The default value is: "1 MiB".
""" ] ] element ReceiveBufferSize { memsize }? - }* + }? & [ a:documentation [ xml:lang="en" """ -The TCP element allows specifying various parameters related to -running DDSI over TCP.
""" ] ] +The TCP element allows specifying various parameters related to running DDSI over TCP.
""" ] ] element TCP { [ a:documentation [ xml:lang="en" """ -Setting this to true means the unicast addresses in SPDP packets will -be ignored and the peer address from the TCP connection will be used -instead. This may help work around incorrectly advertised addresses when -using TCP.
The default value is: "false".
""" ] ] +Setting this to true means the unicast addresses in SPDP packets will be ignored and the peer address from the TCP connection will be used instead. This may help work around incorrectly advertised addresses when using TCP.
+The default value is: "false".
""" ] ] element AlwaysUsePeeraddrForUnicast { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -This element enables the optional TCP transport - deprecated, use -General/Transport instead.
The default value is: -"default".
""" ] ] +This element enables the optional TCP transport - deprecated, use General/Transport instead.
+The default value is: "default".
""" ] ] element Enable { ("false"|"true"|"default") }? & [ a:documentation [ xml:lang="en" """ -This element enables the TCP_NODELAY socket option, preventing -multiple DDSI messages being sent in the same TCP request. Setting this -option typically optimises latency over throughput.
The default -value is: "true".
""" ] ] +This element enables the TCP_NODELAY socket option, preventing multiple DDSI messages being sent in the same TCP request. Setting this option typically optimises latency over throughput.
+The default value is: "true".
""" ] ] element NoDelay { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -This element specifies the TCP port number on which Cyclone DDS -accepts connections. If the port is set it is used in entity locators, -published with DDSI discovery. Dynamically allocated if zero. Disabled if --1 or not configured. If disabled other DDSI services will not be able to -establish connections with the service, the service can only communicate -by establishing connections to other services.
The default value -is: "-1".
""" ] ] +This element specifies the TCP port number on which Cyclone DDS accepts connections. If the port is set it is used in entity locators, published with DDSI discovery. Dynamically allocated if zero. Disabled if -1 or not configured. If disabled other DDSI services will not be able to establish connections with the service, the service can only communicate by establishing connections to other services.
+The default value is: "-1".
""" ] ] element Port { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This element specifies the timeout for blocking TCP read operations. -If this timeout expires then the connection is closed.
- -The unit must be specified explicitly. Recognised units: ns, us, ms, -s, min, hr, day.
The default value is: "2 s".
""" ] ] +This element specifies the timeout for blocking TCP read operations. If this timeout expires then the connection is closed.
+The unit must be specified explicitly. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "2 s".
""" ] ] element ReadTimeout { duration }? & [ a:documentation [ xml:lang="en" """ -This element specifies the timeout for blocking TCP write operations. -If this timeout expires then the connection is closed.
- -The unit must be specified explicitly. Recognised units: ns, us, ms, -s, min, hr, day.
The default value is: "2 s".
""" ] ] +This element specifies the timeout for blocking TCP write operations. If this timeout expires then the connection is closed.
+The unit must be specified explicitly. Recognised units: ns, us, ms, s, min, hr, day.
+The default value is: "2 s".
""" ] ] element WriteTimeout { duration }? - }* + }? & [ a:documentation [ xml:lang="en" """ -The ThreadPool element allows specifying various parameters related to -using a thread pool to send DDSI messages to multiple unicast addresses -(TCP or UDP).
""" ] ] +The ThreadPool element allows specifying various parameters related to using a thread pool to send DDSI messages to multiple unicast addresses (TCP or UDP).
""" ] ] element ThreadPool { [ a:documentation [ xml:lang="en" """ -This element enables the optional thread pool.
The default value -is: "false".
""" ] ] +Enable optional use of a thread pool.
+The default value is: "false".
""" ] ] element Enable { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -This elements configures the maximum number of threads in the thread -pool.
The default value is: "8".
""" ] ] +Maximum number of threads in the thread pool.
+The default value is: "8".
""" ] ] element ThreadMax { xsd:integer }? & [ a:documentation [ xml:lang="en" """ -This elements configures the initial number of threads in the thread -pool.
The default value is: "4".
""" ] ] +Initial number of threads in the thread pool.
+The default value is: "4".
""" ] ] element Threads { xsd:integer }? - }* + }? & [ a:documentation [ xml:lang="en" """This element is used to set thread properties.
""" ] ] element Threads { @@ -1600,31 +1073,18 @@ pool.The default value is: "4".
""" ] ]This element is used to set thread properties.
""" ] ] element Thread { [ a:documentation [ xml:lang="en" """ -The Name of the thread for which properties are being set. The -following threads exist:
- -The Name of the thread for which properties are being set. The following threads exist:
+The default value is: "".
""" ] ] attribute Name { text } @@ -1632,160 +1092,92 @@ handshake;This element configures the scheduling properties of the thread.
""" ] ] element Scheduling { [ a:documentation [ xml:lang="en" """ -This element specifies the thread scheduling class (realtime, -timeshare or default). The user may need special privileges -from the underlying operating system to be able to assign some of the -privileged scheduling classes.
The default value is: -"default".
""" ] ] +This element specifies the thread scheduling class (realtime, timeshare or default). The user may need special privileges from the underlying operating system to be able to assign some of the privileged scheduling classes.
+The default value is: "default".
""" ] ] element Class { ("realtime"|"timeshare"|"default") }? & [ a:documentation [ xml:lang="en" """ -This element specifies the thread priority (decimal integer or -default). Only priorities that are 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.
The default value is: -"default".
""" ] ] +This element specifies the thread priority (decimal integer or default). Only priorities that are 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.
+The default value is: "default".
""" ] ] element Priority { text }? }? & [ a:documentation [ xml:lang="en" """ -This element configures the stack size for this thread. The default -value default leaves the stack size at the operating system -default.
- -The unit must be specified explicitly. Recognised units: B (bytes), kB -& KiB (210 bytes), MB & MiB (220 bytes), GB & GiB -(230 bytes).
The default value is: -"default".
""" ] ] +This element configures the stack size for this thread. The default value default leaves the stack size at the operating system default.
+The unit must be specified explicitly. Recognised units: B (bytes), kB & KiB (210 bytes), MB & MiB (220 bytes), GB & GiB (230 bytes).
+The default value is: "default".
""" ] ] element StackSize { memsize }? }* - }* + }? & [ a:documentation [ xml:lang="en" """ -The Tracing element controls the amount and type of information that -is written into the tracing log by the DDSI service. This is useful to -track the DDSI service during application development.
""" ] ] +The Tracing element controls the amount and type of information that is written into the tracing log by the DDSI service. This is useful to track the DDSI service during application development.
""" ] ] element Tracing { [ a:documentation [ xml:lang="en" """ -This option specifies whether the output is to be appended to an -existing log file. The default is to create a new log file each time, -which is generally the best option if a detailed log is -generated.
The default value is: "false".
""" ] ] +This option specifies whether the output is to be appended to an existing log file. The default is to create a new log file each time, which is generally the best option if a detailed log is generated.
+The default value is: "false".
""" ] ] element AppendToFile { xsd:boolean }? & [ a:documentation [ xml:lang="en" """ -This element enables individual logging categories. These are enabled -in addition to those enabled by Tracing/Verbosity. Recognised categories -are:
- -This element enables individual logging categories. These are enabled in addition to those enabled by Tracing/Verbosity. Recognised categories are:
+In addition, there is the keyword trace that enables all but -radmin, topic, plist and whc
. - -The categorisation of tracing output is incomplete and hence most of -the verbosity levels and categories are not of much use in the current -release. This is an ongoing process and here we describe the target -situation rather than the current situation. Currently, the most useful -is trace.
The default value is: "".
""" ] ] +In addition, there is the keyword trace that enables all but radmin, topic, plist and whc
. +The categorisation of tracing output is incomplete and hence most of the verbosity levels and categories are not of much use in the current release. This is an ongoing process and here we describe the target situation rather than the current situation. Currently, the most useful is trace.
+The default value is: "".
""" ] ] element Category { xsd:token { pattern = "((fatal|error|warning|info|config|discovery|data|radmin|timing|traffic|topic|tcp|plist|whc|throttle|rhc|content|trace)(,(fatal|error|warning|info|config|discovery|data|radmin|timing|traffic|topic|tcp|plist|whc|throttle|rhc|content|trace))*)|" } }? & [ a:documentation [ xml:lang="en" """ -This option specifies where the logging is printed to. Note that -stdout and stderr are treated as special values, -representing "standard out" and "standard error" respectively. No file is -created unless logging categories are enabled using the Tracing/Verbosity -or Tracing/EnabledCategory settings.
The default value is: -"cyclonedds.log".
""" ] ] +This option specifies where the logging is printed to. Note that stdout and stderr are treated as special values, representing "standard out" and "standard error" respectively. No file is created unless logging categories are enabled using the Tracing/Verbosity or Tracing/EnabledCategory settings.
+The default value is: "cyclonedds.log".
""" ] ] element OutputFile { text }? & [ a:documentation [ xml:lang="en" """ -This option specifies the file to which received and sent packets will -be logged in the "pcap" format suitable for analysis using common -networking tools, such as WireShark. IP and UDP headers are fictitious, -in particular the destination address of received packets. The TTL may be -used to distinguish between sent and received packets: it is 255 for sent -packets and 128 for received ones. Currently IPv4 only.
The default -value is: "".
""" ] ] +This option specifies the file to which received and sent packets will be logged in the "pcap" format suitable for analysis using common networking tools, such as WireShark. IP and UDP headers are fictitious, in particular the destination address of received packets. The TTL may be used to distinguish between sent and received packets: it is 255 for sent packets and 128 for received ones. Currently IPv4 only.
+The default value is: "".
""" ] ] element PacketCaptureFile { text }? & [ a:documentation [ xml:lang="en" """ -This element enables standard groups of categories, based on a desired -verbosity level. This is in addition to the categories enabled by the -Tracing/Category setting. Recognised verbosity levels and the categories -they map to are:
- +This element enables standard groups of categories, based on a desired verbosity level. This is in addition to the categories enabled by the Tracing/Category setting. Recognised verbosity levels and the categories they map to are:
While none prevents any message from being written to a Cyclone -DDS log file.
- -The categorisation of tracing output is incomplete and hence most of -the verbosity levels and categories are not of much use in the current -release. This is an ongoing process and here we describe the target -situation rather than the current situation. Currently, the most useful -verbosity levels are config, fine and -finest.
The default value is: "none".
""" ] ] +While none prevents any message from being written to a DDSI2 log file.
+The categorisation of tracing output is incomplete and hence most of the verbosity levels and categories are not of much use in the current release. This is an ongoing process and here we describe the target situation rather than the current situation. Currently, the most useful verbosity levels are config, fine and finest.
+The default value is: "none".
""" ] ] element Verbosity { ("finest"|"finer"|"fine"|"config"|"info"|"warning"|"severe"|"none") }? - }* - }* + }? + }? } bandwidth = xsd:token { pattern = "0|(\d+(\.\d*)?([Ee][\-+]?\d+)?|\.\d+([Ee][\-+]?\d+)?) *([kMG]i?)?[Bb][p/]s" } duration = xsd:token { pattern = "0|(\d+(\.\d*)?([Ee][\-+]?\d+)?|\.\d+([Ee][\-+]?\d+)?) *([num]?s|min|hr|day)" } duration_inf = xsd:token { pattern = "inf|0|(\d+(\.\d*)?([Ee][\-+]?\d+)?|\.\d+([Ee][\-+]?\d+)?) *([num]?s|min|hr|day)" } memsize = xsd:token { pattern = "0|(\d+(\.\d*)?([Ee][\-+]?\d+)?|\.\d+([Ee][\-+]?\d+)?) *([kMG]i?)?B" } -} +} \ No newline at end of file diff --git a/etc/cyclonedds.xsd b/etc/cyclonedds.xsd index 8214bf1..d38f2ea 100644 --- a/etc/cyclonedds.xsd +++ b/etc/cyclonedds.xsd @@ -7,7 +7,7 @@ CycloneDDS configurationThis 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.
" + )), + STRING("MulticastRecvNetworkInterfaceAddresses", NULL, 1, "preferred", + MEMBER(networkRecvAddressStrings), + FUNCTIONS(0, uf_networkAddresses, ff_networkAddresses, pf_networkAddresses), + DESCRIPTION( + "This element specifies on which network interfaces Cyclone DDS " + "listens to multicasts. The following options are available:
\n" + "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.
" + )), + STRING("ExternalNetworkAddress", NULL, 1, "auto", + MEMBER(externalAddressString), + FUNCTIONS(0, uf_networkAddress, ff_free, pf_networkAddress), + DESCRIPTION( + "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.
")), + STRING("ExternalNetworkMask", NULL, 1, "0.0.0.0", + MEMBER(externalMaskString), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "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.
")), + LIST("AllowMulticast", NULL, 1, "default", + MEMBER(allowMulticast), + FUNCTIONS(0, uf_allow_multicast, 0, pf_allow_multicast), + DESCRIPTION( + "This element controls whether Cyclone DDS uses multicasts for data " + "traffic.
\n" + "It is a comma-separated list of some of the following keywords: " + "\"spdp\", \"asm\", \"ssm\", or either of \"false\" or \"true\", or " + "\"default\".
\n" + "When set to \"false\" all multicasting is disabled. The default, " + "\"true\" enables full use of multicasts. Listening for multicasts can " + "be controlled by General/MulticastRecvNetworkInterfaceAddresses.
\n" + "\"default\" maps on spdp if the network is a WiFi network, on true " + "if it is a wired network
"), + VALUES("false","spdp","asm","ssm","true")), + BOOL("PreferMulticast", NULL, 1, "false", + MEMBER(prefer_multicast), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "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.
")), + INT("MulticastTimeToLive", NULL, 1, "32", + MEMBER(multicast_ttl), + FUNCTIONS(0, uf_natint_255, 0, pf_int), + DESCRIPTION( + "This element specifies the time-to-live setting for outgoing " + "multicast packets.
"), + RANGE("0;255")), + BOOL("DontRoute", NULL, 1, "false", + MEMBER(dontRoute), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "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.
")), + ENUM("UseIPv6", NULL, 1, "default", + MEMBER(compat_use_ipv6), + FUNCTIONS(0, uf_boolean_default, 0, pf_nop), + DESCRIPTION("Deprecated (use Transport instead)
"), + VALUES("false","true","default")), + ENUM("Transport", NULL, 1, "default", + MEMBER(transport_selector), + FUNCTIONS(0, uf_transport_selector, 0, pf_transport_selector), + DESCRIPTION( + "This element allows selecting the transport to be used (udp, udp6, " + "tcp, tcp6, raweth)
"), + VALUES("default","udp","udp6","tcp","tcp6","raweth")), + BOOL("EnableMulticastLoopback", NULL, 1, "true", + MEMBER(enableMulticastLoopback), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "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, but 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.
")), + STRING("MaxMessageSize", NULL, 1, "4096 B", + MEMBER(max_msg_size), + FUNCTIONS(0, uf_memsize, 0, pf_memsize), + DESCRIPTION( + "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).
\n" + "On some networks it may be necessary to set this item to keep the " + "packetsize below the MTU to prevent IP fragmentation. In those cases, " + "it is generally advisable to also consider reducing " + "Internal/FragmentSize.
"), + UNIT("memsize")), + STRING("FragmentSize", NULL, 1, "1280 B", + MEMBER(fragment_size), + FUNCTIONS(0, uf_memsize, 0, pf_memsize), + DESCRIPTION( + "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.
"), + UNIT("memsize")), + END_MARKER +}; + +#ifdef DDSI_INCLUDE_SECURITY +static struct cfgelem authentication_library_attributes[] = { + STRING("path", NULL, 1, "dds_security_auth", + MEMBEROF(config_omg_security_listelem, cfg.authentication_plugin.library_path), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "This element points to the path of Authentication plugin library.
\n" + "It can be either absolute path excluding file extension " + "( /usr/lib/dds_security_auth ) or single file without extension " + "( dds_security_auth ).
\n" + "If single file is supplied, the library located by way of the " + "current working directory, or LD_LIBRARY_PATH for Unix systems, and " + "PATH for Windows system.
" + )), + STRING("initFunction", NULL, 1, "init_authentication", + MEMBEROF(config_omg_security_listelem, cfg.authentication_plugin.library_init), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "This element names the initialization function of Authentication " + "plugin. This function is called after loading the plugin library for " + "instantiation purposes. Init function must return an object that " + "implements DDS Security Authentication interface.
" + )), + STRING("finalizeFunction", NULL, 1, "finalize_authentication", + MEMBEROF(config_omg_security_listelem, cfg.authentication_plugin.library_finalize), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "This element names the finalization function of Authentication " + "plugin. This function is called to let the plugin release its " + "resources.
" + )), + END_MARKER +}; + +static struct cfgelem access_control_library_attributes[] = { + STRING("path", NULL, 1, "dds_security_ac", + MEMBEROF(config_omg_security_listelem, cfg.access_control_plugin.library_path), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "This element points to the path of Access Control plugin library.
\n" + "It can be either absolute path excluding file extension " + "( /usr/lib/dds_security_ac ) or single file without extension " + "( dds_security_ac ).
\n" + "If single file is supplied, the library located by way of the " + "current working directory, or LD_LIBRARY_PATH for Unix systems, and " + "PATH for Windows systems.
" + )), + STRING("initFunction", NULL, 1, "init_access_control", + MEMBEROF(config_omg_security_listelem, cfg.access_control_plugin.library_init), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "This element names the initialization function of Access Control " + "plugin. This function is called after loading the plugin library for " + "instantiation purposes. Init function must return an object that " + "implements DDS Security Access Control interface.
" + )), + STRING("finalizeFunction", NULL, 1, "finalize_access_control", + MEMBEROF(config_omg_security_listelem, cfg.access_control_plugin.library_finalize), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "This element names the finalization function of Access Control " + "plugin. This function is called to let the plugin release its " + "resources.
" + )), + END_MARKER +}; + +static struct cfgelem cryptography_library_attributes[] = { + STRING("path", NULL, 1, "dds_security_crypto", + MEMBEROF(config_omg_security_listelem, cfg.cryptography_plugin.library_path), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "This element points to the path of Cryptographic plugin library.
\n" + "It can be either absolute path excluding file extension " + "( /usr/lib/dds_security_crypto ) or single file without extension " + "( dds_security_crypto ).
\n" + "If single file is supplied, the library located by way of the " + "current working directory, or LD_LIBRARY_PATH for Unix systems, and " + "PATH for Windows systems.
" + )), + STRING("initFunction", NULL, 1, "init_crypto", + MEMBEROF(config_omg_security_listelem, cfg.cryptography_plugin.library_init), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "This element names the initialization function of Cryptographic " + "plugin. This function is called after loading the plugin library for " + "instantiation purposes. Init function must return an object that " + "implements DDS Security Cryptographic interface.
" + )), + STRING("finalizeFunction", NULL, 1, "finalize_crypto", + MEMBEROF(config_omg_security_listelem, cfg.cryptography_plugin.library_finalize), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "This element names the finalization function of Cryptographic " + "plugin. This function is called to let the plugin release its " + "resources.
" + )), + END_MARKER +}; + +static struct cfgelem authentication_config_elements[] = { + STRING("Library", authentication_library_attributes, 1, "", + MEMBEROF(config_omg_security_listelem, cfg.authentication_plugin), + FUNCTIONS(0, 0, 0, pf_string), + DESCRIPTION( + "This element specifies the library to be loaded as the DDS " + "Security Access Control plugin.
" + )), + STRING("IdentityCertificate", NULL, 1, NULL, + MEMBEROF(config_omg_security_listelem, cfg.authentication_properties.identity_certificate), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "Identity certificate that will be used for identifying all "
+ "participants in the OSPL instance.
The content is URI to a X509 "
+ "certificate signed by the IdentityCA in PEM format containing the "
+ "signed public key.
Supported URI schemes: file, data
\n" + "Examples:
\n" + "
\n"
+ "MIIDjjCCAnYCCQDCEu9...6rmT87dhTo=
\n"
+ "-----END CERTIFICATE-----
URI to the X509 certificate [39] of the Identity CA that is the " + "signer of Identity Certificate.
\n" + "Supported URI schemes: file, data
\n" + "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.
\n" + "Examples:
\n" + "
\n"
+ "MIIC3DCCAcQCCQCWE5x+Z...PhovK0mp2ohhRLYI0ZiyYQ==
\n"
+ "-----END CERTIFICATE-----
URI to access the private Private Key for all of the participants " + "in the OSPL federation.
\n" + "Supported URI schemes: file, data
\n" + "Examples:
\n" + "
\n"
+ "MIIEpAIBAAKCAQEA3HIh...AOBaaqSV37XBUJg==
\n"
+ "-----END RSA PRIVATE KEY-----
A password used to decrypt the private_key.
\n" + "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.
\n" + "If the password property is not present, then the value supplied in " + "the private_key property must contain the unencrypted private key.
" + )), + STRING("TrustedCADirectory", NULL, 1, "", + MEMBEROF(config_omg_security_listelem, cfg.authentication_properties.trusted_ca_dir), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "Trusted CA Directory which contains trusted CA certificates as " + "separated files.
" + )), + BOOL("IncludeOptionalFields", NULL, 1, "false", + MEMBEROF(config_omg_security_listelem, cfg.authentication_properties.include_optional_fields), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "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.
" + )), + END_MARKER +}; + +static struct cfgelem access_control_config_elements[] = { + STRING("Library", access_control_library_attributes, 1, "", + MEMBEROF(config_omg_security_listelem, cfg.access_control_plugin), + FUNCTIONS(0, 0, 0, pf_string), + DESCRIPTION( + "This element specifies the library to be loaded as the " + "DDS Security Access Control plugin.
" + )), + STRING("PermissionsCA", NULL, 1, "", + MEMBEROF(config_omg_security_listelem, cfg.access_control_properties.permissions_ca), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "URI to a X509 certificate for the PermissionsCA in PEM format.
\n" + "Supported URI schemes: file, data
\n" + "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.
Examples:
MIIC3DCCAcQCCQCWE5x+Z ... PhovK0mp2ohhRLYI0ZiyYQ==
\n" + "-----END CERTIFICATE-----
" + )), + STRING("Governance", NULL, 1, "", + MEMBEROF(config_omg_security_listelem, cfg.access_control_properties.governance), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "URI to the shared Governance Document signed by the Permissions CA in S/MIME format
\n" + "URI schemes: file, data
Examples file URIs:
\n" + "Content-Type: multipart/signed; protocol=\"application/x-pkcs7-signature\"; micalg=\"sha-256\"; boundary=\"----F9A8A198D6F08E1285A292ADF14DD04F\" This is an S/MIME signed message ------F9A8A198D6F08E1285A292ADF14DD04F xsi:noNamespaceSchemaLocation=\"omg_shared_ca_governance.xsd\"> . . . ... ------F9A8A198D6F08E1285A292ADF14DD04F Content-Type: application/x-pkcs7-signature; name=\"smime.p7s\" Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename=\"smime.p7s\" MIIDuAYJKoZIhv ...al5s= ------F9A8A198D6F08E1285A292ADF14DD04F-]]
URI to the DomainParticipant permissions document signed by the " + "Permissions CA in S/MIME format
\n" + "The permissions document specifies the permissions to be applied to a domain.
Example file URIs:
\n" + "Example data URI:
\n" + "This element specifies the library to be loaded as the DDS Security Cryptographic plugin.
" + )), + END_MARKER +}; + +static struct cfgelem security_omg_config_elements[] = { + GROUP("Authentication", authentication_config_elements, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "This element configures the Authentication plugin of the DDS Security specification.
" + )), + GROUP("AccessControl", access_control_config_elements, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "This element configures the Access Control plugin of the DDS Security specification.
" + )), + GROUP("Cryptographic", cryptography_config_elements, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "This element configures the Cryptographic plugin of the DDS Security specification.
" + )), + END_MARKER +}; +#endif /* DDSI_INCLUDE_SECURITY */ + +#ifdef DDSI_INCLUDE_NETWORK_PARTITIONS +static struct cfgelem networkpartition_cfgattrs[] = { + STRING("Name", NULL, 1, NULL, + MEMBEROF(config_networkpartition_listelem, name), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "This attribute specifies the name of this Cyclone DDS network " + "partition. Two network partitions cannot have the same name.
")), + STRING("Address", NULL, 1, NULL, + MEMBEROF(config_networkpartition_listelem, address_string), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "This attribute specifies the multicast addresses associated with " + "the network partition as a comma-separated list. Readers matching " + "this network partition (cf. Partitioning/PartitionMappings) will " + "listen for multicasts on all of these addresses and advertise them " + "in the discovery protocol. The writers will select the most suitable " + "address from the addresses advertised by the readers.
")), + BOOL("Connected", NULL, 1, "true", + MEMBEROF(config_networkpartition_listelem, connected), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION("This attribute is a placeholder.
")), + END_MARKER +}; + +static struct cfgelem networkpartitions_cfgelems[] = { + STRING("NetworkPartition", networkpartition_cfgattrs, INT_MAX, 0, + MEMBER(networkPartitions), + FUNCTIONS(if_network_partition, 0, 0, 0), + DESCRIPTION( + "This element defines a Cyclone DDS network partition.
" + )), + END_MARKER +}; + +static struct cfgelem ignoredpartitions_cfgattrs[] = { + STRING("DCPSPartitionTopic", NULL, 1, NULL, + MEMBEROF(config_ignoredpartition_listelem, DCPSPartitionTopic), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "This attribute specifies a partition and a topic expression, " + "separated by a single '.', that 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 an wildcard " + "DCPS partition to match an expression iff there exists a string that " + "satisfies both expressions.
" + )), + END_MARKER +}; + +static struct cfgelem ignoredpartitions_cfgelems[] = { + STRING("IgnoredPartition", ignoredpartitions_cfgattrs, INT_MAX, 0, + MEMBER(ignoredPartitions), + FUNCTIONS(if_ignored_partition, 0, 0, 0), + DESCRIPTION( + "This element can be used to prevent certain combinations of DCPS " + "partition and topic from being transmitted over the network. Cyclone DDS " + "will complete 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.
" + )), + END_MARKER +}; + +static struct cfgelem partitionmappings_cfgattrs[] = { + STRING("NetworkPartition", NULL, 1, NULL, + MEMBEROF(config_partitionmapping_listelem, networkPartition), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "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.
" + )), + STRING("DCPSPartitionTopic", NULL, 1, NULL, + MEMBEROF(config_partitionmapping_listelem, DCPSPartitionTopic), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "This attribute specifies a partition and a topic expression, " + "separated by a single '.', that 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.
" + )), + END_MARKER +}; + +static struct cfgelem partitionmappings_cfgelems[] = { + STRING("PartitionMapping", partitionmappings_cfgattrs, INT_MAX, 0, + MEMBER(partitionMappings), + FUNCTIONS(if_partition_mapping, 0, 0, 0), + DESCRIPTION( + "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 also encrypting the data flow.
" + )), + END_MARKER +}; + +static struct cfgelem partitioning_cfgelems[] = { + GROUP("NetworkPartitions", networkpartitions_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "The NetworkPartitions element specifies the Cyclone DDS network " + "partitions.
" + )), + GROUP("IgnoredPartitions", ignoredpartitions_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "The IgnoredPartitions element specifies DCPS partition/topic " + "combinations that are not distributed over the network.
" + )), + GROUP("PartitionMappings", partitionmappings_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "The PartitionMappings element specifies the mapping from DCPS " + "partition/topic combinations to Cyclone DDS network partitions.
" + )), + END_MARKER +}; +#endif /* DDSI_INCLUDE_NETWORK_PARTITIONS */ + +#ifdef DDSI_INCLUDE_NETWORK_CHANNELS +static struct cfgelem channel_cfgelems[] = { +#ifdef DDSI_INCLUDE_BANDWIDTH_LIMITING + STRING("DataBandwidthLimit", NULL, 1, "inf", + MEMBEROF(config_channel_listelem, data_bandwidth_limit), + FUNCTIONS(0, uf_bandwidth, 0, pf_bandwidth), + DESCRIPTION( + "This element specifies the maximum transmit rate of new samples " + "and directly related data, for this channel. Bandwidth limiting uses " + "a leaky bucket scheme. The default value \"inf\" means Cyclone DDS imposes " + "no limitation, the underlying operating system and hardware will " + "likely limit the maimum transmit rate.
") + UNIT("bandwidth")), + STRING("AuxiliaryBandwidthLimit", NULL, 1, "inf", + MEMBEROF(config_channel_listelem, auxiliary_bandwidth_limit), + FUNCTIONS(0, uf_bandwidth, 0, pf_bandwidth), + DESCRIPTION( + "This element specifies the maximum transmit rate of auxiliary " + "traffic on this channel (e.g. retransmits, heartbeats, etc). " + "Bandwidth limiting uses a leaky bucket scheme. The default value " + "\"inf\" means Cyclone DDS imposes no limitation, the underlying operating " + "system and hardware will likely limit the maximum transmit rate.
") + UNIT("bandwidth")), +#endif + INT("DiffServField", NULL, 1, "0", + MEMBEROF(config_channel_listelem, diffserv_field), + FUNCTIONS(0, uf_natint, 0, pf_int), + DESCRIPTION( + "This element describes the DiffServ setting the channel will apply "
+ "to the networking messages. This parameter determines the value of "
+ "the diffserv field of the IP version 4 packets sent on this channel "
+ "which allows QoS setting to be applied to the network traffic send on "
+ "this channel.
\n"
+ "Windows platform support for setting the diffserv field is dependent "
+ "on the OS version.
\n"
+ "For Windows version 7 or higher a new API (qWAVE) has been introduced. "
+ "For these platforms the specified diffserv value is mapped to one of "
+ "the support traffic types.\n"
+ "The mapping is as follows: 1-8 background traffic; 9-40 excellent "
+ "traffic; 41-55 audio/video traffic; 56 voice traffic; 57-63 control "
+ "traffic.\n"
+ "When an application is run without Administrative priveleges then "
+ "only the diffserv value of 0, 8, 40 or 56 is allowed.
This attribute specifies name of this channel. The name should " + "uniquely identify the channel.
" + )), + INT("TransportPriority", NULL, 1, "0", + MEMBEROF(config_channel_listelem, priority), + FUNCTIONS(0, uf_natint, 0, pf_int), + DESCRIPTION( + "This attribute sets the transport priority threshold for the " + "channel. Each DCPS data writer has a \"transport_priority\" QoS and " + "this QoS is used to select a channel for use by this writer. The " + "selected channel is the one with the largest threshold not greater " + "than the writer's transport priority, and if no such channel exists, " + "the channel with the lowest threshold.
" + )), + END_MARKER +}; + +static struct cfgelem channels_cfgelems[] = { + GROUP("Channel", channel_cfgelems, channel_cfgattrs, INT_MAX, + MEMBER(channels), + FUNCTIONS(if_channel, 0, 0, 0), + DESCRIPTION("This element defines a channel.
")), + END_MARKER +}; +#endif /* DDSI_INCLUDE_NETWORK_CHANNELS */ + +static struct cfgelem thread_properties_sched_cfgelems[] = { + ENUM("Class", NULL, 1, "default", + MEMBEROF(config_thread_properties_listelem, sched_class), + FUNCTIONS(0, uf_sched_class, 0, pf_sched_class), + DESCRIPTION( + "This element specifies the thread scheduling class " + "(realtime, timeshare or default). The user may " + "need special privileges from the underlying operating system to be " + "able to assign some of the privileged scheduling classes.
"), + VALUES("realtime","timeshare","default")), + STRING("Priority", NULL, 1, "default", + MEMBEROF(config_thread_properties_listelem, sched_priority), + FUNCTIONS(0, uf_maybe_int32, 0, pf_maybe_int32), + DESCRIPTION( + "This element specifies the thread priority (decimal integer or " + "default). Only priorities that are 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.
" + )), + END_MARKER +}; + +static struct cfgelem thread_properties_cfgattrs[] = { + STRING("Name", NULL, 1, NULL, + MEMBEROF(config_thread_properties_listelem, name), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "The Name of the thread for which properties are being set. The " + "following threads exist:
\n" + "This element configures the scheduling properties of the thread.
" + )), + STRING("StackSize", NULL, 1, "default", + MEMBEROF(config_thread_properties_listelem, stack_size), + FUNCTIONS(0, uf_maybe_memsize, 0, pf_maybe_memsize), + DESCRIPTION( + "This element configures the stack size for this thread. The " + "default value default leaves the stack size at the operating " + "system default.
"), + 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("This element is used to set thread properties.
")), + 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( + "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:
\n" + "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.
\n" + "When interoperability is required with an implementation that does " + "not follow the specifications in this regard, setting this option to " + "true will help.
" + )), + ENUM("ManySocketsMode", NULL, 1, "single", + MEMBER(many_sockets_mode), + FUNCTIONS(0, uf_many_sockets_mode, 0, pf_many_sockets_mode), + DESCRIPTION( + "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.
\n" + "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.
"), + 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( + "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.
" + )), + END_MARKER +}; + +static struct cfgelem internal_test_cfgelems[] = { + INT("XmitLossiness", NULL, 1, "0", + MEMBER(xmit_lossiness), + FUNCTIONS(0, uf_int, 0, pf_int), + DESCRIPTION( + "This element controls the fraction of outgoing packets to drop, " + "specified as samples per thousand.
" + )), + 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( + "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.
"), + UNIT("memsize")), + STRING("WhcHigh", NULL, 1, "100 kB", + MEMBER(whc_highwater_mark), + FUNCTIONS(0, uf_memsize, 0, pf_memsize), + DESCRIPTION( + "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.
"), + UNIT("memsize")), + STRING("WhcHighInit", NULL, 1, "30 kB", + MEMBER(whc_init_highwater_mark), + FUNCTIONS(0, uf_maybe_memsize, 0, pf_maybe_memsize), + DESCRIPTION( + "This element sets the initial level of the high-water mark for the " + "Cyclone DDS WHCs, expressed in bytes.
"), + UNIT("memsize")), + BOOL("WhcAdaptive|WhcAdaptative", NULL, 1, "true", + MEMBER(whc_adaptive), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "This element controls whether Cyclone DDS will adapt the high-water " + "mark to current traffic conditions, based on retransmit requests and " + "transmit pressure.
" + )), + END_MARKER +}; + +static struct cfgelem control_topic_cfgattrs[] = { + BOOL(DEPRECATED("Enable"), NULL, 1, "false", + MEMBER(enable_control_topic), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "This element controls whether Cyclone DDS should create a topic to " + "control Cyclone DDS's behaviour dynamically.
")), + STRING(DEPRECATED("InitialReset"), NULL, 1, "inf", + MEMBER(initial_deaf_mute_reset), + FUNCTIONS(0, uf_duration_inf, 0, pf_duration), + DESCRIPTION( + "
This element controls after how much time an initial deaf/mute " + "state will automatically reset.
")), + END_MARKER +}; + +static struct cfgelem control_topic_cfgelems[] = { + BOOL(DEPRECATED("Deaf"), NULL, 1, "false", + MEMBER(initial_deaf), + FUNCTIONS(0, uf_deaf_mute, 0, pf_boolean), + DESCRIPTION( + "
This element controls whether Cyclone DDS defaults to deaf mode or to " + "normal mode. This controls both the initial behaviour and what " + "behaviour it auto-reverts to.
")), + BOOL(DEPRECATED("Mute"), NULL, 1, "false", + MEMBER(initial_mute), + FUNCTIONS(0, uf_deaf_mute, 0, pf_boolean), + DESCRIPTION( + "This element controls whether Cyclone DDS defaults to mute mode or to " + "normal mode. This controls both the initial behaviour and what " + "behaviour it auto-reverts to.
")), + END_MARKER +}; + +static struct cfgelem rediscovery_blacklist_duration_attrs[] = { + BOOL("enforce", NULL, 1, "false", + MEMBER(prune_deleted_ppant.enforce_delay), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "This attribute controls whether the configured time during which " + "recently deleted participants will not be rediscovered (i.e., \"black " + "listed\") is enforced and following complete removal of the " + "participant in Cyclone DDS, or whether it can be rediscovered earlier " + "provided all traces of that participant have been removed already.
" + )), + END_MARKER +}; + +static struct cfgelem heartbeat_interval_attrs[] = { + STRING("min", NULL, 1, "5 ms", + MEMBER(const_hb_intv_min), + FUNCTIONS(0, uf_duration_inf, 0, pf_duration), + DESCRIPTION( + "This attribute sets the minimum interval that must have passed " + "since the most recent heartbeat from a writer, before another " + "asynchronous (not directly related to writing) will be sent.
"), + UNIT("duration_inf")), + STRING("minsched", NULL, 1, "20 ms", + MEMBER(const_hb_intv_sched_min), + FUNCTIONS(0, uf_duration_inf, 0, pf_duration), + DESCRIPTION( + "This attribute sets the minimum interval for periodic heartbeats. " + "Other events may still cause heartbeats to go out.
"), + UNIT("duration_inf")), + STRING("max", NULL, 1, "8 s", + MEMBER(const_hb_intv_sched_max), + FUNCTIONS(0, uf_duration_inf, 0, pf_duration), + DESCRIPTION( + "This attribute sets the maximum interval for periodic heartbeats.
"), + UNIT("duration_inf")), + END_MARKER +}; + +static struct cfgelem liveliness_monitoring_attrs[] = { + BOOL("StackTraces", NULL, 1, "true", + MEMBER(noprogress_log_stacktraces), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "This element controls whether or not to write stack traces to the " + "DDSI2 trace when a thread fails to make progress (on select platforms " + "only).
")), + STRING("Interval", NULL, 1, "1s", + MEMBER(liveliness_monitoring_interval), + FUNCTIONS(0, uf_duration_100ms_1hr, 0, pf_duration), + DESCRIPTION( + "This element controls the interval at which to check whether " + "threads have been making progress.
"), + UNIT("duration"), + RANGE("100ms;1hr")), + END_MARKER +}; + +static struct cfgelem multiple_recv_threads_attrs[] = { + INT("maxretries", NULL, 1, "4294967295", + MEMBER(recv_thread_stop_maxretries), + FUNCTIONS(0, uf_uint, 0, pf_uint), + DESCRIPTION( + "Receive threads dedicated to a single socket can only be triggered " + "for termination by sending a packet. Reception of any packet will do, " + "so termination failure due to packet loss is exceedingly unlikely, " + "but to eliminate all risks, it will retry as many times as specified " + "by this attribute before aborting.
" + )), + END_MARKER +}; + +static struct cfgelem internal_cfgelems[] = { + MOVED("MaxMessageSize", "CycloneDDS/General/MaxMessageSize"), + MOVED("FragmentSize", "CycloneDDS/General/FragmentSize"), + INT("DeliveryQueueMaxSamples", NULL, 1, "256", + MEMBER(delivery_queue_maxsamples), + FUNCTIONS(0, uf_uint, 0, pf_uint), + DESCRIPTION( + "This element controls the Maximum size of a delivery queue, " + "expressed in samples. Once a delivery queue is full, incoming samples " + "destined for that queue are dropped until space becomes available " + "again.
")), + INT("PrimaryReorderMaxSamples", NULL, 1, "128", + MEMBER(primary_reorder_maxsamples), + FUNCTIONS(0, uf_uint, 0, pf_uint), + DESCRIPTION( + "This element sets the maximum size in samples of a primary " + "re-order administration. Each proxy writer has one primary re-order " + "administration to buffer the packet flow in case some packets arrive " + "out of order. Old samples are forwarded to secondary re-order " + "administrations associated with readers in need of historical " + "data.
")), + INT("SecondaryReorderMaxSamples", NULL, 1, "128", + MEMBER(secondary_reorder_maxsamples), + FUNCTIONS(0, uf_uint, 0, pf_uint), + DESCRIPTION( + "This element sets the maximum size in samples of a secondary " + "re-order administration. The secondary re-order administration is per " + "reader in need of historical data.
")), + INT("DefragUnreliableMaxSamples", NULL, 1, "4", + MEMBER(defrag_unreliable_maxsamples), + FUNCTIONS(0, uf_uint, 0, pf_uint), + DESCRIPTION( + "This element sets the maximum number of samples that can be " + "defragmented simultaneously for a best-effort writers.
")), + INT("DefragReliableMaxSamples", NULL, 1, "16", + MEMBER(defrag_reliable_maxsamples), + FUNCTIONS(0, uf_uint, 0, pf_uint), + DESCRIPTION( + "This element sets the maximum number of samples that can be " + "defragmented simultaneously for a reliable writer. This has to be " + "large enough to handle retransmissions of historical data in addition " + "to new samples.
")), + ENUM("BuiltinEndpointSet", NULL, 1, "writers", + MEMBER(besmode), + FUNCTIONS(0, uf_besmode, 0, pf_besmode), + DESCRIPTION( + "This element controls which participants will have which built-in " + "endpoints for the discovery and liveliness protocols. Valid values " + "are:
\n" + "The default is writers, as this is thought to be compliant " + "and reasonably efficient. Minimal may or may not be compliant " + "but is most efficient, and full is inefficient but certain to " + "be compliant. See also Internal/ConservativeBuiltinReaderStartup.
"), + VALUES("full","writers","minimal")), + BOOL("MeasureHbToAckLatency", NULL, 1, "false", + MEMBER(meas_hb_to_ack_latency), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "This element enables heartbeat-to-ack latency among Cyclone DDS " + "services by prepending timestamps to Heartbeat and AckNack messages " + "and calculating round trip times. This is non-standard behaviour. The " + "measured latencies are quite noisy and are currently not used " + "anywhere.
")), + BOOL("UnicastResponseToSPDPMessages", NULL, 1, "true", + MEMBER(unicast_response_to_spdp_messages), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "This element controls whether the response to a newly discovered " + "participant is sent as a unicasted SPDP packet, instead of " + "rescheduling the periodic multicasted one. There is no known benefit " + "to setting this to false.
")), + INT("SynchronousDeliveryPriorityThreshold", NULL, 1, "0", + MEMBER(synchronous_delivery_priority_threshold), + FUNCTIONS(0, uf_int, 0, pf_int), + DESCRIPTION( + "This element controls whether samples sent by a writer with QoS " + "settings latency_budget <= SynchronousDeliveryLatencyBound and " + "transport_priority greater than or equal to this element's value will " + "be delivered synchronously from the \"recv\" thread, all others will " + "be delivered asynchronously through delivery queues. This reduces " + "latency at the expense of aggregate bandwidth.
")), + STRING("SynchronousDeliveryLatencyBound", NULL, 1, "inf", + MEMBER(synchronous_delivery_latency_bound), + FUNCTIONS(0, uf_duration_inf, 0, pf_duration), + DESCRIPTION( + "This element controls whether samples sent by a writer with QoS " + "settings transport_priority >= SynchronousDeliveryPriorityThreshold " + "and a latency_budget at most this element's value will be delivered " + "synchronously from the \"recv\" thread, all others will be delivered " + "asynchronously through delivery queues. This reduces latency at the " + "expense of aggregate bandwidth.
"), + UNIT("duration_inf")), + INT("MaxParticipants", NULL, 1, "0", + MEMBER(max_participants), + FUNCTIONS(0, uf_natint, 0, pf_int), + DESCRIPTION( + "This elements configures the maximum number of DCPS domain " + "participants this Cyclone DDS instance is willing to service. 0 is " + "unlimited.
")), + INT("AccelerateRexmitBlockSize", NULL, 1, "0", + MEMBER(accelerate_rexmit_block_size), + FUNCTIONS(0, uf_uint, 0, pf_uint), + DESCRIPTION( + "Proxy readers that are assumed to sill be retrieving historical " + "data get this many samples retransmitted when they NACK something, " + "even if some of these samples have sequence numbers outside the set " + "covered by the NACK.
")), + ENUM("RetransmitMerging", NULL, 1, "never", + MEMBER(retransmit_merging), + FUNCTIONS(0, uf_retransmit_merging, 0, pf_retransmit_merging), + DESCRIPTION( + "This elements controls the addressing and timing of retransmits. " + "Possible values are:
\n" + "The default is never. See also " + "Internal/RetransmitMergingPeriod.
"), + VALUES("never","adaptive","always")), + STRING("RetransmitMergingPeriod", NULL, 1, "5 ms", + MEMBER(retransmit_merging_period), + FUNCTIONS(0, uf_duration_us_1s, 0, pf_duration), + DESCRIPTION( + "This setting determines the size of the time window in which a " + "NACK of some sample is ignored because a retransmit of that sample " + "has been multicasted too recently. This setting has no effect on " + "unicasted retransmits.
\n" + "See also Internal/RetransmitMerging.
"), + UNIT("duration"), + RANGE("0;1s")), + STRING("HeartbeatInterval", heartbeat_interval_attrs, 1, "100 ms", + MEMBER(const_hb_intv_sched), + FUNCTIONS(0, uf_duration_inf, 0, pf_duration), + DESCRIPTION( + "This element allows configuring the base interval for sending " + "writer heartbeats and the bounds within which it can vary.
"), + UNIT("duration_inf")), + STRING("MaxQueuedRexmitBytes", NULL, 1, "50 kB", + MEMBER(max_queued_rexmit_bytes), + FUNCTIONS(0, uf_memsize, 0, pf_memsize), + DESCRIPTION( + "This setting limits the maximum number of bytes queued for " + "retransmission. The default value of 0 is unlimited unless an " + "AuxiliaryBandwidthLimit has been set, in which case it becomes " + "NackDelay * AuxiliaryBandwidthLimit. It must be large enough to " + "contain the largest sample that may need to be retransmitted.
"), + UNIT("memsize")), + INT("MaxQueuedRexmitMessages", NULL, 1, "200", + MEMBER(max_queued_rexmit_msgs), + FUNCTIONS(0, uf_uint, 0, pf_uint), + DESCRIPTION( + "This settings limits the maximum number of samples queued for " + "retransmission.
" + )), + STRING("LeaseDuration", NULL, 1, "10 s", + MEMBER(lease_duration), + FUNCTIONS(0, uf_duration_ms_1hr, 0, pf_duration), + DESCRIPTION( + "This setting controls the default participant lease duration.
"), + UNIT("duration")), + STRING("WriterLingerDuration", NULL, 1, "1 s", + MEMBER(writer_linger_duration), + FUNCTIONS(0, uf_duration_ms_1hr, 0, pf_duration), + DESCRIPTION( + "
This setting controls the maximum duration for which actual " + "deletion of a reliable writer with unacknowledged data in its history " + "will be postponed to provide proper reliable transmission.
"), + UNIT("duration")), + STRING("MinimumSocketReceiveBufferSize", NULL, 1, "default", + MEMBER(socket_min_rcvbuf_size), + FUNCTIONS(0, uf_maybe_memsize, 0, pf_maybe_memsize), + DESCRIPTION( + "
This setting controls the minimum size of socket receive buffers. " + "The operating system provides some size receive buffer upon creation " + "of the socket, this option can be used to increase the size of the " + "buffer beyond that initially provided by the operating system. If the " + "buffer size cannot be increased to the specified size, an error is " + "reported.
\n" + "The default setting is the word \"default\", which means Cyclone DDS " + "will attempt to increase the buffer size to 1MB, but will silently " + "accept a smaller buffer should that attempt fail.
"), + UNIT("memsize")), + STRING("MinimumSocketSendBufferSize", NULL, 1, "64 KiB", + MEMBER(socket_min_sndbuf_size), + FUNCTIONS(0, uf_memsize, 0, pf_memsize), + DESCRIPTION( + "This setting controls the minimum size of socket send buffers. " + "This setting can only increase the size of the send buffer, if the " + "operating system by default creates a larger buffer, it is left " + "unchanged.
"), + UNIT("memsize")), + STRING("NackDelay", NULL, 1, "10 ms", + MEMBER(nack_delay), + FUNCTIONS(0, uf_duration_ms_1hr, 0, pf_duration), + DESCRIPTION( + "This setting controls the delay between receipt of a HEARTBEAT " + "indicating missing samples and a NACK (ignored when the HEARTBEAT " + "requires an answer). However, no NACK is sent if a NACK had been " + "scheduled already for a response earlier than the delay requests: " + "then that NACK will incorporate the latest information.
"), + UNIT("duration")), + STRING("AutoReschedNackDelay", NULL, 1, "1 s", + MEMBER(auto_resched_nack_delay), + FUNCTIONS(0, uf_duration_inf, 0, pf_duration), + DESCRIPTION( + "This setting controls the interval with which a reader will " + "continue NACK'ing missing samples in the absence of a response from " + "the writer, as a protection mechanism against writers incorrectly " + "stopping the sending of HEARTBEAT messages.
"), + UNIT("duration_inf")), + STRING("PreEmptiveAckDelay", NULL, 1, "10 ms", + MEMBER(preemptive_ack_delay), + FUNCTIONS(0, uf_duration_ms_1hr, 0, pf_duration), + DESCRIPTION( + "This setting controls the delay between the discovering a remote " + "writer and sending a pre-emptive AckNack to discover the range of " + "data available.
"), + UNIT("duration")), + STRING("ScheduleTimeRounding", NULL, 1, "0 ms", + MEMBER(schedule_time_rounding), + FUNCTIONS(0, uf_duration_ms_1hr, 0, pf_duration), + DESCRIPTION( + "This setting allows the timing of scheduled events to be rounded " + "up so that more events can be handled in a single cycle of the event " + "queue. The default is 0 and causes no rounding at all, i.e. are " + "scheduled exactly, whereas a value of 10ms would mean that events are " + "rounded up to the nearest 10 milliseconds.
"), + UNIT("duration")), +#ifdef DDSI_INCLUDE_BANDWIDTH_LIMITING + STRING("AuxiliaryBandwidthLimit", NULL, 1, "inf", + MEMBER(auxiliary_bandwidth_limit), + FUNCTIONS(0, uf_bandwidth, 0, pf_bandwidth), + DESCRIPTION( + "This element specifies the maximum transmit rate of auxiliary " + "traffic not bound to a specific channel, such as discovery traffic, " + "as well as auxiliary traffic related to a certain channel if that " + "channel has elected to share this global AuxiliaryBandwidthLimit. " + "Bandwidth limiting uses a leaky bucket scheme. The default value " + "\"inf\" means Cyclone DDS imposes no limitation, the underlying operating " + "system and hardware will likely limit the maimum transmit rate.
" + )), +#endif + INT("DDSI2DirectMaxThreads", NULL, 1, "1", + MEMBER(ddsi2direct_max_threads), + FUNCTIONS(0, uf_uint, 0, pf_uint), + DESCRIPTION( + "This element sets the maximum number of extra threads for an " + "experimental, undocumented and unsupported direct mode.
")), + BOOL("SquashParticipants", NULL, 1, "false", + MEMBER(squash_participants), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "This element controls whether Cyclone DDS advertises all the domain " + "participants it serves in DDSI (when set to false), or rather " + "only one domain participant (the one corresponding to the Cyclone DDS " + "process; when set to true). In the latter case Cyclone DDS becomes " + "the virtual owner of all readers and writers of all domain " + "participants, dramatically reducing discovery traffic (a similar " + "effect can be obtained by setting Internal/BuiltinEndpointSet to " + "\"minimal\" but with less loss of information).
" + )), + STRING("SPDPResponseMaxDelay", NULL, 1, "0 ms", + MEMBER(spdp_response_delay_max), + FUNCTIONS(0, uf_duration_ms_1s, 0, pf_duration), + DESCRIPTION( + "Maximum pseudo-random delay in milliseconds between discovering a" + "remote participant and responding to it.
"), + UNIT("duration")), + BOOL("LateAckMode", NULL, 1, "false", + MEMBER(late_ack_mode), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "Ack a sample only when it has been delivered, instead of when " + "committed to delivering it.
")), + BOOL("RetryOnRejectBestEffort", NULL, 1, "false", + MEMBER(retry_on_reject_besteffort), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "Whether or not to locally retry pushing a received best-effort " + "sample into the reader caches when resource limits are reached.
")), + BOOL("GenerateKeyhash", NULL, 1, "false", + MEMBER(generate_keyhash), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "When true, include keyhashes in outgoing data for topics with " + "keys.
" + )), + STRING("MaxSampleSize", NULL, 1, "2147483647 B", + MEMBER(max_sample_size), + FUNCTIONS(0, uf_memsize, 0, pf_memsize), + DESCRIPTION( + "This setting controls the maximum (CDR) serialised size of samples " + "that Cyclone DDS will forward in either direction. Samples larger than " + "this are discarded with a warning.
"), + UNIT("memsize")), + BOOL("WriteBatch", NULL, 1, "false", + MEMBER(whc_batch), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "This element enables the batching of write operations. By default " + "each write operation writes through the write cache and out onto the " + "transport. Enabling write batching causes multiple small write " + "operations to be aggregated within the write cache into a single " + "larger write. This gives greater throughput at the expense of " + "latency. Currently there is no mechanism for the write cache to " + "automatically flush itself, so that if write batching is enabled, " + "the application may have to use the dds_write_flush function to " + "ensure that all samples are written.
" + )), + BOOL("LivelinessMonitoring", liveliness_monitoring_attrs, 1, "false", + MEMBER(liveliness_monitoring), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "This element controls whether or not implementation should " + "internally monitor its own liveliness. If liveliness monitoring is " + "enabled, stack traces can be dumped automatically when some thread " + "appears to have stopped making progress.
" + )), + INT("MonitorPort", NULL, 1, "-1", + MEMBER(monitor_port), + FUNCTIONS(0, uf_int, 0, pf_int), + DESCRIPTION( + "This element allows configuring a service that dumps a text " + "description of part the internal state to TCP clients. By default " + "(-1), this is disabled; specifying 0 means a kernel-allocated port is " + "used; a positive number is used as the TCP port number.
" + )), + STRING("AssumeMulticastCapable", NULL, 1, "", + MEMBER(assumeMulticastCapable), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "This element controls which network interfaces are assumed to be " + "capable of multicasting even when the interface flags returned by the " + "operating system state it is not (this provides a workaround for some " + "platforms). It is a comma-separated lists of patterns (with ? and * " + "wildcards) against which the interface names are matched.
" + )), + BOOL("PrioritizeRetransmit", NULL, 1, "true", + MEMBER(prioritize_retransmit), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "This element controls whether retransmits are prioritized over new " + "data, speeding up recovery.
" + )), + INT("UseMulticastIfMreqn", NULL, 1, "0", + MEMBER(use_multicast_if_mreqn), + FUNCTIONS(0, uf_int, 0, pf_int), + DESCRIPTION("Do not use.
")), + BOOL("SendAsync", NULL, 1, "false", + MEMBER(xpack_send_async), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "This element controls whether the actual sending of packets occurs " + "on the same thread that prepares them, or is done asynchronously by " + "another thread.
" + )), + STRING("RediscoveryBlacklistDuration", rediscovery_blacklist_duration_attrs, 1, "0s", + MEMBER(prune_deleted_ppant.delay), + FUNCTIONS(0, uf_duration_inf, 0, pf_duration), + DESCRIPTION( + "This element controls for how long a remote participant that was " + "previously deleted will remain on a blacklist to prevent rediscovery, " + "giving the software on a node time to perform any cleanup actions it " + "needs to do. To some extent this delay is required internally by " + "Cyclone DDS, but in the default configuration with the 'enforce' attribute " + "set to false, Cyclone DDS will reallow rediscovery as soon as it has " + "cleared its internal administration. Setting it to too small a value " + "may result in the entry being pruned from the blacklist before Cyclone DDS " + "is ready, it is therefore recommended to set it to at least several " + "seconds.
"), + UNIT("duration_inf")), + ENUM("MultipleReceiveThreads", multiple_recv_threads_attrs, 1, "default", + MEMBER(multiple_recv_threads), + FUNCTIONS(0, uf_boolean_default, 0, pf_boolean_default), + DESCRIPTION( + "This element controls whether all traffic is handled by a single " + "receive thread (false) or whether multiple receive threads may be used " + "to improve latency (true). By default it is disabled on Windows because " + "it appears that one cannot count on being able to send packets to " + "oneself, which is necessary to stop the thread during shutdown. " + "Currently multiple receive threads are only used for connectionless " + "transport (e.g., UDP) and ManySocketsMode not set to single (the " + "default).
"), + VALUES("false","true","default")), + GROUP("ControlTopic", control_topic_cfgelems, control_topic_cfgattrs, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "The ControlTopic element allows configured whether Cyclone DDS provides " + "a special control interface via a predefined topic or not.
" + )), + GROUP("Test", internal_test_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION("
Testing options.
")), + GROUP("Watermarks", internal_watermarks_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION("Watermarks for flow-control.
")), + LIST("EnableExpensiveChecks", NULL, 1, "", + MEMBER(enabled_xchecks), + FUNCTIONS(0, uf_xcheck, 0, pf_xcheck), + DESCRIPTION( + "This element enables expensive checks in builds with assertions " + "enabled and is ignored otherwise. Recognised categories are:
\n" + "In addition, there is the keyword all that enables all " + "checks.
"), + VALUES("whc","rhc","all")), + END_MARKER +}; + +static struct cfgelem sizing_cfgelems[] = { + STRING("ReceiveBufferSize", NULL, 1, "1 MiB", + MEMBER(rbuf_size), + FUNCTIONS(0, uf_memsize, 0, pf_memsize), + DESCRIPTION( + "This element sets the size of a single receive buffer. Many receive " + "buffers may be needed. The minimum workable size a little bit larger " + "than Sizing/ReceiveBufferChunkSize, and the value used is taken as the " + "configured value and the actual minimum workable size.
"), + UNIT("memsize")), + STRING("ReceiveBufferChunkSize", NULL, 1, "128 KiB", + MEMBER(rmsg_chunk_size), + FUNCTIONS(0, uf_memsize, 0, pf_memsize), + DESCRIPTION( + "This element specifies the size of one allocation unit in the " + "receive buffer. Must be greater than the maximum packet size by a " + "modest amount (too large packets are dropped). Each allocation is " + "shrunk immediately after processing a message, or freed " + "straightaway.
"), + UNIT("memsize")), + END_MARKER +}; + +static struct cfgelem discovery_ports_cfgelems[] = { + INT("Base", NULL, 1, "7400", + MEMBER(ports.base), + FUNCTIONS(0, uf_uint, 0, pf_uint), + DESCRIPTION( + "This element specifies the base port number (refer to the DDSI 2.1 " + "specification, section 9.6.1, constant PB).
" + )), + INT("DomainGain", NULL, 1, "250", + MEMBER(ports.dg), + FUNCTIONS(0, uf_uint, 0, pf_uint), + DESCRIPTION( + "This element specifies the domain gain, relating domain ids to sets " + "of port numbers (refer to the DDSI 2.1 specification, section 9.6.1, " + "constant DG).
" + )), + INT("ParticipantGain", NULL, 1, "2", + MEMBER(ports.pg), + FUNCTIONS(0, uf_uint, 0, pf_uint), + DESCRIPTION( + "This element specifies the participant gain, relating p0, " + "participant index to sets of port numbers (refer to the DDSI 2.1 " + "specification, section 9.6.1, constant PG).
" + )), + INT("MulticastMetaOffset", NULL, 1, "0", + MEMBER(ports.d0), + FUNCTIONS(0, uf_uint, 0, pf_uint), + DESCRIPTION( + "This element specifies the port number for multicast meta traffic " + "(refer to the DDSI 2.1 specification, section 9.6.1, constant d0).
" + )), + INT("UnicastMetaOffset", NULL, 1, "10", + MEMBER(ports.d1), + FUNCTIONS(0, uf_uint, 0, pf_uint), + DESCRIPTION( + "This element specifies the port number for unicast meta traffic " + "(refer to the DDSI 2.1 specification, section 9.6.1, constant d1).
" + )), + INT("MulticastDataOffset", NULL, 1, "1", + MEMBER(ports.d2), + FUNCTIONS(0, uf_uint, 0, pf_uint), + DESCRIPTION( + "This element specifies the port number for multicast data traffic " + "(refer to the DDSI 2.1 specification, section 9.6.1, constant d2).
" + )), + INT("UnicastDataOffset", NULL, 1, "11", + MEMBER(ports.d3), + FUNCTIONS(0, uf_uint, 0, pf_uint), + DESCRIPTION( + "This element specifies the port number for unicast data traffic " + "(refer to the DDSI 2.1 specification, section 9.6.1, constant d3).
" + )), + END_MARKER +}; + +static struct cfgelem tcp_cfgelems[] = { + ENUM("Enable", NULL, 1, "default", + MEMBER(compat_tcp_enable), + FUNCTIONS(0, uf_boolean_default, 0, pf_nop), + DESCRIPTION( + "This element enables the optional TCP transport - deprecated, " + "use General/Transport instead.
"), + VALUES("false","true","default")), + BOOL("NoDelay", NULL, 1, "true", + MEMBER(tcp_nodelay), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "This element enables the TCP_NODELAY socket option, preventing " + "multiple DDSI messages being sent in the same TCP request. Setting " + "this option typically optimises latency over throughput.
" + )), + INT("Port", NULL, 1, "-1", + MEMBER(tcp_port), + FUNCTIONS(0, uf_dyn_port, 0, pf_int), + DESCRIPTION( + "This element specifies the TCP port number on which Cyclone DDS accepts " + "connections. If the port is set it is used in entity locators, " + "published with DDSI discovery. Dynamically allocated if zero. Disabled " + "if -1 or not configured. If disabled other DDSI services will not be " + "able to establish connections with the service, the service can only " + "communicate by establishing connections to other services.
"), + RANGE("-1;65535")), + STRING("ReadTimeout", NULL, 1, "2 s", + MEMBER(tcp_read_timeout), + FUNCTIONS(0, uf_duration_ms_1hr, 0, pf_duration), + DESCRIPTION( + "This element specifies the timeout for blocking TCP read " + "operations. If this timeout expires then the connection is closed.
"), + UNIT("duration")), + STRING("WriteTimeout", NULL, 1, "2 s", + MEMBER(tcp_write_timeout), + FUNCTIONS(0, uf_duration_ms_1hr, 0, pf_duration), + DESCRIPTION( + "This element specifies the timeout for blocking TCP write " + "operations. If this timeout expires then the connection is closed.
"), + UNIT("duration")), + BOOL("AlwaysUsePeeraddrForUnicast", NULL, 1, "false", + MEMBER(tcp_use_peeraddr_for_unicast), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "Setting this to true means the unicast addresses in SPDP packets " + "will be ignored and the peer address from the TCP connection will be " + "used instead. This may help work around incorrectly advertised " + "addresses when using TCP.
" + )), + END_MARKER +}; + +#ifdef DDSI_INCLUDE_SSL +static struct cfgelem ssl_cfgelems[] = { + BOOL("Enable", NULL, 1, "false", + MEMBER(ssl_enable), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION("This enables SSL/TLS for TCP.
")), + BOOL("CertificateVerification", NULL, 1, "true", + MEMBER(ssl_verify), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "If disabled this allows SSL connections to occur even if an X509 " + "certificate fails verification.
" + )), + BOOL("VerifyClient", NULL, 1, "true", + MEMBER(ssl_verify_client), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "This enables an SSL server checking the X509 certificate of a " + "connecting client.
" + )), + BOOL("SelfSignedCertificates", NULL, 1, "false", + MEMBER(ssl_self_signed), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "This enables the use of self signed X509 certificates.
" + )), + STRING("KeystoreFile", NULL, 1, "keystore", + MEMBER(ssl_keystore), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "The SSL/TLS key and certificate store file name. The keystore must " + "be in PEM format.
" + )), + STRING("KeyPassphrase", NULL, 1, "secret", + MEMBER(ssl_key_pass), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION("The SSL/TLS key pass phrase for encrypted keys.
")), + STRING("Ciphers", NULL, 1, "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH", + MEMBER(ssl_ciphers), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION("The set of ciphers used by SSL/TLS
")), + STRING("EntropyFile", NULL, 1, "", + MEMBER(ssl_rand_file), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION("The SSL/TLS random entropy file name.
")), + STRING("MinimumTLSVersion", NULL, 1, "1.3", + MEMBER(ssl_min_version), + FUNCTIONS(0, uf_min_tls_version, 0, pf_min_tls_version), + DESCRIPTION( + "The minimum TLS version that may be negotiated, valid values are " + "1.2 and 1.3.
" + )), + END_MARKER +}; +#endif + +static struct cfgelem tp_cfgelems[] = { + BOOL("Enable", NULL, 1, "false", + MEMBER(tp_enable), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION("Enable optional use of a thread pool.
")), + INT("Threads", NULL, 1, "4", + MEMBER(tp_threads), + FUNCTIONS(0, uf_natint, 0, pf_int), + DESCRIPTION("Initial number of threads in the thread pool.
")), + INT("ThreadMax", NULL, 1, "8", + MEMBER(tp_max_threads), + FUNCTIONS(0, uf_natint, 0, pf_int), + DESCRIPTION("Maximum number of threads in the thread pool.
")), + END_MARKER +}; + +static struct cfgelem discovery_peer_cfgattrs[] = { + STRING("Address", NULL, 1, NULL, + MEMBEROF(config_peer_listelem, peer), + FUNCTIONS(0, uf_ipv4, ff_free, pf_string), + DESCRIPTION( + "This element specifies an IP address to which discovery packets " + "must be sent, in addition to the default multicast address (see also " + "General/AllowMulticast). Both a hostnames and a numerical IP address " + "is accepted; the hostname or IP address may be suffixed with :PORT to " + "explicitly set the port to which it must be sent. Multiple Peers may " + "be specified.
" + )), + END_MARKER +}; + +static struct cfgelem discovery_peers_group_cfgelems[] = { + GROUP("Peer", NULL, discovery_peer_cfgattrs, INT_MAX, + MEMBER(peers_group), + FUNCTIONS(if_peer, 0, 0, 0), + DESCRIPTION( + "This element statically configures an addresses for discovery.
" + )), + END_MARKER +}; + +static struct cfgelem discovery_peers_cfgelems[] = { + GROUP("Peer", NULL, discovery_peer_cfgattrs, INT_MAX, + MEMBER(peers), + FUNCTIONS(if_peer, 0, 0, 0), + DESCRIPTION( + "This element statically configures an addresses for discovery.
" + )), + GROUP("Group", discovery_peers_group_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "This element statically configures a fault tolerant group of " + "addresses for discovery. Each member of the group is tried in " + "sequence until one succeeds.
" + )), + END_MARKER +}; + +static struct cfgelem discovery_cfgelems[] = { + STRING("Tag", NULL, 0, "", + MEMBER(domainTag), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "String extension for domain id that remote participants must match " + "to be discovered.
" + )), + STRING("ExternalDomainId", NULL, 1, "default", + MEMBER(extDomainId), + FUNCTIONS(0, uf_maybe_int32, 0, pf_maybe_int32), + DESCRIPTION( + "An override for the domain id, to be used in discovery and for " + "determining the port number mapping. This allows creating multiple " + "domains in a single process while making them appear as a single " + "domain on the network. The value \"default\" disables the override.
" + )), + STRING("DSGracePeriod", NULL, 1, "30 s", + MEMBER(ds_grace_period), + FUNCTIONS(0, uf_duration_inf, 0, pf_duration), + DESCRIPTION( + "This setting controls for how long endpoints discovered via a " + "Cloud discovery service will survive after the discovery service " + "disappeared, allowing reconnect without loss of data when the " + "discovery service restarts (or another instance takes over).
"), + UNIT("duration_inf")), + GROUP("Peers", discovery_peers_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "This element statically configures addresses for discovery.
" + )), + STRING("ParticipantIndex", NULL, 1, "none", + MEMBER(participantIndex), + FUNCTIONS(0, uf_participantIndex, 0, pf_participantIndex), + DESCRIPTION( + "This element specifies the DDSI participant index used by this " + "instance of the Cyclone DDS service for discovery purposes. Only one such " + "participant id is used, independent of the number of actual " + "DomainParticipants on the node. It is either:
\n" + "The default is auto. The participant index is part of the " + "port number calculation and if predictable port numbers are needed " + "and fixing the participant index has no adverse effects, it is " + "recommended that the second be option be used.
" + )), + INT("MaxAutoParticipantIndex", NULL, 1, "9", + MEMBER(maxAutoParticipantIndex), + FUNCTIONS(0, uf_natint, 0, pf_int), + DESCRIPTION( + "This element specifies the maximum DDSI participant index selected " + "by this instance of the Cyclone DDS service if the " + "Discovery/ParticipantIndex is \"auto\".
" + )), + STRING("SPDPMulticastAddress", NULL, 1, "239.255.0.1", + MEMBER(spdpMulticastAddressString), + FUNCTIONS(0, uf_ipv4, ff_free, pf_string), + DESCRIPTION( + "This element specifies the multicast address that is used as the " + "destination for the participant discovery packets. In IPv4 mode the " + "default is the (standardised) 239.255.0.1, in IPv6 mode it becomes " + "ff02::ffff:239.255.0.1, which is a non-standardised link-local " + "multicast address.
" + )), + STRING("SPDPInterval", NULL, 1, "30 s", + MEMBER(spdp_interval), + FUNCTIONS(0, uf_duration_ms_1hr, 0, pf_duration), + DESCRIPTION( + "This element specifies the interval between spontaneous " + "transmissions of participant discovery packets.
"), + UNIT("duration")), + STRING("DefaultMulticastAddress", NULL, 1, "auto", + MEMBER(defaultMulticastAddressString), + FUNCTIONS(0, uf_networkAddress, 0, pf_networkAddress), + DESCRIPTION( + "This element specifies the default multicast address for all " + "traffic other than participant discovery packets. It defaults to " + "Discovery/SPDPMulticastAddress.
" + )), + GROUP("Ports", discovery_ports_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "The Ports element allows specifying various parameters related to " + "the port numbers used for discovery. These all have default values " + "specified by the DDSI 2.1 specification and rarely need to be " + "changed.
" + )), + END_MARKER +}; + +static struct cfgelem tracing_cfgelems[] = { + LIST("Category|EnableCategory", NULL, 1, "", + NOMEMBER, + FUNCTIONS(0, uf_tracemask, 0, pf_tracemask), + DESCRIPTION( + "This element enables individual logging categories. These are " + "enabled in addition to those enabled by Tracing/Verbosity. Recognised " + "categories are:
\n" + "In addition, there is the keyword trace that enables all " + "but radmin, topic, plist and whc
.\n" + "The categorisation of tracing output is incomplete and hence most " + "of the verbosity levels and categories are not of much use in the " + "current release. This is an ongoing process and here we describe the " + "target situation rather than the current situation. Currently, the " + "most useful is trace.
"), + VALUES( + "fatal","error","warning","info","config","discovery","data","radmin", + "timing","traffic","topic","tcp","plist","whc","throttle","rhc", + "content","trace" + )), + ENUM("Verbosity", NULL, 1, "none", + NOMEMBER, + FUNCTIONS(0, uf_verbosity, 0, pf_nop), + DESCRIPTION( + "This element enables standard groups of categories, based on a " + "desired verbosity level. This is in addition to the categories " + "enabled by the Tracing/Category setting. Recognised verbosity levels " + "and the categories they map to are:
\n" + "While none prevents any message from being written to a " + "DDSI2 log file.
\n" + "The categorisation of tracing output is incomplete and hence most " + "of the verbosity levels and categories are not of much use in the " + "current release. This is an ongoing process and here we describe the " + "target situation rather than the current situation. Currently, the " + "most useful verbosity levels are config, fine and " + "finest.
"), + VALUES( + "finest","finer","fine","config","info","warning","severe","none" + )), + STRING("OutputFile", NULL, 1, "cyclonedds.log", + MEMBER(tracefile), + FUNCTIONS(0, uf_tracingOutputFileName, ff_free, pf_string), + DESCRIPTION( + "This option specifies where the logging is printed to. Note that " + "stdout and stderr are treated as special values, " + "representing \"standard out\" and \"standard error\" respectively. No " + "file is created unless logging categories are enabled using the " + "Tracing/Verbosity or Tracing/EnabledCategory settings.
" + )), + BOOL("AppendToFile", NULL, 1, "false", + MEMBER(tracingAppendToFile), + FUNCTIONS(0, uf_boolean, 0, pf_boolean), + DESCRIPTION( + "This option specifies whether the output is to be appended to an " + "existing log file. The default is to create a new log file each time, " + "which is generally the best option if a detailed log is generated.
" + )), + STRING("PacketCaptureFile", NULL, 1, "", + MEMBER(pcap_file), + FUNCTIONS(0, uf_string, ff_free, pf_string), + DESCRIPTION( + "This option specifies the file to which received and sent packets " + "will be logged in the \"pcap\" format suitable for analysis using " + "common networking tools, such as WireShark. IP and UDP headers are " + "fictitious, in particular the destination address of received packets. " + "The TTL may be used to distinguish between sent and received packets: " + "it is 255 for sent packets and 128 for received ones. Currently IPv4 " + "only.
" + )), + END_MARKER +}; + +static struct cfgelem domain_cfgattrs[] = { + STRING("Id", NULL, 0, "any", + MEMBER(domainId), + FUNCTIONS(0, uf_domainId, 0, pf_domainId), + DESCRIPTION( + "Domain id this configuration applies to, or \"any\" if it applies " + "to all domain ids.
" + )), + END_MARKER +}; + +static struct cfgelem domain_cfgelems[] = { + MOVED("Id", "CycloneDDS/Domain[@Id]"), + GROUP("General", general_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "The General element specifies overall Cyclone DDS service settings.
" + )), +#ifdef DDSI_INCLUDE_SECURITY + GROUP("Security|DDSSecurity", security_omg_config_elements, NULL, INT_MAX, + MEMBER(omg_security_configuration), + FUNCTIONS(if_omg_security, 0, 0, 0), + DESCRIPTION( + "This element is used to configure Cyclone DDS with the DDS Security " + "specification plugins and settings.
" + )), +#endif +#ifdef DDSI_INCLUDE_NETWORK_PARTITIONS + GROUP("Partitioning", partitioning_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "The Partitioning element specifies Cyclone DDS network partitions and " + "how DCPS partition/topic combinations are mapped onto the network " + "partitions.
" + )), +#endif +#ifdef DDSI_INCLUDE_NETWORK_CHANNELS + GROUP("Channels", channels_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "This element is used to group a set of channels. The channels are " + "independent data paths through Cyclone DDS and by using separate threads " + "and setting their priorities appropriately, chanenls can be used to " + "map transport priorities to operating system scheduler priorities, " + "ensuring system-wide end-to-end priority preservation.
" + )), +#endif + GROUP("Threads", threads_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "This element is used to set thread properties.
" + )), + GROUP("Sizing", sizing_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "The Sizing element specifies a variety of configuration settings " + "dealing with expected system sizes, buffer sizes, &c.
" + )), + GROUP("Compatibility", compatibility_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "The Compatibility elements allows specifying various settings " + "related to compatability with standards and with other DDSI " + "implementations.
" + )), + GROUP("Discovery", discovery_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "The Discovery element allows specifying various parameters related " + "to the discovery of peers.
" + )), + GROUP("Tracing", tracing_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "The Tracing element controls the amount and type of information " + "that is written into the tracing log by the DDSI service. This is " + "useful to track the DDSI service during application development.
" + )), + GROUP("Internal|Unsupported", internal_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "The Internal elements deal with a variety of settings that " + "evolving and that are not necessarily fully supported. For the vast " + "majority of the Internal settings, the functionality per-se is " + "supported, but the right to change the way the options control the " + "functionality is reserved. This includes renaming or moving " + "options.
" + )), + GROUP("TCP", tcp_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "The TCP element allows specifying various parameters related to " + "running DDSI over TCP.
" + )), + GROUP("ThreadPool", tp_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "The ThreadPool element allows specifying various parameters " + "related to using a thread pool to send DDSI messages to multiple " + "unicast addresses (TCP or UDP).
" + )), +#ifdef DDSI_INCLUDE_SSL + GROUP("SSL", ssl_cfgelems, NULL, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "The SSL element allows specifying various parameters related to " + "using SSL/TLS for DDSI over TCP.
" + )), +#endif + END_MARKER +}; + +static struct cfgelem root_cfgelems[] = { + GROUP("Domain", domain_cfgelems, domain_cfgattrs, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION( + "The General element specifying Domain related settings.
" + )), + MOVED("General", "CycloneDDS/Domain/General"), +#if DDSI_INCLUDE_NETWORK_PARTITIONS + MOVED("Partitioning", "CycloneDDS/Domain/Partitioning"), +#endif +#if DDSI_INCLUDE_NETWORK_CHANNELS + MOVED("Channels", "CycloneDDS/Domain/Channels"), +#endif + MOVED("Threads", "CycloneDDS/Domain/Threads"), + MOVED("Sizing", "CycloneDDS/Domain/Sizing"), + MOVED("Compatibility", "CycloneDDS/Domain/Compatibility"), + MOVED("Discovery", "CycloneDDS/Domain/Discovery"), + MOVED("Tracing", "CycloneDDS/Domain/Tracing"), + MOVED("Internal|Unsupported", "CycloneDDS/Domain/Internal"), + MOVED("TCP", "CycloneDDS/Domain/TCP"), + MOVED("ThreadPool", "CycloneDDS/Domain/ThreadPool"), +#if DDSI_INCLUDE_SECURITY + MOVED("DDSSecurity", "CycloneDDS/Domain/Security"), +#endif +#if DDSI_INCLUDE_SSL + MOVED("SSL", "CycloneDDS/Domain/SSL"), +#endif + MOVED("DDSI2E|DDSI2", "CycloneDDS/Domain"), + END_MARKER +}; + +static struct cfgelem root_cfgattrs[] = { + NOP("xmlns"), + NOP("xmlns:xsi"), + NOP("xsi:schemaLocation"), + NOP("xsi:noNamespaceSchemaLocation"), + END_MARKER +}; + +static struct cfgelem cyclonedds_root_cfgelems[] = { + GROUP("CycloneDDS", root_cfgelems, root_cfgattrs, 1, + NOMEMBER, + NOFUNCTIONS, + DESCRIPTION("CycloneDDS configuration")), + END_MARKER +}; + +#endif /* DDSI_CFGELEMS_H */ diff --git a/src/core/ddsi/include/dds/ddsi/ddsi_cfgunits.h b/src/core/ddsi/include/dds/ddsi/ddsi_cfgunits.h new file mode 100644 index 0000000..b2cc0e0 --- /dev/null +++ b/src/core/ddsi/include/dds/ddsi/ddsi_cfgunits.h @@ -0,0 +1,48 @@ +/* + * Copyright(c) 2020 ADLINK Technology Limited 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_CFGUNITS_H +#define DDSI_CFGUNITS_H + +static const struct cfgunit cfgunits[] = { + UNIT("bandwidth", + DESCRIPTION( + "The unit must be specified explicitly. Recognised units: " + "Xb/s, Xbps for bits/s or XB/s, XBps for " + "bytes/s; where X is an optional prefix: k for 103, " + "Ki for 210, M for 106, Mi for 220, " + "G for 109, Gi for 230.
"), + PATTERN( + "0|(\\d+(\\.\\d*)?([Ee][\\-+]?\\d+)?|\\.\\d+([Ee][\\-+]?\\d+)?) *([kMG]i?)?[Bb][p/]s")), + UNIT("duration", + DESCRIPTION( + "The unit must be specified explicitly. Recognised units: ns, us, ms, " + "s, min, hr, day.
"), + PATTERN( + "0|(\\d+(\\.\\d*)?([Ee][\\-+]?\\d+)?|\\.\\d+([Ee][\\-+]?\\d+)?) *([num]?s|min|hr|day)")), + UNIT("duration_inf", + DESCRIPTION( + "Valid values are finite durations with an explicit unit or the " + "keyword 'inf' for infinity. Recognised units: ns, us, ms, s, min, hr, " + "day.
"), + PATTERN( + "inf|0|(\\d+(\\.\\d*)?([Ee][\\-+]?\\d+)?|\\.\\d+([Ee][\\-+]?\\d+)?) *([num]?s|min|hr|day)")), + UNIT("memsize", + DESCRIPTION( + "The unit must be specified explicitly. Recognised units: B (bytes), " + "kB & KiB (210 bytes), MB & MiB (220 bytes), GB & " + "GiB (230 bytes).
"), + PATTERN( + "0|(\\d+(\\.\\d*)?([Ee][\\-+]?\\d+)?|\\.\\d+([Ee][\\-+]?\\d+)?) *([kMG]i?)?B")), + END_MARKER +}; + +#endif /* DDSI_CFGUNITS_H */ diff --git a/src/core/ddsi/src/q_config.c b/src/core/ddsi/src/q_config.c index 1f5ffa1..a8e238a 100644 --- a/src/core/ddsi/src/q_config.c +++ b/src/core/ddsi/src/q_config.c @@ -68,7 +68,6 @@ struct cfgelem { update_fun_t update; free_fun_t free; print_fun_t print; - const char *description; }; struct cfgst_nodekey { @@ -212,804 +211,79 @@ DI(if_omg_security); #endif #undef DI -#define CO(name) ((int) offsetof (struct config, name)) -#define ABSOFF(name) 0, CO (name) -#define RELOFF(parent,name) 1, ((int) offsetof (struct parent, name)) -#define NODATA 1, NULL, 0, 0, 0, 0, 0, 0 -#define END_MARKER { NULL, NULL, NULL, NODATA, NULL } -#define WILDCARD { "*", NULL, NULL, NODATA, NULL } -#define LEAF(name) name, NULL, NULL -#define DEPRECATED_LEAF(name) "|" name, NULL, NULL -#define LEAF_W_ATTRS(name, attrs) name, NULL, attrs -#define GROUP(name, children) name, children, NULL, 1, NULL, 0, 0, 0, 0, 0, 0 -#define GROUP_W_ATTRS(name, children, attrs) name, children, attrs, 1, NULL, 0, 0, 0, 0, 0, 0 -#define MGROUP(name, children, attrs) name, children, attrs -#define ATTR(name) name, NULL, NULL -#define DEPRECATED_ATTR(name) "|" name, NULL, NULL +/* drop extra information, i.e. DESCRIPTION, RANGE, UNIT and VALUES */ +#define ELEMENT( \ + name, elems, attrs, multip, dflt, \ + relofst, elemofst, \ + init, update, free, print, ...) \ + { \ + name, elems, attrs, multip, dflt, \ + relofst, elemofst, \ + init, update, free, print \ + } + +#define DEPRECATED(name) "|" name +#define MEMBER(name) 0, ((int) offsetof (struct config, name)) +#define MEMBEROF(parent, name) 1, ((int) offsetof (struct parent, name)) +#define FUNCTIONS(init, update, free, print) init, update, free, print +#define DESCRIPTION(...) /* drop */ +#define RANGE(...) /* drop */ +#define UNIT(...) /* drop */ +#define VALUES(...) /* drop */ + +#define NOMEMBER 0, 0 +#define NOFUNCTIONS 0, 0, 0, 0 +#define NODATA 1, NULL, NOMEMBER, NOFUNCTIONS +#define END_MARKER { NULL, NULL, NULL, NODATA } + /* MOVED: whereto must be a path starting with CycloneDDS, may not be used in/for lists and only for elements, may not be chained */ -#define MOVED(name, whereto) ">" name, NULL, NULL, 0, whereto, 0, 0, 0, 0, 0, 0, NULL -#if 0 -#define BLURB(text) text -#else -#define BLURB(text) NULL -#endif -static const struct cfgelem general_cfgelems[] = { - { LEAF("NetworkInterfaceAddress"), 1, "auto", ABSOFF(networkAddressString), 0, uf_networkAddress, ff_free, pf_networkAddress, - BLURB("This element specifies the preferred network interface for use by DDSI2E. The preferred network interface determines the IP address that DDSI2E 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, DDSI2E will select what it considers the most suitable interface.
") }, - { LEAF("MulticastRecvNetworkInterfaceAddresses"), 1, "preferred", ABSOFF(networkRecvAddressStrings), 0, uf_networkAddresses, ff_networkAddresses, pf_networkAddresses, - BLURB("This element specifies on which network interfaces DDSI2E listens to multicasts. The following options are available:
\n\ -If DDSI2E 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.
") }, - { LEAF("ExternalNetworkAddress"), 1, "auto", ABSOFF(externalAddressString), 0, uf_networkAddress, ff_free, pf_networkAddress, - BLURB("This element allows explicitly overruling the network address DDSI2E advertises in the discovery protocol, which by default is the address of the preferred network interface (General/NetworkInterfaceAddress), to allow DDSI2E to communicate across a Network Address Translation (NAT) device.
") }, - { LEAF("ExternalNetworkMask"), 1, "0.0.0.0", ABSOFF(externalMaskString), 0, uf_string, ff_free, pf_string, - BLURB("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.
") }, - { LEAF("AllowMulticast"), 1, "default", ABSOFF(allowMulticast), 0, uf_allow_multicast, 0, pf_allow_multicast, - BLURB("This element controls whether DDSI2E uses multicasts for data traffic.
\n\ -It is a comma-separated list of some of the following keywords: \"spdp\", \"asm\", \"ssm\", or either of \"false\" or \"true\", or \"default\".
\n\ -When set to \"false\" all multicasting is disabled. The default, \"true\" enables full use of multicasts. Listening for multicasts can be controlled by General/MulticastRecvNetworkInterfaceAddresses.
\n\ -\"default\" maps on spdp if the network is a WiFi network, on true if it is a wired network
") }, - { LEAF("PreferMulticast"), 1, "false", ABSOFF(prefer_multicast), 0, uf_boolean, 0, pf_boolean, - BLURB("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.
") }, - { LEAF("MulticastTimeToLive"), 1, "32", ABSOFF(multicast_ttl), 0, uf_natint_255, 0, pf_int, - BLURB("This element specifies the time-to-live setting for outgoing multicast packets.
") }, - { LEAF("DontRoute"), 1, "false", ABSOFF(dontRoute), 0, uf_boolean, 0, pf_boolean, - BLURB("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.
") }, - { LEAF ("UseIPv6"), 1, "default", ABSOFF (compat_use_ipv6), 0, uf_boolean_default, 0, pf_nop, - BLURB("Deprecated (use Transport instead)
") }, - { LEAF ("Transport"), 1, "default", ABSOFF (transport_selector), 0, uf_transport_selector, 0, pf_transport_selector, - BLURB("This element allows selecting the transport to be used (udp, udp6, tcp, tcp6, raweth)
") }, - { LEAF("EnableMulticastLoopback"), 1, "true", ABSOFF(enableMulticastLoopback), 0, uf_boolean, 0, pf_boolean, - BLURB("This element specifies whether DDSI2E 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, but if a node runs only a single DDSI2E service and does not host any other DDSI-capable programs, it should be set to \"false\" for improved performance.
") }, - { LEAF("MaxMessageSize"), 1, "4096 B", ABSOFF(max_msg_size), 0, uf_memsize, 0, pf_memsize, - BLURB("This element specifies the maximum size of the UDP payload that DDSI2E will generate. DDSI2E 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).
\n\ -On some networks it may be necessary to set this item to keep the packetsize below the MTU to prevent IP fragmentation. In those cases, it is generally advisable to also consider reducing Internal/FragmentSize.
") }, - { LEAF("FragmentSize"), 1, "1280 B", ABSOFF(fragment_size), 0, uf_memsize, 0, pf_memsize, - BLURB("This element specifies the size of DDSI sample fragments generated by DDSI2E. 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 DDSI2E will do whatever size is requested, accepting fragments of which the size is at least the minimum of 1025 and FragmentSize.
") }, - END_MARKER -}; +#define MOVED(name, whereto) \ + { ">" name, NULL, NULL, 0, whereto, NOMEMBER, NOFUNCTIONS } +#define NOP(name) \ + { name, NULL, NULL, 1, NULL, NOMEMBER, 0, uf_nop, 0, pf_nop } +#define WILDCARD { "*", NULL, NULL, NODATA } -#ifdef DDSI_INCLUDE_SECURITY -/** Security Configuration */ -static const struct cfgelem authentication_library_attributes[] = { - { ATTR ("path"), 1, "dds_security_auth", RELOFF (config_omg_security_listelem, cfg.authentication_plugin.library_path), 0, uf_string, ff_free, pf_string, - BLURB("This element points to the path of Authentication plugin library.
\n\ -It can be either absolute path excluding file extension ( /usr/lib/dds_security_auth ) or single file without extension ( dds_security_auth ).
\n\ -If single file is supplied, the library located by way of the current working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for Windows systems.
") }, - { ATTR ("initFunction"), 1, "init_authentication", RELOFF (config_omg_security_listelem, cfg.authentication_plugin.library_init), 0, uf_string, ff_free, pf_string, - BLURB("This element names the initialization function of Authentication plugin. This function is called after loading the plugin library for instantiation purposes. Init function must return an object that implements DDS Security Authentication interface.
") }, - { ATTR ("finalizeFunction"), 1, "finalize_authentication", RELOFF (config_omg_security_listelem, cfg.authentication_plugin.library_finalize), 0, uf_string, ff_free, pf_string, - BLURB("This element names the finalization function of Authentication plugin. This function is called to let the plugin release its resources.
") }, - END_MARKER -}; +/* Visual Studio requires indirect expansion */ +#define EXPAND(macro, args) macro args -static const struct cfgelem access_control_library_attributes[] = { - { ATTR ("path"), 1, "dds_security_ac", RELOFF (config_omg_security_listelem, cfg.access_control_plugin.library_path), 0, uf_string, ff_free, pf_string, - BLURB("This element points to the path of Access Control plugin library.
\n\ -It can be either absolute path excluding file extension ( /usr/lib/dds_security_ac ) or single file without extension ( dds_security_ac ).
\n\ -If single file is supplied, the library located by way of the current working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for Windows systems.
") }, - { ATTR ("initFunction"), 1, "init_access_control", RELOFF (config_omg_security_listelem, cfg.access_control_plugin.library_init), 0, uf_string, ff_free, pf_string, - BLURB("This element names the initialization function of Access Control plugin. This function is called after loading the plugin library for instantiation purposes. Init function must return an object that implements DDS Security Access Control interface.
") }, - { ATTR ("finalizeFunction"), 1, "finalize_access_control", RELOFF (config_omg_security_listelem, cfg.access_control_plugin.library_finalize), 0, uf_string, ff_free, pf_string, - BLURB("This element names the finalization function of Access Control plugin. This function is called to let the plugin release its resources.
") }, - END_MARKER -}; +#define BOOL(name, attrs, multip, dflt, ...) \ + EXPAND(ELEMENT, (name, NULL, attrs, multip, dflt, __VA_ARGS__)) +#define INT(name, attrs, multip, dflt, ...) \ + EXPAND(ELEMENT, (name, NULL, attrs, multip, dflt, __VA_ARGS__)) +#define STRING(name, attrs, multip, dflt, ...) \ + EXPAND(ELEMENT, (name, NULL, attrs, multip, dflt, __VA_ARGS__)) +#define ENUM(name, attrs, multip, dflt, ...) \ + EXPAND(ELEMENT, (name, NULL, attrs, multip, dflt, __VA_ARGS__)) +#define LIST(name, attrs, multip, dflt, ...) \ + EXPAND(ELEMENT, (name, NULL, attrs, multip, dflt, __VA_ARGS__)) +#define GROUP(name, elems, attrs, multip, ...) \ + EXPAND(ELEMENT, (name, elems, attrs, multip, NULL, __VA_ARGS__)) -static const struct cfgelem cryptography_library_attributes[] = { - { ATTR ("path"), 1, "dds_security_crypto", RELOFF (config_omg_security_listelem, cfg.cryptography_plugin.library_path), 0, uf_string, ff_free, pf_string, - BLURB("This element points to the path of Cryptographic plugin library.
\n\ -It can be either absolute path excluding file extension ( /usr/lib/dds_security_crypto ) or single file without extension ( dds_security_crypto ).
\n\ -If single file is supplied, the library located by way of the current working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for Windows systems.
") }, - { ATTR ("initFunction"), 1, "init_crypto", RELOFF (config_omg_security_listelem, cfg.cryptography_plugin.library_init), 0, uf_string, ff_free, pf_string, - BLURB("This element names the initialization function of Cryptographic plugin. This function is called after loading the plugin library for instantiation purposes. Init function must return an object that implements DDS Security Cryptographic interface.
") }, - { ATTR ("finalizeFunction"), 1, "finalize_crypto", RELOFF (config_omg_security_listelem, cfg.cryptography_plugin.library_finalize), 0, uf_string, ff_free, pf_string, - BLURB("This element names the finalization function of Cryptographic plugin. This function is called to let the plugin release its resources.
") }, - END_MARKER -}; - - -static const struct cfgelem authentication_config_elements[] = { - { LEAF_W_ATTRS("Library", authentication_library_attributes), 1, "", RELOFF (config_omg_security_listelem, cfg.authentication_plugin), 0, 0, 0, pf_string, - BLURB("This element specifies the library to be loaded as the DDS Security Access Control plugin.
") }, - { LEAF ("IdentityCertificate"), 1, NULL, RELOFF (config_omg_security_listelem, cfg.authentication_properties.identity_certificate), 0, uf_string, ff_free, pf_string, - BLURB("Identity certificate that will be used for identifying all participants in the OSPL instance.
The content is URI to a X509 certificate signed by the IdentityCA in PEM format containing the signed public key.
Supported URI schemes: file, data
\n\ -Examples:
\n\ -
\n\
-MIIDjjCCAnYCCQDCEu9...6rmT87dhTo=
\n\
------END CERTIFICATE-----
URI to the X509 certificate [39] of the Identity CA that is the signer of Identity Certificate.
\n\ -Supported URI schemes: file, data
\n\ -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.
\n\ -Examples:
\n\ -
\n\
-MIIC3DCCAcQCCQCWE5x+Z...PhovK0mp2ohhRLYI0ZiyYQ==
\n\
------END CERTIFICATE-----
URI to access the private Private Key for all of the participants in the OSPL federation.
\n\ -Supported URI schemes: file, data
\n\ -Examples:
\n\ -
\n\
-MIIEpAIBAAKCAQEA3HIh...AOBaaqSV37XBUJg==
\n\
------END RSA PRIVATE KEY-----
A password used to decrypt the private_key.
\n\ -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.\n\ -If the password property is not present, then the value supplied in the private_key property must contain the unencrypted private key. ") }, - { LEAF ("TrustedCADirectory"), 1, "", RELOFF (config_omg_security_listelem, cfg.authentication_properties.trusted_ca_dir), 0, uf_string, ff_free, pf_string, - BLURB("Trusted CA Directory which contains trusted CA certificates as separated files.
") }, - { LEAF ("IncludeOptionalFields"), 1, "false", RELOFF (config_omg_security_listelem, cfg.authentication_properties.include_optional_fields), 0, uf_boolean, 0, pf_boolean, - BLURB("The authentication handshake tokens may contain optional fields to be included for finding interoperability problems.\n\ -If this parameter is set to true the optional fields are included in the handshake token exchange.
") }, - END_MARKER -}; - -static const struct cfgelem access_control_config_elements[] = { - { LEAF_W_ATTRS("Library", access_control_library_attributes), 1, "", RELOFF (config_omg_security_listelem, cfg.access_control_plugin), 0, 0, 0, pf_string, - BLURB("This element specifies the library to be loaded as the DDS Security Access Control plugin.
") }, - { LEAF ("PermissionsCA"), 1, "", RELOFF (config_omg_security_listelem, cfg.access_control_properties.permissions_ca), 0, uf_string, ff_free, pf_string, - BLURB("URI to a X509 certificate for the PermissionsCA in PEM format.
\n\ -Supported URI schemes: file, data
\n\ -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.
Examples:
MIIC3DCCAcQCCQCWE5x+Z ... PhovK0mp2ohhRLYI0ZiyYQ==
\n\ ------END CERTIFICATE-----
") }, - { LEAF ("Governance"), 1, "", RELOFF (config_omg_security_listelem, cfg.access_control_properties.governance), 0, uf_string, ff_free, pf_string, - BLURB("URI to the shared Governance Document signed by the Permissions CA in S/MIME format
\n\ -URI schemes: file, data
Examples file URIs:
\n\ -Content-Type: multipart/signed; protocol=\"application/x-pkcs7-signature\"; micalg=\"sha-256\"; boundary=\"----F9A8A198D6F08E1285A292ADF14DD04F\" This is an S/MIME signed message ------F9A8A198D6F08E1285A292ADF14DD04F xsi:noNamespaceSchemaLocation=\"omg_shared_ca_governance.xsd\"> . . . ... ------F9A8A198D6F08E1285A292ADF14DD04F Content-Type: application/x-pkcs7-signature; name=\"smime.p7s\" Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename=\"smime.p7s\" MIIDuAYJKoZIhv ...al5s= ------F9A8A198D6F08E1285A292ADF14DD04F-]]
URI to the DomainParticipant permissions document signed by the Permissions CA in S/MIME format
\n\ -The permissions document specifies the permissions to be applied to a domain.
Example file URIs:
\n\ -Example data URI:
\n\ -This element specifies the library to be loaded as the DDS Security Cryptographic plugin.
") }, - END_MARKER -}; - -static const struct cfgelem security_omg_config_elements[] = { - { GROUP ("Authentication", authentication_config_elements), - BLURB("This element configures the Authentication plugin of the DDS Security specification.
") }, - { GROUP ("AccessControl", access_control_config_elements), - BLURB("This element configures the Access Control plugin of the DDS Security specification.
") }, - { GROUP ("Cryptographic", cryptography_config_elements), - BLURB("This element configures the Cryptographic plugin of the DDS Security specification.
") }, - END_MARKER -}; -#endif /* DDSI_INCLUDE_SECURITY */ - - -#ifdef DDSI_INCLUDE_NETWORK_PARTITIONS -static const struct cfgelem networkpartition_cfgattrs[] = { - { ATTR("Name"), 1, NULL, RELOFF(config_networkpartition_listelem, name), 0, uf_string, ff_free, pf_string, - BLURB("This attribute specifies the name of this DDSI2E network partition. Two network partitions cannot have the same name.
") }, - { ATTR("Address"), 1, NULL, RELOFF(config_networkpartition_listelem, address_string), 0, uf_string, ff_free, pf_string, - BLURB("This attribute specifies the multicast addresses associated with the network partition as a comma-separated list. Readers matching this network partition (cf. Partitioning/PartitionMappings) will listen for multicasts on all of these addresses and advertise them in the discovery protocol. The writers will select the most suitable address from the addresses advertised by the readers.
") }, - { ATTR("Connected"), 1, "true", RELOFF(config_networkpartition_listelem, connected), 0, uf_boolean, 0, pf_boolean, - BLURB("This attribute is a placeholder.
") }, - END_MARKER -}; - -static const struct cfgelem networkpartitions_cfgelems[] = { - { LEAF_W_ATTRS("NetworkPartition", networkpartition_cfgattrs), INT_MAX, 0, ABSOFF(networkPartitions), if_network_partition, 0, 0, 0, - BLURB("This element defines a DDSI2E network partition.
") }, - END_MARKER -}; - -static const struct cfgelem ignoredpartitions_cfgattrs[] = { - { ATTR("DCPSPartitionTopic"), 1, NULL, RELOFF(config_ignoredpartition_listelem, DCPSPartitionTopic), 0, uf_string, ff_free, pf_string, - BLURB("This attribute specifies a partition and a topic expression, separated by a single '.', that are used to determine if a given partition and topic will be ignored or not. The expressions may use the usual wildcards '*' and '?'. DDSI2E will consider an wildcard DCPS partition to match an expression iff there exists a string that satisfies both expressions.
") }, - END_MARKER -}; - -static const struct cfgelem ignoredpartitions_cfgelems[] = { - { LEAF_W_ATTRS("IgnoredPartition", ignoredpartitions_cfgattrs), INT_MAX, 0, ABSOFF(ignoredPartitions), if_ignored_partition, 0, 0, 0, - BLURB("This element can be used to prevent certain combinations of DCPS partition and topic from being transmitted over the network. DDSI2E will complete 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.
") }, - END_MARKER -}; - -static const struct cfgelem partitionmappings_cfgattrs[] = { - { ATTR("NetworkPartition"), 1, NULL, RELOFF(config_partitionmapping_listelem, networkPartition), 0, uf_string, ff_free, pf_string, - BLURB("This attribute specifies which DDSI2E network partition is to be used for DCPS partition/topic combinations matching the DCPSPartitionTopic attribute within this PartitionMapping element.
") }, - { ATTR("DCPSPartitionTopic"), 1, NULL, RELOFF(config_partitionmapping_listelem, DCPSPartitionTopic), 0, uf_string, ff_free, pf_string, - BLURB("This attribute specifies a partition and a topic expression, separated by a single '.', that are used to determine if a given partition and topic maps to the DDSI2E network partition named by the NetworkPartition attribute in this PartitionMapping element. The expressions may use the usual wildcards '*' and '?'. DDSI2E will consider a wildcard DCPS partition to match an expression if there exists a string that satisfies both expressions.
") }, - END_MARKER -}; - -static const struct cfgelem partitionmappings_cfgelems[] = { - { LEAF_W_ATTRS("PartitionMapping", partitionmappings_cfgattrs), INT_MAX, 0, ABSOFF(partitionMappings), if_partition_mapping, 0, 0, 0, - BLURB("This element defines a mapping from a DCPS partition/topic combination to a DDSI2E network partition. This allows partitioning data flows by using special multicast addresses for part of the data and possibly also encrypting the data flow.
") }, - END_MARKER -}; - -static const struct cfgelem partitioning_cfgelems[] = { - { GROUP("NetworkPartitions", networkpartitions_cfgelems), - BLURB("The NetworkPartitions element specifies the DDSI2E network partitions.
") }, - { GROUP("IgnoredPartitions", ignoredpartitions_cfgelems), - BLURB("The IgnoredPartitions element specifies DCPS partition/topic combinations that are not distributed over the network.
") }, - { GROUP("PartitionMappings", partitionmappings_cfgelems), - BLURB("The PartitionMappings element specifies the mapping from DCPS partition/topic combinations to DDSI2E network partitions.
") }, - END_MARKER -}; -#endif /* DDSI_INCLUDE_NETWORK_PARTITIONS */ - -#ifdef DDSI_INCLUDE_NETWORK_CHANNELS -static const struct cfgelem channel_cfgelems[] = { -#ifdef DDSI_INCLUDE_BANDWIDTH_LIMITING - { LEAF("DataBandwidthLimit"), 1, "inf", RELOFF(config_channel_listelem, data_bandwidth_limit), 0, uf_bandwidth, 0, pf_bandwidth, - BLURB("This element specifies the maximum transmit rate of new samples and directly related data, for this channel. Bandwidth limiting uses a leaky bucket scheme. The default value \"inf\" means DDSI2E imposes no limitation, the underlying operating system and hardware will likely limit the maimum transmit rate.
") }, - { LEAF("AuxiliaryBandwidthLimit"), 1, "inf", RELOFF(config_channel_listelem, auxiliary_bandwidth_limit), 0, uf_bandwidth, 0, pf_bandwidth, - BLURB("This element specifies the maximum transmit rate of auxiliary traffic on this channel (e.g. retransmits, heartbeats, etc). Bandwidth limiting uses a leaky bucket scheme. The default value \"inf\" means DDSI2E imposes no limitation, the underlying operating system and hardware will likely limit the maimum transmit rate.
") }, -#endif - { LEAF("DiffServField"), 1, "0", RELOFF(config_channel_listelem, diffserv_field), 0, uf_natint, 0, pf_int, - BLURB("This element describes the DiffServ setting the channel will apply to the networking messages. This parameter determines the value of the diffserv field of the IP version 4 packets sent on this channel which allows QoS setting to be applied to the network traffic send on this channel.
\n\
-Windows platform support for setting the diffserv field is dependent on the OS version.
\n\
-For Windows versions XP SP2 and 2003 to use the diffserv field the following parameter should be added to the register:
\n\
-HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\TcpIp\\Parameters\\DisableUserTOSSetting
\n\
-The type of this parameter is a DWORD and its value should be set to 0 to allow setting of the diffserv field.
\n\
-For Windows version 7 or higher a new API (qWAVE) has been introduced. For these platforms the specified diffserv value is mapped to one of the support traffic types.\n\
-The mapping is as follows: 1-8 background traffic; 9-40 excellent traffic; 41-55 audio/video traffic; 56 voice traffic; 57-63 control traffic.\n\
-When an application is run without Administrative priveleges then only the diffserv value of 0, 8, 40 or 56 is allowed.
This attribute specifies name of this channel. The name should uniquely identify the channel.
") }, - { ATTR("TransportPriority"), 1, "0", RELOFF(config_channel_listelem, priority), 0, uf_natint, 0, pf_int, - BLURB("This attribute sets the transport priority threshold for the channel. Each DCPS data writer has a \"transport_priority\" QoS and this QoS is used to select a channel for use by this writer. The selected channel is the one with the largest threshold not greater than the writer's transport priority, and if no such channel exists, the channel with the lowest threshold.
") }, - END_MARKER -}; - -static const struct cfgelem channels_cfgelems[] = { - { MGROUP("Channel", channel_cfgelems, channel_cfgattrs), INT_MAX, 0, ABSOFF(channels), if_channel, 0, 0, 0, - BLURB("This element defines a channel.
") }, - END_MARKER -}; -#endif /* DDSI_INCLUDE_NETWORK_CHANNELS */ - -static const struct cfgelem thread_properties_sched_cfgelems[] = { - { LEAF("Class"), 1, "default", RELOFF(config_thread_properties_listelem, sched_class), 0, uf_sched_class, 0, pf_sched_class, - BLURB("This element specifies the thread scheduling class (realtime, timeshare or default). The user may need special privileges from the underlying operating system to be able to assign some of the privileged scheduling classes.
") }, - { LEAF("Priority"), 1, "default", RELOFF(config_thread_properties_listelem, sched_priority), 0, uf_maybe_int32, 0, pf_maybe_int32, - BLURB("This element specifies the thread priority (decimal integer or default). Only priorities that are 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.
") }, - END_MARKER -}; - -static const struct cfgelem thread_properties_cfgattrs[] = { - { ATTR("Name"), 1, NULL, RELOFF(config_thread_properties_listelem, name), 0, uf_string, ff_free, pf_string, - BLURB("The Name of the thread for which properties are being set. The following threads exist:
\n\ -This element configures the scheduling properties of the thread.
") }, - { LEAF("StackSize"), 1, "default", RELOFF(config_thread_properties_listelem, stack_size), 0, uf_maybe_memsize, 0, pf_maybe_memsize, - BLURB("This element configures the stack size for this thread. The default value default leaves the stack size at the operating system default.
") }, - END_MARKER -}; - -static const struct cfgelem threads_cfgelems[] = { - { MGROUP("Thread", thread_properties_cfgelems, thread_properties_cfgattrs), INT_MAX, 0, ABSOFF(thread_properties), if_thread_properties, 0, 0, 0, - BLURB("This element is used to set thread properties.
") }, - END_MARKER -}; - -static const struct cfgelem compatibility_cfgelems[] = { - { LEAF("StandardsConformance"), 1, "lax", ABSOFF(standards_conformance), 0, uf_standards_conformance, 0, pf_standards_conformance, - BLURB("This element sets the level of standards conformance of this instance of the DDSI2E Service. Stricter conformance typically means less interoperability with other implementations. Currently three modes are defined:
\n\ -The default setting is \"lax\".
") }, - { LEAF("ExplicitlyPublishQosSetToDefault"), 1, "false", ABSOFF(explicitly_publish_qos_set_to_default), 0, uf_boolean, 0, pf_boolean, - BLURB("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.
\n\ -When interoperability is required with an implementation that does not follow the specifications in this regard, setting this option to true will help.
") }, - { LEAF ("ManySocketsMode"), 1, "single", ABSOFF (many_sockets_mode), 0, uf_many_sockets_mode, 0, pf_many_sockets_mode, - BLURB("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.
\n\ -Disabling it slightly improves performance and reduces network traffic somewhat. It also causes the set of port numbers needed by DDSI2E to become predictable, which may be useful for firewall and NAT configuration.
") }, - { LEAF("AssumeRtiHasPmdEndpoints"), 1, "false", ABSOFF(assume_rti_has_pmd_endpoints), 0, uf_boolean, 0, pf_boolean, - BLURB("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.
") }, - END_MARKER -}; - -static const struct cfgelem internal_test_cfgelems[] = { - { LEAF("XmitLossiness"), 1, "0", ABSOFF(xmit_lossiness), 0, uf_int, 0, pf_int, - BLURB("This element controls the fraction of outgoing packets to drop, specified as samples per thousand.
") }, - END_MARKER -}; - -static const struct cfgelem internal_watermarks_cfgelems[] = { - { LEAF("WhcLow"), 1, "1 kB", ABSOFF(whc_lowwater_mark), 0, uf_memsize, 0, pf_memsize, - BLURB("This element sets the low-water mark for the DDSI2E WHCs, expressed in bytes. A suspended writer resumes transmitting when its DDSI2E WHC shrinks to this size.
") }, - { LEAF("WhcHigh"), 1, "100 kB", ABSOFF(whc_highwater_mark), 0, uf_memsize, 0, pf_memsize, - BLURB("This element sets the maximum allowed high-water mark for the DDSI2E WHCs, expressed in bytes. A writer is suspended when the WHC reaches this size.
") }, - { LEAF("WhcHighInit"), 1, "30 kB", ABSOFF(whc_init_highwater_mark), 0, uf_maybe_memsize, 0, pf_maybe_memsize, - BLURB("This element sets the initial level of the high-water mark for the DDSI2E WHCs, expressed in bytes.
") }, - { LEAF("WhcAdaptive|WhcAdaptative"), 1, "true", ABSOFF(whc_adaptive), 0, uf_boolean, 0, pf_boolean, - BLURB("This element controls whether DDSI2E will adapt the high-water mark to current traffic conditions, based on retransmit requests and transmit pressure.
") }, - END_MARKER -}; - -static const struct cfgelem control_topic_cfgattrs[] = { - { DEPRECATED_ATTR("Enable"), 1, "false", ABSOFF(enable_control_topic), 0, uf_boolean, 0, pf_boolean, - BLURB("This element controls whether DDSI2E should create a topic to control DDSI2E's behaviour dynamically.
") }, - { DEPRECATED_ATTR("InitialReset"), 1, "inf", ABSOFF(initial_deaf_mute_reset), 0, uf_duration_inf, 0, pf_duration, - BLURB("
This element controls after how much time an initial deaf/mute state will automatically reset.
") }, - END_MARKER -}; - -static const struct cfgelem control_topic_cfgelems[] = { - { DEPRECATED_LEAF ("Deaf"), 1, "false", ABSOFF (initial_deaf), 0, uf_deaf_mute, 0, pf_boolean, - BLURB("
This element controls whether DDSI2E defaults to deaf mode or to normal mode. This controls both the initial behaviour and what behaviour it auto-reverts to.
") }, - { DEPRECATED_LEAF ("Mute"), 1, "false", ABSOFF (initial_mute), 0, uf_deaf_mute, 0, pf_boolean, - BLURB("This element controls whether DDSI2E defaults to mute mode or to normal mode. This controls both the initial behaviour and what behaviour it auto-reverts to.
") }, - END_MARKER -}; - -static const struct cfgelem rediscovery_blacklist_duration_attrs[] = { - { ATTR("enforce"), 1, "false", ABSOFF(prune_deleted_ppant.enforce_delay), 0, uf_boolean, 0, pf_boolean, - BLURB("This attribute controls whether the configured time during which recently deleted participants will not be rediscovered (i.e., \"black listed\") is enforced and following complete removal of the participant in DDSI2E, or whether it can be rediscovered earlier provided all traces of that participant have been removed already.
") }, - END_MARKER -}; - -static const struct cfgelem heartbeat_interval_attrs[] = { - { ATTR ("min"), 1, "5 ms", ABSOFF (const_hb_intv_min), 0, uf_duration_inf, 0, pf_duration, - BLURB("This attribute sets the minimum interval that must have passed since the most recent heartbeat from a writer, before another asynchronous (not directly related to writing) will be sent.
") }, - { ATTR ("minsched"), 1, "20 ms", ABSOFF (const_hb_intv_sched_min), 0, uf_duration_inf, 0, pf_duration, - BLURB("This attribute sets the minimum interval for periodic heartbeats. Other events may still cause heartbeats to go out.
") }, - { ATTR ("max"), 1, "8 s", ABSOFF (const_hb_intv_sched_max), 0, uf_duration_inf, 0, pf_duration, - BLURB("This attribute sets the maximum interval for periodic heartbeats.
") }, - END_MARKER -}; - -static const struct cfgelem liveliness_monitoring_attrs[] = { - { ATTR("StackTraces"), 1, "true", ABSOFF(noprogress_log_stacktraces), 0, uf_boolean, 0, pf_boolean, - BLURB("This element controls whether or not to write stack traces to the DDSI2 trace when a thread fails to make progress (on select platforms only).
") }, - { ATTR("Interval"), 1, "1s", ABSOFF(liveliness_monitoring_interval), 0, uf_duration_100ms_1hr, 0, pf_duration, - BLURB("This element controls the interval at which to check whether threads have been making progress.
") }, - END_MARKER -}; - -static const struct cfgelem multiple_recv_threads_attrs[] = { - { ATTR("maxretries"), 1, "4294967295", ABSOFF(recv_thread_stop_maxretries), 0, uf_uint, 0, pf_uint, - BLURB("Receive threads dedicated to a single socket can only be triggered for termination by sending a packet. Reception of any packet will do, so termination failure due to packet loss is exceedingly unlikely, but to eliminate all risks, it will retry as many times as specified by this attribute before aborting.
") }, - END_MARKER -}; - -static const struct cfgelem internal_cfgelems[] = { - { MOVED("MaxMessageSize", "CycloneDDS/General/MaxMessageSize") }, - { MOVED("FragmentSize", "CycloneDDS/General/FragmentSize") }, - { LEAF("DeliveryQueueMaxSamples"), 1, "256", ABSOFF(delivery_queue_maxsamples), 0, uf_uint, 0, pf_uint, - BLURB("This element controls the Maximum size of a delivery queue, expressed in samples. Once a delivery queue is full, incoming samples destined for that queue are dropped until space becomes available again.
") }, - { LEAF("PrimaryReorderMaxSamples"), 1, "128", ABSOFF(primary_reorder_maxsamples), 0, uf_uint, 0, pf_uint, - BLURB("This element sets the maximum size in samples of a primary re-order administration. Each proxy writer has one primary re-order administration to buffer the packet flow in case some packets arrive out of order. Old samples are forwarded to secondary re-order administrations associated with readers in need of historical data.
") }, - { LEAF("SecondaryReorderMaxSamples"), 1, "128", ABSOFF(secondary_reorder_maxsamples), 0, uf_uint, 0, pf_uint, - BLURB("This element sets the maximum size in samples of a secondary re-order administration. The secondary re-order administration is per reader in need of historical data.
") }, - { LEAF("DefragUnreliableMaxSamples"), 1, "4", ABSOFF(defrag_unreliable_maxsamples), 0, uf_uint, 0, pf_uint, - BLURB("This element sets the maximum number of samples that can be defragmented simultaneously for a best-effort writers.
") }, - { LEAF("DefragReliableMaxSamples"), 1, "16", ABSOFF(defrag_reliable_maxsamples), 0, uf_uint, 0, pf_uint, - BLURB("This element sets the maximum number of samples that can be defragmented simultaneously for a reliable writer. This has to be large enough to handle retransmissions of historical data in addition to new samples.
") }, - { LEAF("BuiltinEndpointSet"), 1, "writers", ABSOFF(besmode), 0, uf_besmode, 0, pf_besmode, - BLURB("This element controls which participants will have which built-in endpoints for the discovery and liveliness protocols. Valid values are:
\n\ -The default is writers, as this is thought to be compliant and reasonably efficient. Minimal may or may not be compliant but is most efficient, and full is inefficient but certain to be compliant. See also Internal/ConservativeBuiltinReaderStartup.
") }, - { LEAF("MeasureHbToAckLatency"), 1, "false", ABSOFF(meas_hb_to_ack_latency), 0, uf_boolean, 0, pf_boolean, - BLURB("This element enables heartbeat-to-ack latency among DDSI2E services by prepending timestamps to Heartbeat and AckNack messages and calculating round trip times. This is non-standard behaviour. The measured latencies are quite noisy and are currently not used anywhere.
") }, - { LEAF("UnicastResponseToSPDPMessages"), 1, "true", ABSOFF(unicast_response_to_spdp_messages), 0, uf_boolean, 0, pf_boolean, - BLURB("This element controls whether the response to a newly discovered participant is sent as a unicasted SPDP packet, instead of rescheduling the periodic multicasted one. There is no known benefit to setting this to false.
") }, - { LEAF("SynchronousDeliveryPriorityThreshold"), 1, "0", ABSOFF(synchronous_delivery_priority_threshold), 0, uf_int, 0, pf_int, - BLURB("This element controls whether samples sent by a writer with QoS settings latency_budget <= SynchronousDeliveryLatencyBound and transport_priority greater than or equal to this element's value will be delivered synchronously from the \"recv\" thread, all others will be delivered asynchronously through delivery queues. This reduces latency at the expense of aggregate bandwidth.
") }, - { LEAF("SynchronousDeliveryLatencyBound"), 1, "inf", ABSOFF(synchronous_delivery_latency_bound), 0, uf_duration_inf, 0, pf_duration, - BLURB("This element controls whether samples sent by a writer with QoS settings transport_priority >= SynchronousDeliveryPriorityThreshold and a latency_budget at most this element's value will be delivered synchronously from the \"recv\" thread, all others will be delivered asynchronously through delivery queues. This reduces latency at the expense of aggregate bandwidth.
") }, - { LEAF("MaxParticipants"), 1, "0", ABSOFF(max_participants), 0, uf_natint, 0, pf_int, - BLURB("This elements configures the maximum number of DCPS domain participants this DDSI2E instance is willing to service. 0 is unlimited.
") }, - { LEAF("AccelerateRexmitBlockSize"), 1, "0", ABSOFF(accelerate_rexmit_block_size), 0, uf_uint, 0, pf_uint, - BLURB("Proxy readers that are assumed to sill be retrieving historical data get this many samples retransmitted when they NACK something, even if some of these samples have sequence numbers outside the set covered by the NACK.
") }, - { LEAF("RetransmitMerging"), 1, "never", ABSOFF(retransmit_merging), 0, uf_retransmit_merging, 0, pf_retransmit_merging, - BLURB("This elements controls the addressing and timing of retransmits. Possible values are:
\n\ -The default is never. See also Internal/RetransmitMergingPeriod.
") }, - { LEAF("RetransmitMergingPeriod"), 1, "5 ms", ABSOFF(retransmit_merging_period), 0, uf_duration_us_1s, 0, pf_duration, - BLURB("This setting determines the size of the time window in which a NACK of some sample is ignored because a retransmit of that sample has been multicasted too recently. This setting has no effect on unicasted retransmits.
\n\ -See also Internal/RetransmitMerging.
") }, - { LEAF_W_ATTRS("HeartbeatInterval", heartbeat_interval_attrs), 1, "100 ms", ABSOFF(const_hb_intv_sched), 0, uf_duration_inf, 0, pf_duration, - BLURB("This element allows configuring the base interval for sending writer heartbeats and the bounds within which it can vary.
") }, - { LEAF("MaxQueuedRexmitBytes"), 1, "50 kB", ABSOFF(max_queued_rexmit_bytes), 0, uf_memsize, 0, pf_memsize, - BLURB("This setting limits the maximum number of bytes queued for retransmission. The default value of 0 is unlimited unless an AuxiliaryBandwidthLimit has been set, in which case it becomes NackDelay * AuxiliaryBandwidthLimit. It must be large enough to contain the largest sample that may need to be retransmitted.
") }, - { LEAF("MaxQueuedRexmitMessages"), 1, "200", ABSOFF(max_queued_rexmit_msgs), 0, uf_uint, 0, pf_uint, - BLURB("This settings limits the maximum number of samples queued for retransmission.
") }, - { LEAF("LeaseDuration"), 1, "10 s", ABSOFF(lease_duration), 0, uf_duration_ms_1hr, 0, pf_duration, - BLURB("This setting controls the default participant lease duration.
") }, - { LEAF("WriterLingerDuration"), 1, "1 s", ABSOFF(writer_linger_duration), 0, uf_duration_ms_1hr, 0, pf_duration, - BLURB("
This setting controls the maximum duration for which actual deletion of a reliable writer with unacknowledged data in its history will be postponed to provide proper reliable transmission.
") }, - { LEAF("MinimumSocketReceiveBufferSize"), 1, "default", ABSOFF(socket_min_rcvbuf_size), 0, uf_maybe_memsize, 0, pf_maybe_memsize, - BLURB("
This setting controls the minimum size of socket receive buffers. The operating system provides some size receive buffer upon creation of the socket, this option can be used to increase the size of the buffer beyond that initially provided by the operating system. If the buffer size cannot be increased to the specified size, an error is reported.
\n\ -The default setting is the word \"default\", which means DDSI2E will attempt to increase the buffer size to 1MB, but will silently accept a smaller buffer should that attempt fail.
") }, - { LEAF("MinimumSocketSendBufferSize"), 1, "64 KiB", ABSOFF(socket_min_sndbuf_size), 0, uf_memsize, 0, pf_memsize, - BLURB("This setting controls the minimum size of socket send buffers. This setting can only increase the size of the send buffer, if the operating system by default creates a larger buffer, it is left unchanged.
") }, - { LEAF("NackDelay"), 1, "10 ms", ABSOFF(nack_delay), 0, uf_duration_ms_1hr, 0, pf_duration, - BLURB("This setting controls the delay between receipt of a HEARTBEAT indicating missing samples and a NACK (ignored when the HEARTBEAT requires an answer). However, no NACK is sent if a NACK had been scheduled already for a response earlier than the delay requests: then that NACK will incorporate the latest information.
") }, - { LEAF("AutoReschedNackDelay"), 1, "1 s", ABSOFF(auto_resched_nack_delay), 0, uf_duration_inf, 0, pf_duration, - BLURB("This setting controls the interval with which a reader will continue NACK'ing missing samples in the absence of a response from the writer, as a protection mechanism against writers incorrectly stopping the sending of HEARTBEAT messages.
") }, - { LEAF("PreEmptiveAckDelay"), 1, "10 ms", ABSOFF(preemptive_ack_delay), 0, uf_duration_ms_1hr, 0, pf_duration, - BLURB("This setting controls the delay between the discovering a remote writer and sending a pre-emptive AckNack to discover the range of data available.
") }, - { LEAF("ScheduleTimeRounding"), 1, "0 ms", ABSOFF(schedule_time_rounding), 0, uf_duration_ms_1hr, 0, pf_duration, - BLURB("This setting allows the timing of scheduled events to be rounded up so that more events can be handled in a single cycle of the event queue. The default is 0 and causes no rounding at all, i.e. are scheduled exactly, whereas a value of 10ms would mean that events are rounded up to the nearest 10 milliseconds.
") }, -#ifdef DDSI_INCLUDE_BANDWIDTH_LIMITING - { LEAF("AuxiliaryBandwidthLimit"), 1, "inf", ABSOFF(auxiliary_bandwidth_limit), 0, uf_bandwidth, 0, pf_bandwidth, - BLURB("This element specifies the maximum transmit rate of auxiliary traffic not bound to a specific channel, such as discovery traffic, as well as auxiliary traffic related to a certain channel if that channel has elected to share this global AuxiliaryBandwidthLimit. Bandwidth limiting uses a leaky bucket scheme. The default value \"inf\" means DDSI2E imposes no limitation, the underlying operating system and hardware will likely limit the maimum transmit rate.
") }, -#endif - { LEAF("DDSI2DirectMaxThreads"), 1, "1", ABSOFF(ddsi2direct_max_threads), 0, uf_uint, 0, pf_uint, - BLURB("This element sets the maximum number of extra threads for an experimental, undocumented and unsupported direct mode.
") }, - { LEAF("SquashParticipants"), 1, "false", ABSOFF(squash_participants), 0, uf_boolean, 0, pf_boolean, - BLURB("This element controls whether DDSI2E advertises all the domain participants it serves in DDSI (when set to false), or rather only one domain participant (the one corresponding to the DDSI2E process; when set to true). In the latter case DDSI2E becomes the virtual owner of all readers and writers of all domain participants, dramatically reducing discovery traffic (a similar effect can be obtained by setting Internal/BuiltinEndpointSet to \"minimal\" but with less loss of information).
") }, - { LEAF("SPDPResponseMaxDelay"), 1, "0 ms", ABSOFF(spdp_response_delay_max), 0, uf_duration_ms_1s, 0, pf_duration, - BLURB("Maximum pseudo-random delay in milliseconds between discovering a remote participant and responding to it.
") }, - { LEAF("LateAckMode"), 1, "false", ABSOFF(late_ack_mode), 0, uf_boolean, 0, pf_boolean, - BLURB("Ack a sample only when it has been delivered, instead of when committed to delivering it.
") }, - { LEAF("RetryOnRejectBestEffort"), 1, "false", ABSOFF(retry_on_reject_besteffort), 0, uf_boolean, 0, pf_boolean, - BLURB("Whether or not to locally retry pushing a received best-effort sample into the reader caches when resource limits are reached.
") }, - { LEAF("GenerateKeyhash"), 1, "false", ABSOFF(generate_keyhash), 0, uf_boolean, 0, pf_boolean, - BLURB("When true, include keyhashes in outgoing data for topics with keys.
") }, - { LEAF("MaxSampleSize"), 1, "2147483647 B", ABSOFF(max_sample_size), 0, uf_memsize, 0, pf_memsize, - BLURB("This setting controls the maximum (CDR) serialised size of samples that DDSI2E will forward in either direction. Samples larger than this are discarded with a warning.
") }, - { LEAF("WriteBatch"), 1, "false", ABSOFF(whc_batch), 0, uf_boolean, 0, pf_boolean, - BLURB("This element enables the batching of write operations. By default each write operation writes through the write cache and out onto the transport. Enabling write batching causes multiple small write operations to be aggregated within the write cache into a single larger write. This gives greater throughput at the expense of latency. Currently there is no mechanism for the write cache to automatically flush itself, so that if write batching is enabled, the application may have to use the dds_write_flush function to ensure that all samples are written.
") }, - { LEAF_W_ATTRS("LivelinessMonitoring", liveliness_monitoring_attrs), 1, "false", ABSOFF(liveliness_monitoring), 0, uf_boolean, 0, pf_boolean, - BLURB("This element controls whether or not implementation should internally monitor its own liveliness. If liveliness monitoring is enabled, stack traces can be dumped automatically when some thread appears to have stopped making progress.
") }, - { LEAF("MonitorPort"), 1, "-1", ABSOFF(monitor_port), 0, uf_int, 0, pf_int, - BLURB("This element allows configuring a service that dumps a text description of part the internal state to TCP clients. By default (-1), this is disabled; specifying 0 means a kernel-allocated port is used; a positive number is used as the TCP port number.
") }, - { LEAF("AssumeMulticastCapable"), 1, "", ABSOFF(assumeMulticastCapable), 0, uf_string, ff_free, pf_string, - BLURB("This element controls which network interfaces are assumed to be capable of multicasting even when the interface flags returned by the operating system state it is not (this provides a workaround for some platforms). It is a comma-separated lists of patterns (with ? and * wildcards) against which the interface names are matched.
") }, - { LEAF("PrioritizeRetransmit"), 1, "true", ABSOFF(prioritize_retransmit), 0, uf_boolean, 0, pf_boolean, - BLURB("This element controls whether retransmits are prioritized over new data, speeding up recovery.
") }, - { LEAF("UseMulticastIfMreqn"), 1, "0", ABSOFF(use_multicast_if_mreqn), 0, uf_int, 0, pf_int, - BLURB("Do not use.
") }, - { LEAF("SendAsync"), 1, "false", ABSOFF(xpack_send_async), 0, uf_boolean, 0, pf_boolean, - BLURB("This element controls whether the actual sending of packets occurs on the same thread that prepares them, or is done asynchronously by another thread.
") }, - { LEAF_W_ATTRS("RediscoveryBlacklistDuration", rediscovery_blacklist_duration_attrs), 1, "0s", ABSOFF(prune_deleted_ppant.delay), 0, uf_duration_inf, 0, pf_duration, - BLURB("This element controls for how long a remote participant that was previously deleted will remain on a blacklist to prevent rediscovery, giving the software on a node time to perform any cleanup actions it needs to do. To some extent this delay is required internally by DDSI2E, but in the default configuration with the 'enforce' attribute set to false, DDSI2E will reallow rediscovery as soon as it has cleared its internal administration. Setting it to too small a value may result in the entry being pruned from the blacklist before DDSI2E is ready, it is therefore recommended to set it to at least several seconds.
") }, - { LEAF_W_ATTRS("MultipleReceiveThreads", multiple_recv_threads_attrs), 1, "default", ABSOFF(multiple_recv_threads), 0, uf_boolean_default, 0, pf_boolean_default, - BLURB("This element controls whether all traffic is handled by a single receive thread (false) or whether multiple receive threads may be used to improve latency (true). By default it is disabled on Windows because it appears that one cannot count on being able to send packets to oneself, which is necessary to stop the thread during shutdown. Currently multiple receive threads are only used for connectionless transport (e.g., UDP) and ManySocketsMode not set to single (the default).
") }, - { MGROUP("ControlTopic", control_topic_cfgelems, control_topic_cfgattrs), 1, 0, 0, 0, 0, 0, 0, 0, - BLURB("The ControlTopic element allows configured whether DDSI2E provides a special control interface via a predefined topic or not.
") }, - { GROUP("Test", internal_test_cfgelems), - BLURB("
Testing options.
") }, - { GROUP("Watermarks", internal_watermarks_cfgelems), - BLURB("Watermarks for flow-control.
") }, - { LEAF("EnableExpensiveChecks"), 1, "", ABSOFF(enabled_xchecks), 0, uf_xcheck, 0, pf_xcheck, - BLURB("This element enables expensive checks in builds with assertions enabled and is ignored otherwise. Recognised categories are:
\n\ -In addition, there is the keyword all that enables all checks.
") }, - END_MARKER -}; - -static const struct cfgelem sizing_cfgelems[] = { - { LEAF("ReceiveBufferSize"), 1, "1 MiB", ABSOFF(rbuf_size), 0, uf_memsize, 0, pf_memsize, - BLURB("This element sets the size of a single receive buffer. Many receive buffers may be needed. The minimum workable size a little bit larger than Sizing/ReceiveBufferChunkSize, and the value used is taken as the configured value and the actual minimum workable size.
") }, - { LEAF("ReceiveBufferChunkSize"), 1, "128 KiB", ABSOFF(rmsg_chunk_size), 0, uf_memsize, 0, pf_memsize, - BLURB("This element specifies the size of one allocation unit in the receive buffer. Must be greater than the maximum packet size by a modest amount (too large packets are dropped). Each allocation is shrunk immediately after processing a message, or freed straightaway.
") }, - END_MARKER -}; - -static const struct cfgelem discovery_ports_cfgelems[] = { - { LEAF("Base"), 1, "7400", ABSOFF(ports.base), 0, uf_uint, 0, pf_uint, - BLURB("This element specifies the base port number (refer to the DDSI 2.1 specification, section 9.6.1, constant PB).
") }, - { LEAF("DomainGain"), 1, "250", ABSOFF(ports.dg), 0, uf_uint, 0, pf_uint, - BLURB("This element specifies the domain gain, relating domain ids to sets of port numbers (refer to the DDSI 2.1 specification, section 9.6.1, constant DG).
") }, - { LEAF("ParticipantGain"), 1, "2", ABSOFF(ports.pg), 0, uf_uint, 0, pf_uint, - BLURB("This element specifies the participant gain, relating p0, participant index to sets of port numbers (refer to the DDSI 2.1 specification, section 9.6.1, constant PG).
") }, - { LEAF("MulticastMetaOffset"), 1, "0", ABSOFF(ports.d0), 0, uf_uint, 0, pf_uint, - BLURB("This element specifies the port number for multicast meta traffic (refer to the DDSI 2.1 specification, section 9.6.1, constant d0).
") }, - { LEAF("UnicastMetaOffset"), 1, "10", ABSOFF(ports.d1), 0, uf_uint, 0, pf_uint, - BLURB("This element specifies the port number for unicast meta traffic (refer to the DDSI 2.1 specification, section 9.6.1, constant d1).
") }, - { LEAF("MulticastDataOffset"), 1, "1", ABSOFF(ports.d2), 0, uf_uint, 0, pf_uint, - BLURB("This element specifies the port number for multicast data traffic (refer to the DDSI 2.1 specification, section 9.6.1, constant d2).
") }, - { LEAF("UnicastDataOffset"), 1, "11", ABSOFF(ports.d3), 0, uf_uint, 0, pf_uint, - BLURB("This element specifies the port number for unicast data traffic (refer to the DDSI 2.1 specification, section 9.6.1, constant d3).
") }, - END_MARKER -}; - -static const struct cfgelem tcp_cfgelems[] = { - { LEAF ("Enable"), 1, "default", ABSOFF (compat_tcp_enable), 0, uf_boolean_default, 0, pf_nop, - BLURB("This element enables the optional TCP transport - deprecated, use General/Transport instead.
") }, - { LEAF("NoDelay"), 1, "true", ABSOFF(tcp_nodelay), 0, uf_boolean, 0, pf_boolean, - BLURB("This element enables the TCP_NODELAY socket option, preventing multiple DDSI messages being sent in the same TCP request. Setting this option typically optimises latency over throughput.
") }, - { LEAF("Port"), 1, "-1", ABSOFF(tcp_port), 0, uf_dyn_port, 0, pf_int, - BLURB("This element specifies the TCP port number on which DDSI2E accepts connections. If the port is set it is used in entity locators, published with DDSI discovery. Dynamically allocated if zero. Disabled if -1 or not configured. If disabled other DDSI services will not be able to establish connections with the service, the service can only communicate by establishing connections to other services.
") }, - { LEAF("ReadTimeout"), 1, "2 s", ABSOFF(tcp_read_timeout), 0, uf_duration_ms_1hr, 0, pf_duration, - BLURB("This element specifies the timeout for blocking TCP read operations. If this timeout expires then the connection is closed.
") }, - { LEAF("WriteTimeout"), 1, "2 s", ABSOFF(tcp_write_timeout), 0, uf_duration_ms_1hr, 0, pf_duration, - BLURB("This element specifies the timeout for blocking TCP write operations. If this timeout expires then the connection is closed.
") }, - { LEAF ("AlwaysUsePeeraddrForUnicast"), 1, "false", ABSOFF (tcp_use_peeraddr_for_unicast), 0, uf_boolean, 0, pf_boolean, - BLURB("Setting this to true means the unicast addresses in SPDP packets will be ignored and the peer address from the TCP connection will be used instead. This may help work around incorrectly advertised addresses when using TCP.
") }, - END_MARKER -}; - -#ifdef DDSI_INCLUDE_SSL -static const struct cfgelem ssl_cfgelems[] = { - { LEAF("Enable"), 1, "false", ABSOFF(ssl_enable), 0, uf_boolean, 0, pf_boolean, - BLURB("This enables SSL/TLS for TCP.
") }, - { LEAF("CertificateVerification"), 1, "true", ABSOFF(ssl_verify), 0, uf_boolean, 0, pf_boolean, - BLURB("If disabled this allows SSL connections to occur even if an X509 certificate fails verification.
") }, - { LEAF("VerifyClient"), 1, "true", ABSOFF(ssl_verify_client), 0, uf_boolean, 0, pf_boolean, - BLURB("This enables an SSL server checking the X509 certificate of a connecting client.
") }, - { LEAF("SelfSignedCertificates"), 1, "false", ABSOFF(ssl_self_signed), 0, uf_boolean, 0, pf_boolean, - BLURB("This enables the use of self signed X509 certificates.
") }, - { LEAF("KeystoreFile"), 1, "keystore", ABSOFF(ssl_keystore), 0, uf_string, ff_free, pf_string, - BLURB("The SSL/TLS key and certificate store file name. The keystore must be in PEM format.
") }, - { LEAF("KeyPassphrase"), 1, "secret", ABSOFF(ssl_key_pass), 0, uf_string, ff_free, pf_string, - BLURB("The SSL/TLS key pass phrase for encrypted keys.
") }, - { LEAF("Ciphers"), 1, "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH", ABSOFF(ssl_ciphers), 0, uf_string, ff_free, pf_string, - BLURB("The set of ciphers used by SSL/TLS
") }, - { LEAF("EntropyFile"), 1, "", ABSOFF(ssl_rand_file), 0, uf_string, ff_free, pf_string, - BLURB("The SSL/TLS random entropy file name.
") }, - { LEAF("MinimumTLSVersion"), 1, "1.3", ABSOFF(ssl_min_version), 0, uf_min_tls_version, 0, pf_min_tls_version, - BLURB("The minimum TLS version that may be negotiated, valid values are 1.2 and 1.3.
") }, - END_MARKER -}; -#endif - -static const struct cfgelem tp_cfgelems[] = { - { LEAF("Enable"), 1, "false", ABSOFF(tp_enable), 0, uf_boolean, 0, pf_boolean, - BLURB("This element enables the optional thread pool.
") }, - { LEAF("Threads"), 1, "4", ABSOFF(tp_threads), 0, uf_natint, 0, pf_int, - BLURB("This elements configures the initial number of threads in the thread pool.
") }, - { LEAF("ThreadMax"), 1, "8", ABSOFF(tp_max_threads), 0, uf_natint, 0, pf_int, - BLURB("This elements configures the maximum number of threads in the thread pool.
") }, - END_MARKER -}; - -static const struct cfgelem discovery_peer_cfgattrs[] = { - { ATTR("Address"), 1, NULL, RELOFF(config_peer_listelem, peer), 0, uf_ipv4, ff_free, pf_string, - BLURB("This element specifies an IP address to which discovery packets must be sent, in addition to the default multicast address (see also General/AllowMulticast). Both a hostnames and a numerical IP address is accepted; the hostname or IP address may be suffixed with :PORT to explicitly set the port to which it must be sent. Multiple Peers may be specified.
") }, - END_MARKER -}; - -static const struct cfgelem discovery_peers_group_cfgelems[] = { - { MGROUP("Peer", NULL, discovery_peer_cfgattrs), INT_MAX, NULL, ABSOFF(peers_group), if_peer, 0, 0, 0, - BLURB("This element statically configures an addresses for discovery.
") }, - END_MARKER -}; - -static const struct cfgelem discovery_peers_cfgelems[] = { - { MGROUP("Peer", NULL, discovery_peer_cfgattrs), INT_MAX, NULL, ABSOFF(peers), if_peer, 0, 0, 0, - BLURB("This element statically configures an addresses for discovery.
") }, - { GROUP("Group", discovery_peers_group_cfgelems), - BLURB("This element statically configures a fault tolerant group of addresses for discovery. Each member of the group is tried in sequence until one succeeds.
") }, - END_MARKER -}; - -static const struct cfgelem discovery_cfgelems[] = { - { LEAF("Tag"), 0, "", ABSOFF(domainTag), 0, uf_string, ff_free, pf_string, - BLURB("String extension for domain id that remote participants must match to be discovered.
") }, - { LEAF ("ExternalDomainId"), 1, "default", ABSOFF (extDomainId), 0, uf_maybe_int32, 0, pf_maybe_int32, - BLURB("An override for the domain id, to be used in discovery and for determining the port number mapping. This allows creating multiple domains in a single process while making them appear as a single domain on the network. The value \"default\" disables the override.
") }, - { LEAF("DSGracePeriod"), 1, "30 s", ABSOFF(ds_grace_period), 0, uf_duration_inf, 0, pf_duration, - BLURB("This setting controls for how long endpoints discovered via a Cloud discovery service will survive after the discovery service disappeared, allowing reconnect without loss of data when the discovery service restarts (or another instance takes over).
") }, - { GROUP("Peers", discovery_peers_cfgelems), - BLURB("This element statically configures addresses for discovery.
") }, - { LEAF("ParticipantIndex"), 1, "none", ABSOFF(participantIndex), 0, uf_participantIndex, 0, pf_participantIndex, - BLURB("This element specifies the DDSI participant index used by this instance of the DDSI2E service for discovery purposes. Only one such participant id is used, independent of the number of actual DomainParticipants on the node. It is either:
\n\ -The default is auto. The participant index is part of the port number calculation and if predictable port numbers are needed and fixing the participant index has no adverse effects, it is recommended that the second be option be used.
") }, - { LEAF("MaxAutoParticipantIndex"), 1, "9", ABSOFF(maxAutoParticipantIndex), 0, uf_natint, 0, pf_int, - BLURB("This element specifies the maximum DDSI participant index selected by this instance of the DDSI2E service if the Discovery/ParticipantIndex is \"auto\".
") }, - { LEAF("SPDPMulticastAddress"), 1, "239.255.0.1", ABSOFF(spdpMulticastAddressString), 0, uf_ipv4, ff_free, pf_string, - BLURB("This element specifies the multicast address that is used as the destination for the participant discovery packets. In IPv4 mode the default is the (standardised) 239.255.0.1, in IPv6 mode it becomes ff02::ffff:239.255.0.1, which is a non-standardised link-local multicast address.
") }, - { LEAF("SPDPInterval"), 1, "30 s", ABSOFF(spdp_interval), 0, uf_duration_ms_1hr, 0, pf_duration, - BLURB("This element specifies the interval between spontaneous transmissions of participant discovery packets.
") }, - { LEAF("DefaultMulticastAddress"), 1, "auto", ABSOFF(defaultMulticastAddressString), 0, uf_networkAddress, 0, pf_networkAddress, - BLURB("This element specifies the default multicast address for all traffic other than participant discovery packets. It defaults to Discovery/SPDPMulticastAddress.
") }, - { GROUP("Ports", discovery_ports_cfgelems), - BLURB("The Ports element allows specifying various parameters related to the port numbers used for discovery. These all have default values specified by the DDSI 2.1 specification and rarely need to be changed.
") }, - END_MARKER -}; - -static const struct cfgelem tracing_cfgelems[] = { - { LEAF("Category|EnableCategory"), 1, "", 0, 0, 0, uf_tracemask, 0, pf_tracemask, - BLURB("This element enables individual logging categories. These are enabled in addition to those enabled by Tracing/Verbosity. Recognised categories are:
\n\ -In addition, there is the keyword trace that enables all but radmin, topic, plist and whc
.\n\ -The categorisation of tracing output is incomplete and hence most of the verbosity levels and categories are not of much use in the current release. This is an ongoing process and here we describe the target situation rather than the current situation. Currently, the most useful is trace.
") }, - { LEAF("Verbosity"), 1, "none", 0, 0, 0, uf_verbosity, 0, pf_nop, - BLURB("This element enables standard groups of categories, based on a desired verbosity level. This is in addition to the categories enabled by the Tracing/Category setting. Recognised verbosity levels and the categories they map to are:
\n\ -While none prevents any message from being written to a DDSI2 log file.
\n\ -The categorisation of tracing output is incomplete and hence most of the verbosity levels and categories are not of much use in the current release. This is an ongoing process and here we describe the target situation rather than the current situation. Currently, the most useful verbosity levels are config, fine and finest.
") }, - { LEAF("OutputFile"), 1, "cyclonedds.log", ABSOFF(tracefile), 0, uf_tracingOutputFileName, ff_free, pf_string, - BLURB("This option specifies where the logging is printed to. Note that stdout and stderr are treated as special values, representing \"standard out\" and \"standard error\" respectively. No file is created unless logging categories are enabled using the Tracing/Verbosity or Tracing/EnabledCategory settings.
") }, - { LEAF("AppendToFile"), 1, "false", ABSOFF(tracingAppendToFile), 0, uf_boolean, 0, pf_boolean, - BLURB("This option specifies whether the output is to be appended to an existing log file. The default is to create a new log file each time, which is generally the best option if a detailed log is generated.
") }, - { LEAF("PacketCaptureFile"), 1, "", ABSOFF(pcap_file), 0, uf_string, ff_free, pf_string, - BLURB("This option specifies the file to which received and sent packets will be logged in the \"pcap\" format suitable for analysis using common networking tools, such as WireShark. IP and UDP headers are fictitious, in particular the destination address of received packets. The TTL may be used to distinguish between sent and received packets: it is 255 for sent packets and 128 for received ones. Currently IPv4 only.
") }, - END_MARKER -}; - -static const struct cfgelem domain_cfgattrs[] = { - { ATTR("Id"), 0, "any", ABSOFF(domainId), 0, uf_domainId, 0, pf_domainId, - BLURB("Domain id this configuration applies to, or \"any\" if it applies to all domain ids.
") }, - END_MARKER -}; - -static const struct cfgelem domain_cfgelems[] = { - { MOVED("Id", "CycloneDDS/Domain[@Id]") }, - { GROUP("General", general_cfgelems), - BLURB("The General element specifies overall DDSI2E service settings.
") }, -#ifdef DDSI_INCLUDE_SECURITY - { MGROUP ("DDSSecurity", security_omg_config_elements, NULL), INT_MAX, NULL, ABSOFF(omg_security_configuration), if_omg_security, 0, 0, 0, - BLURB("This element is used to configure DDSI2E with the DDS Security specification plugins and settings.
") }, -#endif -#ifdef DDSI_INCLUDE_NETWORK_PARTITIONS - { GROUP("Partitioning", partitioning_cfgelems), - BLURB("The Partitioning element specifies DDSI2E network partitions and how DCPS partition/topic combinations are mapped onto the network partitions.
") }, -#endif -#ifdef DDSI_INCLUDE_NETWORK_CHANNELS - { GROUP("Channels", channels_cfgelems), - BLURB("This element is used to group a set of channels. The channels are independent data paths through DDSI2E and by using separate threads and setting their priorities appropriately, chanenls can be used to map transport priorities to operating system scheduler priorities, ensuring system-wide end-to-end priority preservation.
") }, -#endif - { GROUP("Threads", threads_cfgelems), - BLURB("This element is used to set thread properties.
") }, - { GROUP("Sizing", sizing_cfgelems), - BLURB("The Sizing element specifies a variety of configuration settings dealing with expected system sizes, buffer sizes, &c.
") }, - { GROUP("Compatibility", compatibility_cfgelems), - BLURB("The Compatibility elements allows specifying various settings related to compatability with standards and with other DDSI implementations.
") }, - { GROUP("Discovery", discovery_cfgelems), - BLURB("The Discovery element allows specifying various parameters related to the discovery of peers.
") }, - { GROUP("Tracing", tracing_cfgelems), - BLURB("The Tracing element controls the amount and type of information that is written into the tracing log by the DDSI service. This is useful to track the DDSI service during application development.
") }, - { GROUP("Internal|Unsupported", internal_cfgelems), - BLURB("The Internal elements deal with a variety of settings that evolving and that are not necessarily fully supported. For the vast majority of the Internal settings, the functionality per-se is supported, but the right to change the way the options control the functionality is reserved. This includes renaming or moving options.
") }, - { GROUP("TCP", tcp_cfgelems), - BLURB("The TCP element allows specifying various parameters related to running DDSI over TCP.
") }, - { GROUP("ThreadPool", tp_cfgelems), - BLURB("The ThreadPool element allows specifying various parameters related to using a thread pool to send DDSI messages to multiple unicast addresses (TCP or UDP).
") }, -#ifdef DDSI_INCLUDE_SSL - { GROUP("SSL", ssl_cfgelems), - BLURB("The SSL element allows specifying various parameters related to using SSL/TLS for DDSI over TCP.
") }, -#endif - END_MARKER -}; - -static const struct cfgelem root_cfgelems[] = { - { GROUP_W_ATTRS("Domain", domain_cfgelems, domain_cfgattrs), - BLURB("The General element specifying Domain related settings.
") }, - { MOVED("General", "CycloneDDS/Domain/General") }, -#ifdef DDSI_INCLUDE_NETWORK_PARTITIONS - { MOVED("Partitioning", "CycloneDDS/Domain/Partitioning") }, -#endif -#ifdef DDSI_INCLUDE_NETWORK_CHANNELS - { MOVED("Channels", "CycloneDDS/Domain/Channels") }, -#endif - { MOVED("Threads", "CycloneDDS/Domain/Threads") }, - { MOVED("Sizing", "CycloneDDS/Domain/Sizing") }, - { MOVED("Compatibility", "CycloneDDS/Domain/Compatibility") }, - { MOVED("Discovery", "CycloneDDS/Domain/Discovery") }, - { MOVED("Tracing", "CycloneDDS/Domain/Tracing") }, - { MOVED("Internal|Unsupported", "CycloneDDS/Domain/Internal") }, - { MOVED("TCP", "CycloneDDS/Domain/TCP") }, - { MOVED("ThreadPool", "CycloneDDS/Domain/ThreadPool") }, -#ifdef DDSI_INCLUDE_SECURITY - { MOVED("DDSSecurity", "CycloneDDS/Domain/DDSSecurity") }, -#endif -#ifdef DDSI_INCLUDE_SSL - { MOVED("SSL", "CycloneDDS/Domain/SSL") }, -#endif - { MOVED("DDSI2E|DDSI2", "CycloneDDS/Domain") }, - END_MARKER -}; - -static const struct cfgelem root_cfgattrs[] = { - { ATTR("xmlns"), 0, "", 0, 0, 0, uf_nop, 0, pf_nop, NULL }, - { ATTR("xmlns:xsi"), 0, "", 0, 0, 0, uf_nop, 0, pf_nop, NULL }, - { ATTR("xsi:schemaLocation"), 0, "", 0, 0, 0, uf_nop, 0, pf_nop, NULL }, - { ATTR("xsi:noNamespaceSchemaLocation"), 0, "", 0, 0, 0, uf_nop, 0, pf_nop, NULL }, - END_MARKER -}; - -static const struct cfgelem cyclonedds_root_cfgelems[] = { - { "CycloneDDS", root_cfgelems, root_cfgattrs, NODATA, BLURB("CycloneDDS configuration") }, - END_MARKER -}; +#include "dds/ddsi/ddsi_cfgelems.h" static const struct cfgelem root_cfgelem = { - "/", cyclonedds_root_cfgelems, NULL, NODATA, NULL + "/", cyclonedds_root_cfgelems, NULL, NODATA }; -#undef ATTR -#undef GROUP -#undef LEAF_W_ATTRS -#undef LEAF -#undef WILDCARD -#undef END_MARKER +#undef DEPRECATED +#undef MEMBER +#undef MEMBEROF +#undef FUNCTIONS +#undef NOMEMBER +#undef NOFUNCTIONS #undef NODATA -#undef RELOFF -#undef ABSOFF -#undef CO +#undef END_MARKER +#undef MOVED +#undef NOP +#undef WILDCARD +#undef EXPAND +#undef BOOL +#undef INT +#undef STRING +#undef ENUM +#undef LIST +#undef GROUP +#undef ELEMENT static const struct unit unittab_duration[] = { { "ns", 1 }, diff --git a/src/security/core/tests/config.c b/src/security/core/tests/config.c index 6cb404d..2b45000 100644 --- a/src/security/core/tests/config.c +++ b/src/security/core/tests/config.c @@ -99,9 +99,9 @@ CU_Test(ddssec_config, empty, .init = ddsrt_init, .fini = ddsrt_fini) { dds_entity_t domain; const char *log_expected[] = { - "config: //CycloneDDS/Domain/DDSSecurity/Authentication/IdentityCertificate/#text: element missing in configuration*", - "config: //CycloneDDS/Domain/DDSSecurity/Authentication/IdentityCA/#text: element missing in configuration*", - "config: //CycloneDDS/Domain/DDSSecurity/Authentication/PrivateKey/#text: element missing in configuration*", + "config: //CycloneDDS/Domain/Security/Authentication/IdentityCertificate/#text: element missing in configuration*", + "config: //CycloneDDS/Domain/Security/Authentication/IdentityCA/#text: element missing in configuration*", + "config: //CycloneDDS/Domain/Security/Authentication/PrivateKey/#text: element missing in configuration*", NULL }; @@ -148,9 +148,9 @@ CU_Test(ddssec_config, missing, .init = ddsrt_init, .fini = ddsrt_fini) { dds_entity_t domain; const char *log_expected[] = { - "config: //CycloneDDS/Domain/DDSSecurity/Authentication/IdentityCertificate/#text: element missing in configuration*", - "config: //CycloneDDS/Domain/DDSSecurity/Authentication/IdentityCA/#text: element missing in configuration*", - "config: //CycloneDDS/Domain/DDSSecurity/Authentication/PrivateKey/#text: element missing in configuration*", + "config: //CycloneDDS/Domain/Security/Authentication/IdentityCertificate/#text: element missing in configuration*", + "config: //CycloneDDS/Domain/Security/Authentication/IdentityCA/#text: element missing in configuration*", + "config: //CycloneDDS/Domain/Security/Authentication/PrivateKey/#text: element missing in configuration*", NULL }; @@ -185,26 +185,26 @@ CU_Test(ddssec_config, all, .init = ddsrt_init, .fini = ddsrt_fini) { dds_entity_t domain, participant; const char *log_expected[] = { - "config: Domain/DDSSecurity/Authentication/Library/#text: "WRAPPERLIB_PATH("dds_security_authentication_wrapper")"*", - "config: Domain/DDSSecurity/Authentication/Library[@path]: "WRAPPERLIB_PATH("dds_security_authentication_wrapper")"*", - "config: Domain/DDSSecurity/Authentication/Library[@initFunction]: init_test_authentication_all_ok*", - "config: Domain/DDSSecurity/Authentication/Library[@finalizeFunction]: finalize_test_authentication_all_ok*", - "config: Domain/DDSSecurity/Authentication/IdentityCertificate/#text: "TEST_IDENTITY_CERTIFICATE_DUMMY"*", - "config: Domain/DDSSecurity/Authentication/IdentityCA/#text: "TEST_IDENTITY_CA_CERTIFICATE_DUMMY"*", - "config: Domain/DDSSecurity/Authentication/PrivateKey/#text: "TEST_IDENTITY_PRIVATE_KEY_DUMMY"*", - "config: Domain/DDSSecurity/Authentication/Password/#text: testtext_Password_testtext*", - "config: Domain/DDSSecurity/Authentication/TrustedCADirectory/#text: testtext_Dir_testtext*", - "config: Domain/DDSSecurity/AccessControl/Library/#text: "WRAPPERLIB_PATH("dds_security_access_control_wrapper")"*", - "config: Domain/DDSSecurity/AccessControl/Library[@path]: "WRAPPERLIB_PATH("dds_security_access_control_wrapper")"*", - "config: Domain/DDSSecurity/AccessControl/Library[@initFunction]: init_test_access_control_all_ok*", - "config: Domain/DDSSecurity/AccessControl/Library[@finalizeFunction]: finalize_test_access_control_all_ok*", - "config: Domain/DDSSecurity/AccessControl/PermissionsCA/#text: file:Permissions_CA.pem*", - "config: Domain/DDSSecurity/AccessControl/Governance/#text: file:Governance.p7s*", - "config: Domain/DDSSecurity/AccessControl/Permissions/#text: file:Permissions.p7s*", - "config: Domain/DDSSecurity/Cryptographic/Library/#text: "WRAPPERLIB_PATH("dds_security_cryptography_wrapper")"*", - "config: Domain/DDSSecurity/Cryptographic/Library[@path]: "WRAPPERLIB_PATH("dds_security_cryptography_wrapper")"*", - "config: Domain/DDSSecurity/Cryptographic/Library[@initFunction]: init_test_cryptography_all_ok*", - "config: Domain/DDSSecurity/Cryptographic/Library[@finalizeFunction]: finalize_test_cryptography_all_ok*", + "config: Domain/Security/Authentication/Library/#text: "WRAPPERLIB_PATH("dds_security_authentication_wrapper")"*", + "config: Domain/Security/Authentication/Library[@path]: "WRAPPERLIB_PATH("dds_security_authentication_wrapper")"*", + "config: Domain/Security/Authentication/Library[@initFunction]: init_test_authentication_all_ok*", + "config: Domain/Security/Authentication/Library[@finalizeFunction]: finalize_test_authentication_all_ok*", + "config: Domain/Security/Authentication/IdentityCertificate/#text: "TEST_IDENTITY_CERTIFICATE_DUMMY"*", + "config: Domain/Security/Authentication/IdentityCA/#text: "TEST_IDENTITY_CA_CERTIFICATE_DUMMY"*", + "config: Domain/Security/Authentication/PrivateKey/#text: "TEST_IDENTITY_PRIVATE_KEY_DUMMY"*", + "config: Domain/Security/Authentication/Password/#text: testtext_Password_testtext*", + "config: Domain/Security/Authentication/TrustedCADirectory/#text: testtext_Dir_testtext*", + "config: Domain/Security/AccessControl/Library/#text: "WRAPPERLIB_PATH("dds_security_access_control_wrapper")"*", + "config: Domain/Security/AccessControl/Library[@path]: "WRAPPERLIB_PATH("dds_security_access_control_wrapper")"*", + "config: Domain/Security/AccessControl/Library[@initFunction]: init_test_access_control_all_ok*", + "config: Domain/Security/AccessControl/Library[@finalizeFunction]: finalize_test_access_control_all_ok*", + "config: Domain/Security/AccessControl/PermissionsCA/#text: file:Permissions_CA.pem*", + "config: Domain/Security/AccessControl/Governance/#text: file:Governance.p7s*", + "config: Domain/Security/AccessControl/Permissions/#text: file:Permissions.p7s*", + "config: Domain/Security/Cryptographic/Library/#text: "WRAPPERLIB_PATH("dds_security_cryptography_wrapper")"*", + "config: Domain/Security/Cryptographic/Library[@path]: "WRAPPERLIB_PATH("dds_security_cryptography_wrapper")"*", + "config: Domain/Security/Cryptographic/Library[@initFunction]: init_test_cryptography_all_ok*", + "config: Domain/Security/Cryptographic/Library[@finalizeFunction]: finalize_test_cryptography_all_ok*", /* The config should have been parsed into the participant QoS. */ PARTICIPANT_QOS_ALL_OK ("", ",0:\"dds.sec.auth.password\":\"testtext_Password_testtext\",0:\"dds.sec.auth.trusted_ca_dir\":\"testtext_Dir_testtext\"", ""), NULL @@ -256,26 +256,26 @@ CU_Test(ddssec_config, security, .init = ddsrt_init, .fini = ddsrt_fini) { dds_entity_t domain, participant; const char *log_expected[] = { - "config: Domain/DDSSecurity/Authentication/Library/#text: "WRAPPERLIB_PATH("dds_security_authentication_wrapper")"*", - "config: Domain/DDSSecurity/Authentication/Library[@path]: "WRAPPERLIB_PATH("dds_security_authentication_wrapper")"*", - "config: Domain/DDSSecurity/Authentication/Library[@initFunction]: init_test_authentication_all_ok*", - "config: Domain/DDSSecurity/Authentication/Library[@finalizeFunction]: finalize_test_authentication_all_ok*", - "config: Domain/DDSSecurity/Authentication/IdentityCertificate/#text: "TEST_IDENTITY_CERTIFICATE_DUMMY"*", - "config: Domain/DDSSecurity/Authentication/IdentityCA/#text: "TEST_IDENTITY_CA_CERTIFICATE_DUMMY"*", - "config: Domain/DDSSecurity/Authentication/PrivateKey/#text: "TEST_IDENTITY_PRIVATE_KEY_DUMMY"*", - "config: Domain/DDSSecurity/Authentication/Password/#text: {}*", - "config: Domain/DDSSecurity/Authentication/TrustedCADirectory/#text: {}*", - "config: Domain/DDSSecurity/AccessControl/Library/#text: "WRAPPERLIB_PATH("dds_security_access_control_wrapper")"*", - "config: Domain/DDSSecurity/AccessControl/Library[@path]: "WRAPPERLIB_PATH("dds_security_access_control_wrapper")"*", - "config: Domain/DDSSecurity/AccessControl/Library[@initFunction]: init_test_access_control_all_ok*", - "config: Domain/DDSSecurity/AccessControl/Library[@finalizeFunction]: finalize_test_access_control_all_ok*", - "config: Domain/DDSSecurity/AccessControl/PermissionsCA/#text: file:Permissions_CA.pem*", - "config: Domain/DDSSecurity/AccessControl/Governance/#text: file:Governance.p7s*", - "config: Domain/DDSSecurity/AccessControl/Permissions/#text: file:Permissions.p7s*", - "config: Domain/DDSSecurity/Cryptographic/Library/#text: "WRAPPERLIB_PATH("dds_security_cryptography_wrapper")"*", - "config: Domain/DDSSecurity/Cryptographic/Library[@path]: "WRAPPERLIB_PATH("dds_security_cryptography_wrapper")"*", - "config: Domain/DDSSecurity/Cryptographic/Library[@initFunction]: init_test_cryptography_all_ok*", - "config: Domain/DDSSecurity/Cryptographic/Library[@finalizeFunction]: finalize_test_cryptography_all_ok*", + "config: Domain/Security/Authentication/Library/#text: "WRAPPERLIB_PATH("dds_security_authentication_wrapper")"*", + "config: Domain/Security/Authentication/Library[@path]: "WRAPPERLIB_PATH("dds_security_authentication_wrapper")"*", + "config: Domain/Security/Authentication/Library[@initFunction]: init_test_authentication_all_ok*", + "config: Domain/Security/Authentication/Library[@finalizeFunction]: finalize_test_authentication_all_ok*", + "config: Domain/Security/Authentication/IdentityCertificate/#text: "TEST_IDENTITY_CERTIFICATE_DUMMY"*", + "config: Domain/Security/Authentication/IdentityCA/#text: "TEST_IDENTITY_CA_CERTIFICATE_DUMMY"*", + "config: Domain/Security/Authentication/PrivateKey/#text: "TEST_IDENTITY_PRIVATE_KEY_DUMMY"*", + "config: Domain/Security/Authentication/Password/#text: {}*", + "config: Domain/Security/Authentication/TrustedCADirectory/#text: {}*", + "config: Domain/Security/AccessControl/Library/#text: "WRAPPERLIB_PATH("dds_security_access_control_wrapper")"*", + "config: Domain/Security/AccessControl/Library[@path]: "WRAPPERLIB_PATH("dds_security_access_control_wrapper")"*", + "config: Domain/Security/AccessControl/Library[@initFunction]: init_test_access_control_all_ok*", + "config: Domain/Security/AccessControl/Library[@finalizeFunction]: finalize_test_access_control_all_ok*", + "config: Domain/Security/AccessControl/PermissionsCA/#text: file:Permissions_CA.pem*", + "config: Domain/Security/AccessControl/Governance/#text: file:Governance.p7s*", + "config: Domain/Security/AccessControl/Permissions/#text: file:Permissions.p7s*", + "config: Domain/Security/Cryptographic/Library/#text: "WRAPPERLIB_PATH("dds_security_cryptography_wrapper")"*", + "config: Domain/Security/Cryptographic/Library[@path]: "WRAPPERLIB_PATH("dds_security_cryptography_wrapper")"*", + "config: Domain/Security/Cryptographic/Library[@initFunction]: init_test_cryptography_all_ok*", + "config: Domain/Security/Cryptographic/Library[@finalizeFunction]: finalize_test_cryptography_all_ok*", /* The config should have been parsed into the participant QoS. */ PARTICIPANT_QOS_ALL_OK ("", ",0:\"dds.sec.auth.password\":\"\",0:\"dds.sec.auth.trusted_ca_dir\":\"\"", ""), NULL @@ -324,26 +324,26 @@ CU_Test(ddssec_config, deprecated, .init = ddsrt_init, .fini = ddsrt_fini) { dds_entity_t domain, participant; const char *log_expected[] = { - "config: Domain/DDSSecurity/Authentication/Library/#text: "WRAPPERLIB_PATH("dds_security_authentication_wrapper")"*", - "config: Domain/DDSSecurity/Authentication/Library[@path]: "WRAPPERLIB_PATH("dds_security_authentication_wrapper")"*", - "config: Domain/DDSSecurity/Authentication/Library[@initFunction]: init_test_authentication_all_ok*", - "config: Domain/DDSSecurity/Authentication/Library[@finalizeFunction]: finalize_test_authentication_all_ok*", - "config: Domain/DDSSecurity/Authentication/IdentityCertificate/#text: "TEST_IDENTITY_CERTIFICATE_DUMMY"*", - "config: Domain/DDSSecurity/Authentication/IdentityCA/#text: "TEST_IDENTITY_CA_CERTIFICATE_DUMMY"*", - "config: Domain/DDSSecurity/Authentication/PrivateKey/#text: "TEST_IDENTITY_PRIVATE_KEY_DUMMY"*", - "config: Domain/DDSSecurity/Authentication/Password/#text: testtext_Password_testtext*", - "config: Domain/DDSSecurity/Authentication/TrustedCADirectory/#text: testtext_Dir_testtext*", - "config: Domain/DDSSecurity/AccessControl/Library/#text: "WRAPPERLIB_PATH("dds_security_access_control_wrapper")"*", - "config: Domain/DDSSecurity/AccessControl/Library[@path]: "WRAPPERLIB_PATH("dds_security_access_control_wrapper")"*", - "config: Domain/DDSSecurity/AccessControl/Library[@initFunction]: init_test_access_control_all_ok*", - "config: Domain/DDSSecurity/AccessControl/Library[@finalizeFunction]: finalize_test_access_control_all_ok*", - "config: Domain/DDSSecurity/AccessControl/PermissionsCA/#text: file:Permissions_CA.pem*", - "config: Domain/DDSSecurity/AccessControl/Governance/#text: file:Governance.p7s*", - "config: Domain/DDSSecurity/AccessControl/Permissions/#text: file:Permissions.p7s*", - "config: Domain/DDSSecurity/Cryptographic/Library/#text: "WRAPPERLIB_PATH("dds_security_cryptography_wrapper")"*", - "config: Domain/DDSSecurity/Cryptographic/Library[@path]: "WRAPPERLIB_PATH("dds_security_cryptography_wrapper")"*", - "config: Domain/DDSSecurity/Cryptographic/Library[@initFunction]: init_test_cryptography_all_ok*", - "config: Domain/DDSSecurity/Cryptographic/Library[@finalizeFunction]: finalize_test_cryptography_all_ok*", + "config: Domain/Security/Authentication/Library/#text: "WRAPPERLIB_PATH("dds_security_authentication_wrapper")"*", + "config: Domain/Security/Authentication/Library[@path]: "WRAPPERLIB_PATH("dds_security_authentication_wrapper")"*", + "config: Domain/Security/Authentication/Library[@initFunction]: init_test_authentication_all_ok*", + "config: Domain/Security/Authentication/Library[@finalizeFunction]: finalize_test_authentication_all_ok*", + "config: Domain/Security/Authentication/IdentityCertificate/#text: "TEST_IDENTITY_CERTIFICATE_DUMMY"*", + "config: Domain/Security/Authentication/IdentityCA/#text: "TEST_IDENTITY_CA_CERTIFICATE_DUMMY"*", + "config: Domain/Security/Authentication/PrivateKey/#text: "TEST_IDENTITY_PRIVATE_KEY_DUMMY"*", + "config: Domain/Security/Authentication/Password/#text: testtext_Password_testtext*", + "config: Domain/Security/Authentication/TrustedCADirectory/#text: testtext_Dir_testtext*", + "config: Domain/Security/AccessControl/Library/#text: "WRAPPERLIB_PATH("dds_security_access_control_wrapper")"*", + "config: Domain/Security/AccessControl/Library[@path]: "WRAPPERLIB_PATH("dds_security_access_control_wrapper")"*", + "config: Domain/Security/AccessControl/Library[@initFunction]: init_test_access_control_all_ok*", + "config: Domain/Security/AccessControl/Library[@finalizeFunction]: finalize_test_access_control_all_ok*", + "config: Domain/Security/AccessControl/PermissionsCA/#text: file:Permissions_CA.pem*", + "config: Domain/Security/AccessControl/Governance/#text: file:Governance.p7s*", + "config: Domain/Security/AccessControl/Permissions/#text: file:Permissions.p7s*", + "config: Domain/Security/Cryptographic/Library/#text: "WRAPPERLIB_PATH("dds_security_cryptography_wrapper")"*", + "config: Domain/Security/Cryptographic/Library[@path]: "WRAPPERLIB_PATH("dds_security_cryptography_wrapper")"*", + "config: Domain/Security/Cryptographic/Library[@initFunction]: init_test_cryptography_all_ok*", + "config: Domain/Security/Cryptographic/Library[@finalizeFunction]: finalize_test_cryptography_all_ok*", /* The config should have been parsed into the participant QoS. */ PARTICIPANT_QOS_ALL_OK ("", ",0:\"dds.sec.auth.password\":\"testtext_Password_testtext\",0:\"dds.sec.auth.trusted_ca_dir\":\"testtext_Dir_testtext\"", ""), NULL diff --git a/src/tools/CMakeLists.txt b/src/tools/CMakeLists.txt index fe1e2a7..c24da95 100644 --- a/src/tools/CMakeLists.txt +++ b/src/tools/CMakeLists.txt @@ -12,6 +12,7 @@ set(CMAKE_INSTALL_TOOLSDIR "${CMAKE_INSTALL_DATADIR}/${PROJECT_NAME}/tools") add_subdirectory(pubsub) add_subdirectory(ddsls) +add_subdirectory(ddsconf) if(BUILD_IDLC) add_subdirectory(ddsperf) endif() diff --git a/src/tools/ddsconf/CMakeLists.txt b/src/tools/ddsconf/CMakeLists.txt new file mode 100644 index 0000000..3ae4608 --- /dev/null +++ b/src/tools/ddsconf/CMakeLists.txt @@ -0,0 +1,17 @@ +# +# Copyright(c) 2020 ADLINK Technology Limited 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 +# +add_executable(ddsconf ddsconf.c rnc.c md.c xsd.c) +target_link_libraries(ddsconf PRIVATE ddsc) +target_include_directories(ddsconf + PRIVATE + $The default value is: \"%s\".
" + +int makedescription( + struct cfgelem *elem, + const struct cfgunit *units, + const char *(*xlat)(const char *, const char **)) +{ + if (elem->description) { + char *src = NULL; + char *dest = elem->meta.description; + const char *dflt = ""; + size_t len = 0, pos = 0; + const struct cfgunit *unit; + + if (isgroup(elem)) { + src = ddsrt_strdup(elem->description); + } else { + if (elem->value) + dflt = elem->value; + if (elem->meta.unit) { + unit = findunit(units, elem->meta.unit); + assert(unit); + ddsrt_asprintf( + &src, "%s\n%s\n"DFLTFMT, elem->description, unit->description, dflt); + } else { + ddsrt_asprintf( + &src, "%s\n"DFLTFMT, elem->description, dflt); + } + } + + if (!src) + return -1; + format(&dest, &len, &pos, src, xlat); + ddsrt_free(src); + if (!dest) + return -1; + elem->meta.description = dest; + } + return 0; +} + +static int init(struct cfgelem *root) +{ + if (sanitize_names(root) != 0) + return -1; + mark(root, root); + return 0; +} + +static void fini(struct cfgelem *elem) +{ + struct cfgelem *ce; + if (!elem) + return; + if (elem->meta.name) + ddsrt_free(elem->meta.name); + if (elem->meta.title) + ddsrt_free(elem->meta.title); + if (elem->meta.pattern) + ddsrt_free(elem->meta.pattern); + if (elem->meta.description) + ddsrt_free(elem->meta.description); + elem->meta.name = NULL; + elem->meta.title = NULL; + elem->meta.pattern = NULL; + elem->meta.description = NULL; + ce = firstelem(elem->children); + while (ce) { + fini(ce); + ce = nextelem(elem->children, ce); + } + ce = firstelem(elem->attributes); + while (ce) { + fini(ce); + ce = nextelem(elem->attributes, ce); + } +} + +int main(int argc, char *argv[]) +{ + int opt; + int code = EXIT_FAILURE; + FILE *out = NULL; + const char *file = "-"; + enum { rnc, xsd, md } format = rnc; + + while ((opt = getopt(argc, argv, "f:o:h")) != -1) { + switch (opt) { + case 'f': + if (strcmp(optarg, "rnc") == 0) { + format = rnc; + } else if (strcmp(optarg, "xsd") == 0) { + format = xsd; + } else if (strcmp(optarg, "md") == 0) { + format = md; + } else { + fprintf(stderr, "illegal output format: %s\n", optarg); + usage(argv[0]); + exit(EXIT_FAILURE); + } + break; + case 'h': + help(argv[0]); + exit(0); + break; + case 'o': + file = (const char *)optarg; + break; + default: + usage(argv[0]); + exit(EXIT_FAILURE); + } + } + + if (init(cyclonedds_root_cfgelems) == -1) { + fprintf(stderr, "out of memory\n"); + goto exit_failure; + } + + DDSRT_WARNING_MSVC_OFF(4996) + if (strcmp(file, "-") == 0) { + out = stdout; + } else if ((out = fopen(file, "wb")) == NULL) { + fprintf(stderr, "cannot open %s for writing\n", file); + goto exit_failure; + } + DDSRT_WARNING_MSVC_ON(4996) + + memset(spaces, ' ', sizeof(spaces)); + + switch (format) { + case rnc: + if (printrnc(out, cyclonedds_root_cfgelems, cfgunits) == 0) + code = EXIT_SUCCESS; + break; + case xsd: + if (printxsd(out, cyclonedds_root_cfgelems, cfgunits) == 0) + code = EXIT_SUCCESS; + break; + case md: + if (printmd(out, cyclonedds_root_cfgelems, cfgunits) == 0) + code = EXIT_SUCCESS; + break; + } + +exit_failure: + fini(cyclonedds_root_cfgelems); + if (out != NULL && out != stdout) + fclose(out); + + return code; +} diff --git a/src/tools/ddsconf/ddsconf.h b/src/tools/ddsconf/ddsconf.h new file mode 100644 index 0000000..c3afb55 --- /dev/null +++ b/src/tools/ddsconf/ddsconf.h @@ -0,0 +1,80 @@ +/* + * Copyright(c) 2020 ADLINK Technology Limited 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 + */ +#include", "" }, { "
", "" }, + { "", "" }, { "", "" }, + { "", "" }, { "", "" }, + { "by double newline */ + if (strncmp(str, "
", 4) == 0) { + const char *ptr = str + 4; + while (*ptr == '\n' || *ptr == ' ') ptr++; + if (strncmp(ptr, "", 3) == 0) {
+ *end = ptr;
+ return "\n\n";
+ }
+ }
+
+ for (size_t cnt = 0; tr[cnt].search; cnt++) {
+ size_t len = strlen(tr[cnt].search);
+ if (strncmp(str, tr[cnt].search, len) == 0) {
+ *end = str + len;
+ return tr[cnt].replace;
+ }
+ }
+
+ return NULL;
+}
+
+static char hashes[16];
+
+static void printhead(
+ FILE *out,
+ unsigned int level,
+ unsigned int flags,
+ struct cfgelem *elem,
+ const struct cfgunit *units)
+{
+ (void)level;
+ (void)flags;
+ (void)units;
+ assert(level < sizeof(hashes));
+ hashes[level+1] = '\0';
+ fprintf(out, "%s %s\n", hashes, elem->meta.title);
+ hashes[level+1] = '#';
+}
+
+static void printlink(
+ FILE *out,
+ unsigned int level,
+ unsigned int flags,
+ struct cfgelem *elem,
+ const struct cfgunit *units)
+{
+ int chr;
+ (void)level;
+ (void)flags;
+ (void)units;
+ assert(elem->meta.title);
+ fputc('#', out);
+ for (const char *ptr = elem->meta.title; *ptr; ptr++) {
+ chr = (unsigned char)*ptr;
+ if (chr >= 'A' && chr <= 'Z')
+ chr = (chr - 'A') + 'a';
+ if (chr >= 'a' && chr <= 'z')
+ fputc(chr, out);
+ }
+}
+
+static void printtype(
+ FILE *out,
+ unsigned int level,
+ unsigned int flags,
+ struct cfgelem *elem,
+ const struct cfgunit *units)
+{
+ (void)level;
+ (void)flags;
+ (void)units;
+ assert(!isgroup(elem));
+ if (isbool(elem)) {
+ fprintf(out, "Boolean\n");
+ } else if (islist(elem)) {
+ assert(elem->meta.values);
+ fprintf(out, "One of:\n");
+ if (elem->value && strlen(elem->value))
+ fprintf(out, "* Keyword: %s\n", elem->value);
+ fprintf(out, "* Comma-separated list of: ");
+ for (const char **v = elem->meta.values; *v; v++) {
+ fprintf(out, "%s%s", v == elem->meta.values ? "" : ", ", *v);
+ }
+ fprintf(out, "\n");
+ if (!elem->value || !strlen(elem->value))
+ fprintf(out, "* Or empty\n");
+ } else if (isenum(elem)) {
+ assert(elem->meta.values);
+ fprintf(out, "One of: ");
+ for (const char **v = elem->meta.values; *v; v++) {
+ fprintf(out, "%s%s", v == elem->meta.values ? "" : ", ", *v);
+ }
+ fprintf(out, "\n");
+ } else if (isint(elem)) {
+ fprintf(out, "Integer\n");
+ } else if (elem->meta.unit) {
+ fprintf(out, "Number-with-unit\n");
+ } else if (isstring(elem)) {
+ fprintf(out, "Text\n");
+ }
+}
+
+#define FLAG_LF (1u<<0)
+
+static void printattr(
+ FILE *out,
+ unsigned int level,
+ unsigned int flags,
+ struct cfgelem *elem,
+ const struct cfgunit *units)
+{
+ if (flags & FLAG_LF)
+ fputs("\n\n\n", out);
+ printhead(out, level, flags, elem, units);
+ printtype(out, level, flags, elem, units);
+ fputs("\n", out);
+ if (elem->description)
+ fputs(elem->meta.description, out);
+}
+
+static void printelem(
+ FILE *out,
+ unsigned int level,
+ unsigned int flags,
+ struct cfgelem *elem,
+ const struct cfgunit *units)
+{
+ if (flags & FLAG_LF)
+ fprintf(out, "\n\n\n");
+ printhead(out, level, flags, elem, units);
+ flags &= ~FLAG_LF;
+ if (hasattributes(elem)) {
+ int cnt = 0;
+ const char *sep = "Attributes: ";
+ struct cfgelem *ce = firstelem(elem->attributes);
+ while (ce) {
+ if (!isnop(ce)) {
+ fprintf(out, "%s[%s](", sep, name(ce));
+ printlink(out, level, flags, ce, units);
+ fprintf(out, ")");
+ sep = ", ";
+ cnt++;
+ }
+ ce = nextelem(elem->attributes, ce);
+ }
+ if (cnt != 0) {
+ fprintf(out, "\n");
+ flags |= FLAG_LF;
+ }
+ }
+ if (haschildren(elem)) {
+ const char *sep = "Children: ";
+ struct cfgelem *ce = firstelem(elem->children);
+ while (ce) {
+ fprintf(out, "%s[%s](", sep, name(ce));
+ printlink(out, level, flags, ce, units);
+ fprintf(out, ")");
+ sep = ", ";
+ ce = nextelem(elem->children, ce);
+ }
+ fprintf(out, "\n");
+ flags |= FLAG_LF;
+ } else if (!isgroup(elem)) {
+ if (flags & FLAG_LF)
+ fprintf(out, "\n");
+ printtype(out, level+1, flags, elem, units);
+ flags |= FLAG_LF;
+ }
+ if (elem->description) {
+ if (flags & FLAG_LF)
+ fprintf(out, "\n");
+ fputs(elem->meta.description, out);
+ }
+ if (hasattributes(elem)) {
+ struct cfgelem *ce = firstelem(elem->attributes);
+ while (ce) {
+ if (!isnop(ce))
+ printattr(out, level, flags, ce, units);
+ ce = nextelem(elem->attributes, ce);
+ }
+ }
+ if (isgroup(elem)) {
+ struct cfgelem *ce = firstelem(elem->children);
+ while (ce) {
+ printelem(out, level+1, flags, ce, units);
+ ce = nextelem(elem->children, ce);
+ }
+ }
+}
+
+static int maketitles(
+ struct cfgelem *elem, int attr, const char *path, size_t pathlen)
+{
+ char *str;
+ size_t namelen = 0, len = 0;
+ struct cfgelem *ce;
+ if (ismoved(elem) || isdeprecated(elem) || elem->meta.title)
+ return 0;
+ namelen = strlen(name(elem));
+ if (!(str = ddsrt_malloc(pathlen + namelen + (attr ? 4 : 2))))
+ return -1;
+ memcpy(str, path, pathlen);
+ len += pathlen;
+ if (attr) {
+ str[len++] = '[';
+ str[len++] = '@';
+ } else {
+ str[len++] = '/';
+ }
+ memcpy(str+len, name(elem), namelen);
+ len += namelen;
+ if (attr) {
+ str[len++] = ']';
+ }
+ str[len] = '\0';
+ elem->meta.title = str;
+ ce = firstelem(elem->children);
+ while (ce) {
+ if (maketitles(ce, 0, str, len) == -1)
+ return -1;
+ ce = nextelem(elem->children, ce);
+ }
+ ce = firstelem(elem->attributes);
+ while (ce) {
+ if (maketitles(ce, 1, str, len) == -1)
+ return -1;
+ ce = nextelem(elem->attributes, ce);
+ }
+ return 0;
+}
+
+static int initmd(struct cfgelem *elem, const struct cfgunit *units)
+{
+ if (ismoved(elem) || isdeprecated(elem))
+ return 0;
+ if (makedescription(elem, units, xlatmd) == -1)
+ return -1;
+ for (struct cfgelem *ce = elem->children; ce && ce->name; ce++) {
+ if (initmd(ce, units) == -1)
+ return -1;
+ }
+ for (struct cfgelem *ce = elem->attributes; ce && ce->name; ce++) {
+ if (initmd(ce, units) == - 1)
+ return -1;
+ }
+ return 0;
+}
+
+int printmd(FILE *out, struct cfgelem *elem, const struct cfgunit *units)
+{
+ if (initmd(elem, units) == -1)
+ return -1;
+ if (maketitles(elem, 0, "/", 1) == -1)
+ return -1;
+ memset(hashes, '#', sizeof(hashes));
+ printelem(out, 0u, 0u, elem, units);
+ return 0;
+}
diff --git a/src/tools/ddsconf/rnc.c b/src/tools/ddsconf/rnc.c
new file mode 100644
index 0000000..2b36b0e
--- /dev/null
+++ b/src/tools/ddsconf/rnc.c
@@ -0,0 +1,163 @@
+/*
+ * Copyright(c) 2020 ADLINK Technology Limited 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
+ */
+#include