|
Engage Engine API
1.264.9125
Real-time tactical communications engine API
|
Configuration for the Rallypoint server. More...
#include <ConfigurationObjects.h>
Inherits AppConfigurationObjects::ConfigurationObjectBase.
Public Member Functions | |
| void | clear () |
Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase | |
| virtual void | initForDocumenting () |
| virtual std::string | toString () |
| virtual bool | isDocumenting () const |
Public Attributes | |
| StreamIdPrivacyType_t | streamIdPrivacyType |
| [Optional, default sptDefault] Modes for stream ID transformation. | |
| FipsCryptoSettings | fipsCrypto |
| [Optional] Settings for the FIPS crypto. | |
| WatchdogSettings | watchdog |
| [Optional] Settings for the Rallypoint's watchdog. | |
| EnginePolicyLogging | logging |
| [Optional] Console / syslog logging. enableSyslog defaults to false. | |
| std::string | id |
| A unqiue identifier for the Rallypoint. | |
| std::string | name |
| A human-readable name for the Rallypoint. | |
| int | listenPort |
| TCP port to listen on. Default is 7443. | |
| IpFamilyType_t | ipFamily |
| [Optional, Default IpFamilyType_t::ifIp4] Address familiy to be used for listening | |
| std::string | interfaceName |
| Name of the NIC to bind to for listening for incoming TCP connections. | |
| SecurityCertificate | certificate |
| X.509 certificate and private key that identifies the Rallypoint. | |
| std::string | peeringConfigurationFileName |
| Name of a file containing a JSON array of Rallypoint peers to connect to. | |
| std::string | peeringConfigurationFileCommand |
| Command-line to execute that returns a JSON array of Rallypoint peers to connect to. | |
| int | peeringConfigurationFileCheckSecs |
| Number of seconds between checks to see if the peering configuration has been updated. Default is 60. | |
| bool | allowMulticastForwarding |
| Allows traffic received on unicast links to be forwarded to the multicast network. | |
| int | ioPools |
| Number of threading pools to create for network I/O. Default is -1 which creates 1 I/O pool per CPU core. | |
| RallypointServerStatusReportConfiguration | statusReport |
| Details for producing a status report. | |
| StatusUploadConfiguration | statusUpload |
| Process-level HTTP POST settings for status / link / route uploads. | |
| RallypointServerLimits | limits |
| Details for capacity limits and determining processing load. | |
| RallypointServerLinkGraph | linkGraph |
| Details for producing a Graphviz-compatible link graph. | |
| ExternalHealthCheckResponder | externalHealthCheckResponder |
| Details concerning the Rallypoint's interaction with an external health-checker such as a load-balancer. | |
| bool | allowPeerForwarding |
| Set to true to allow forwarding of packets received from other Rallypoints to all other Rallypoints. WARNING Be exceptionally careful when enabling this capability! | |
| std::string | multicastInterfaceName |
| The name of the NIC on which to send and receive multicast traffic. | |
| Tls | tls |
| Details concerning Transport Layer Security. | |
| DiscoveryConfiguration | discovery |
| Details discovery capabilities. | |
| bool | forwardDiscoveredGroups |
| Enables automatic forwarding of discovered multicast traffic to peer Rallypoints. | |
| bool | forwardMulticastAddressing |
| Enables forwarding of multicast addressing to peer Rallypoints. | |
| PeeringConfiguration | peeringConfiguration |
| Internal - not serialized. | |
| bool | isMeshLeaf |
| Indicates whether this Rallypoint is part of a core domain or hangs off the periphery as a leaf node. | |
| bool | disableMessageSigning |
| Set to true to forgo DSA signing of messages. Doing so is is a security risk but can be useful on CPU-constrained systems on already-secure environments. | |
| NetworkAddressRestrictionList | multicastRestrictions |
| Multicasts to be restricted (inclusive or exclusive) | |
| IgmpSnooping | igmpSnooping |
| IGMP snooping configuration. | |
| std::vector< RallypointReflector > | staticReflectors |
| Vector of static groups. | |
| TcpNetworkTxOptions | tcpTxOptions |
| Tx options for TCP. | |
| NetworkTxOptions | multicastTxOptions |
| Tx options for multicast. | |
| std::string | certStoreFileName |
| Path to the certificate store. | |
| std::string | certStorePasswordHex |
| Hex password for the certificate store (if any) | |
| StringRestrictionList | groupRestrictions |
| Group IDs to be restricted (inclusive or exclusive) | |
| GroupRestrictionAccessPolicyType_t | groupRestrictionAccessPolicyType |
| The policy employed to allow group registration. | |
| std::vector< RallypointExtendedGroupRestriction > | extendedGroupRestrictions |
| Extended group restrictions. | |
| std::string | configurationCheckSignalName |
| Name to use for signalling a configuration check. | |
| Licensing | licensing |
| Licensing settings. | |
| Featureset | featureset |
| Optional feature set. | |
| RallypointUdpStreaming | udpStreaming |
| Optional configuration for high-performance UDP streaming. | |
| uint32_t | sysFlags |
| [Optional, Default 0] Internal system flags | |
| uint32_t | normalTaskQueueBias |
| [Optional, Default 0] Sets the queue's normal task bias | |
| bool | enableLeafReflectionReverseSubscription |
| If enabled, causes a domain leaf to reverse-subscribe to a core node upon the core subscribing and a reflector having been setup. | |
| bool | disableLoopDetection |
| If true, turns off loop detection. | |
| uint32_t | maxSecurityLevel |
| [Optional, Default 0] Sets the maximum item security level that can be registered with the RP | |
| RallypointServerRouteMap | routeMap |
| Details for producing a report containing the route map. | |
| RallypointServerStreamStatsExport | streamStatsExport |
| File export of per-stream counters. Also POSTed as rp-streams when statusUpload.baseUrl is set, independent of RTI. | |
| uint32_t | maxOutboundPeerConnectionIntervalDeltaSecs |
| [Optional, Default 15] Sets the delta value for the maximum number of seconds to delay when attempting outbound peer connections | |
| int | peerRtTestIntervalMs |
| [Optional, Default: 60000] Milliseconds between sending round-trip test requests to peers | |
| std::vector< RallypointRpRtTimingBehavior > | peerRtBehaviors |
| [Optional] Array of behaviors for roundtrip times to peers | |
| RallypointWebsocketSettings | websocket |
| [Optional] Settings for websocket operation | |
| RallypointQuicSettings | quic |
| [Optional] Settings for QUIC operation (UDP listener). Reuses the Rallypoint TLS certificate. | |
| NsmNode | nsm |
[Optional] Embedded NSM node settings (JSON key nsm; legacy flat NsmConfiguration accepted). | |
| RallypointAdvertisingSettings | advertising |
| [Optional] Settings for advertising. | |
| RtiCloudSettings | rtiCloud |
| [Optional] Rally Tactical cloud (RTI) integration. | |
| PacketCapturer | rxCapture |
| Details for capture of received packets | |
| PacketCapturer | txCapture |
| Details for capture of transmitted packets | |
| std::string | domainName |
| [Optional] This Rallypoint's domain name | |
| std::vector< std::string > | allowedDomains |
| [Optional] List of domains that explicitly MAY connect to this RP | |
| std::vector< std::string > | blockedDomains |
| [Optional] List of domains that explictly MAY NOT connect to this RP | |
| std::vector< std::string > | extraDomains |
| [Optional] List of additional domains that can be reached via this RP | |
| TuningSettings | tuning |
| [Optional] Low-level tuning | |
| std::vector< NamedIdentity > | additionalIdentities |
| [Optional] List of additional named identities | |
Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase | |
| nlohmann::json | _attached |
Additional Inherited Members | |
Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase | |
| bool | _documenting |
Configuration for the Rallypoint server.
Helper C++ class to serialize and de-serialize RallypointServer JSON
Example:
Definition at line 10723 of file ConfigurationObjects.h.
| enum AppConfigurationObjects::RallypointServer::StreamIdPrivacyType_t |
Definition at line 10729 of file ConfigurationObjects.h.
|
inline |
Definition at line 10950 of file ConfigurationObjects.h.
|
inline |
Definition at line 10955 of file ConfigurationObjects.h.
| std::vector<NamedIdentity> AppConfigurationObjects::RallypointServer::additionalIdentities |
[Optional] List of additional named identities
Definition at line 10948 of file ConfigurationObjects.h.
| RallypointAdvertisingSettings AppConfigurationObjects::RallypointServer::advertising |
[Optional] Settings for advertising.
Definition at line 10921 of file ConfigurationObjects.h.
| std::vector<std::string> AppConfigurationObjects::RallypointServer::allowedDomains |
[Optional] List of domains that explicitly MAY connect to this RP
Definition at line 10936 of file ConfigurationObjects.h.
| bool AppConfigurationObjects::RallypointServer::allowMulticastForwarding |
Allows traffic received on unicast links to be forwarded to the multicast network.
Definition at line 10792 of file ConfigurationObjects.h.
| bool AppConfigurationObjects::RallypointServer::allowPeerForwarding |
Set to true to allow forwarding of packets received from other Rallypoints to all other Rallypoints. WARNING Be exceptionally careful when enabling this capability!
Definition at line 10813 of file ConfigurationObjects.h.
| std::vector<std::string> AppConfigurationObjects::RallypointServer::blockedDomains |
[Optional] List of domains that explictly MAY NOT connect to this RP
Definition at line 10939 of file ConfigurationObjects.h.
| SecurityCertificate AppConfigurationObjects::RallypointServer::certificate |
X.509 certificate and private key that identifies the Rallypoint.
Definition at line 10780 of file ConfigurationObjects.h.
| std::string AppConfigurationObjects::RallypointServer::certStoreFileName |
Path to the certificate store.
Definition at line 10855 of file ConfigurationObjects.h.
| std::string AppConfigurationObjects::RallypointServer::certStorePasswordHex |
Hex password for the certificate store (if any)
Definition at line 10858 of file ConfigurationObjects.h.
| std::string AppConfigurationObjects::RallypointServer::configurationCheckSignalName |
Name to use for signalling a configuration check.
Definition at line 10870 of file ConfigurationObjects.h.
| bool AppConfigurationObjects::RallypointServer::disableLoopDetection |
If true, turns off loop detection.
Definition at line 10891 of file ConfigurationObjects.h.
| bool AppConfigurationObjects::RallypointServer::disableMessageSigning |
Set to true to forgo DSA signing of messages. Doing so is is a security risk but can be useful on CPU-constrained systems on already-secure environments.
Definition at line 10837 of file ConfigurationObjects.h.
| DiscoveryConfiguration AppConfigurationObjects::RallypointServer::discovery |
Details discovery capabilities.
Definition at line 10822 of file ConfigurationObjects.h.
| std::string AppConfigurationObjects::RallypointServer::domainName |
[Optional] This Rallypoint's domain name
Definition at line 10933 of file ConfigurationObjects.h.
| bool AppConfigurationObjects::RallypointServer::enableLeafReflectionReverseSubscription |
If enabled, causes a domain leaf to reverse-subscribe to a core node upon the core subscribing and a reflector having been setup.
Definition at line 10888 of file ConfigurationObjects.h.
| std::vector<RallypointExtendedGroupRestriction> AppConfigurationObjects::RallypointServer::extendedGroupRestrictions |
Extended group restrictions.
Definition at line 10867 of file ConfigurationObjects.h.
| ExternalHealthCheckResponder AppConfigurationObjects::RallypointServer::externalHealthCheckResponder |
Details concerning the Rallypoint's interaction with an external health-checker such as a load-balancer.
Definition at line 10810 of file ConfigurationObjects.h.
| std::vector<std::string> AppConfigurationObjects::RallypointServer::extraDomains |
[Optional] List of additional domains that can be reached via this RP
Definition at line 10942 of file ConfigurationObjects.h.
| Featureset AppConfigurationObjects::RallypointServer::featureset |
Optional feature set.
Definition at line 10876 of file ConfigurationObjects.h.
| FipsCryptoSettings AppConfigurationObjects::RallypointServer::fipsCrypto |
[Optional] Settings for the FIPS crypto.
Definition at line 10756 of file ConfigurationObjects.h.
| bool AppConfigurationObjects::RallypointServer::forwardDiscoveredGroups |
Enables automatic forwarding of discovered multicast traffic to peer Rallypoints.
Definition at line 10825 of file ConfigurationObjects.h.
| bool AppConfigurationObjects::RallypointServer::forwardMulticastAddressing |
Enables forwarding of multicast addressing to peer Rallypoints.
Definition at line 10828 of file ConfigurationObjects.h.
| GroupRestrictionAccessPolicyType_t AppConfigurationObjects::RallypointServer::groupRestrictionAccessPolicyType |
The policy employed to allow group registration.
Definition at line 10864 of file ConfigurationObjects.h.
| StringRestrictionList AppConfigurationObjects::RallypointServer::groupRestrictions |
Group IDs to be restricted (inclusive or exclusive)
Definition at line 10861 of file ConfigurationObjects.h.
| std::string AppConfigurationObjects::RallypointServer::id |
A unqiue identifier for the Rallypoint.
Definition at line 10765 of file ConfigurationObjects.h.
| IgmpSnooping AppConfigurationObjects::RallypointServer::igmpSnooping |
IGMP snooping configuration.
Definition at line 10843 of file ConfigurationObjects.h.
| std::string AppConfigurationObjects::RallypointServer::interfaceName |
Name of the NIC to bind to for listening for incoming TCP connections.
Definition at line 10777 of file ConfigurationObjects.h.
| int AppConfigurationObjects::RallypointServer::ioPools |
Number of threading pools to create for network I/O. Default is -1 which creates 1 I/O pool per CPU core.
Definition at line 10795 of file ConfigurationObjects.h.
| IpFamilyType_t AppConfigurationObjects::RallypointServer::ipFamily |
[Optional, Default IpFamilyType_t::ifIp4] Address familiy to be used for listening
Definition at line 10774 of file ConfigurationObjects.h.
| bool AppConfigurationObjects::RallypointServer::isMeshLeaf |
Indicates whether this Rallypoint is part of a core domain or hangs off the periphery as a leaf node.
Definition at line 10834 of file ConfigurationObjects.h.
| Licensing AppConfigurationObjects::RallypointServer::licensing |
Licensing settings.
Definition at line 10873 of file ConfigurationObjects.h.
| RallypointServerLimits AppConfigurationObjects::RallypointServer::limits |
Details for capacity limits and determining processing load.
Definition at line 10804 of file ConfigurationObjects.h.
| RallypointServerLinkGraph AppConfigurationObjects::RallypointServer::linkGraph |
Details for producing a Graphviz-compatible link graph.
Definition at line 10807 of file ConfigurationObjects.h.
| int AppConfigurationObjects::RallypointServer::listenPort |
TCP port to listen on. Default is 7443.
Definition at line 10771 of file ConfigurationObjects.h.
| EnginePolicyLogging AppConfigurationObjects::RallypointServer::logging |
[Optional] Console / syslog logging. enableSyslog defaults to false.
Definition at line 10762 of file ConfigurationObjects.h.
| uint32_t AppConfigurationObjects::RallypointServer::maxOutboundPeerConnectionIntervalDeltaSecs |
[Optional, Default 15] Sets the delta value for the maximum number of seconds to delay when attempting outbound peer connections
Definition at line 10903 of file ConfigurationObjects.h.
| uint32_t AppConfigurationObjects::RallypointServer::maxSecurityLevel |
[Optional, Default 0] Sets the maximum item security level that can be registered with the RP
Definition at line 10894 of file ConfigurationObjects.h.
| std::string AppConfigurationObjects::RallypointServer::multicastInterfaceName |
The name of the NIC on which to send and receive multicast traffic.
Definition at line 10816 of file ConfigurationObjects.h.
| NetworkAddressRestrictionList AppConfigurationObjects::RallypointServer::multicastRestrictions |
Multicasts to be restricted (inclusive or exclusive)
Definition at line 10840 of file ConfigurationObjects.h.
| NetworkTxOptions AppConfigurationObjects::RallypointServer::multicastTxOptions |
Tx options for multicast.
Definition at line 10852 of file ConfigurationObjects.h.
| std::string AppConfigurationObjects::RallypointServer::name |
A human-readable name for the Rallypoint.
Definition at line 10768 of file ConfigurationObjects.h.
| uint32_t AppConfigurationObjects::RallypointServer::normalTaskQueueBias |
[Optional, Default 0] Sets the queue's normal task bias
Definition at line 10885 of file ConfigurationObjects.h.
| NsmNode AppConfigurationObjects::RallypointServer::nsm |
[Optional] Embedded NSM node settings (JSON key nsm; legacy flat NsmConfiguration accepted).
Definition at line 10918 of file ConfigurationObjects.h.
| PeeringConfiguration AppConfigurationObjects::RallypointServer::peeringConfiguration |
Internal - not serialized.
Definition at line 10831 of file ConfigurationObjects.h.
| int AppConfigurationObjects::RallypointServer::peeringConfigurationFileCheckSecs |
Number of seconds between checks to see if the peering configuration has been updated. Default is 60.
Definition at line 10789 of file ConfigurationObjects.h.
| std::string AppConfigurationObjects::RallypointServer::peeringConfigurationFileCommand |
Command-line to execute that returns a JSON array of Rallypoint peers to connect to.
Definition at line 10786 of file ConfigurationObjects.h.
| std::string AppConfigurationObjects::RallypointServer::peeringConfigurationFileName |
Name of a file containing a JSON array of Rallypoint peers to connect to.
Definition at line 10783 of file ConfigurationObjects.h.
| std::vector<RallypointRpRtTimingBehavior> AppConfigurationObjects::RallypointServer::peerRtBehaviors |
[Optional] Array of behaviors for roundtrip times to peers
Definition at line 10909 of file ConfigurationObjects.h.
| int AppConfigurationObjects::RallypointServer::peerRtTestIntervalMs |
[Optional, Default: 60000] Milliseconds between sending round-trip test requests to peers
Definition at line 10906 of file ConfigurationObjects.h.
| RallypointQuicSettings AppConfigurationObjects::RallypointServer::quic |
[Optional] Settings for QUIC operation (UDP listener). Reuses the Rallypoint TLS certificate.
Definition at line 10915 of file ConfigurationObjects.h.
| RallypointServerRouteMap AppConfigurationObjects::RallypointServer::routeMap |
Details for producing a report containing the route map.
Definition at line 10897 of file ConfigurationObjects.h.
| RtiCloudSettings AppConfigurationObjects::RallypointServer::rtiCloud |
[Optional] Rally Tactical cloud (RTI) integration.
Definition at line 10924 of file ConfigurationObjects.h.
| PacketCapturer AppConfigurationObjects::RallypointServer::rxCapture |
Details for capture of received packets
Definition at line 10927 of file ConfigurationObjects.h.
| std::vector<RallypointReflector> AppConfigurationObjects::RallypointServer::staticReflectors |
Vector of static groups.
Definition at line 10846 of file ConfigurationObjects.h.
| RallypointServerStatusReportConfiguration AppConfigurationObjects::RallypointServer::statusReport |
Details for producing a status report.
Definition at line 10798 of file ConfigurationObjects.h.
| StatusUploadConfiguration AppConfigurationObjects::RallypointServer::statusUpload |
Process-level HTTP POST settings for status / link / route uploads.
Definition at line 10801 of file ConfigurationObjects.h.
| StreamIdPrivacyType_t AppConfigurationObjects::RallypointServer::streamIdPrivacyType |
[Optional, default sptDefault] Modes for stream ID transformation.
Definition at line 10753 of file ConfigurationObjects.h.
| RallypointServerStreamStatsExport AppConfigurationObjects::RallypointServer::streamStatsExport |
File export of per-stream counters. Also POSTed as rp-streams when statusUpload.baseUrl is set, independent of RTI.
Definition at line 10900 of file ConfigurationObjects.h.
| uint32_t AppConfigurationObjects::RallypointServer::sysFlags |
[Optional, Default 0] Internal system flags
Definition at line 10882 of file ConfigurationObjects.h.
| TcpNetworkTxOptions AppConfigurationObjects::RallypointServer::tcpTxOptions |
Tx options for TCP.
Definition at line 10849 of file ConfigurationObjects.h.
| Tls AppConfigurationObjects::RallypointServer::tls |
Details concerning Transport Layer Security.
Definition at line 10819 of file ConfigurationObjects.h.
| TuningSettings AppConfigurationObjects::RallypointServer::tuning |
[Optional] Low-level tuning
Definition at line 10945 of file ConfigurationObjects.h.
| PacketCapturer AppConfigurationObjects::RallypointServer::txCapture |
Details for capture of transmitted packets
Definition at line 10930 of file ConfigurationObjects.h.
| RallypointUdpStreaming AppConfigurationObjects::RallypointServer::udpStreaming |
Optional configuration for high-performance UDP streaming.
Definition at line 10879 of file ConfigurationObjects.h.
| WatchdogSettings AppConfigurationObjects::RallypointServer::watchdog |
[Optional] Settings for the Rallypoint's watchdog.
Definition at line 10759 of file ConfigurationObjects.h.
| RallypointWebsocketSettings AppConfigurationObjects::RallypointServer::websocket |
[Optional] Settings for websocket operation
Definition at line 10912 of file ConfigurationObjects.h.