Configuration for the bridging server. More...
#include <ConfigurationObjects.h>
Inherits AppConfigurationObjects::ConfigurationObjectBase.
Public Types | |
| enum | OpMode_t { omRaw = 0 , omMultistream = 1 , omMixedStream = 2 , omADictatedByGroup = 3 } |
| Enum describing the default mode the bridging service runs in. Values of omRaw, omMultistream, omAnonymousMixedStream all cause the service to force the groups in a bridge to the appropriate type. A value of omADictatedByGroup prevents the service from forcing the individual groups' "type" and "bom" values and instead relies on the individual groups to be correctly defined in the configuration. More... | |
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 | |
| std::string | id |
| A unqiue identifier for the bridge server. | |
| OpMode_t | mode |
| Specifies the default operation mode (see OpMode_t). | |
| int | serviceConfigurationFileCheckSecs |
| Number of seconds between checks to see if the service configuration has been updated. Default is 60. | |
| std::string | bridgingConfigurationFileName |
| Name of a file containing the bridging configuration. | |
| std::string | bridgingConfigurationFileCommand |
| Command-line to execute that returns a bridging configuration. | |
| int | bridgingConfigurationFileCheckSecs |
| Number of seconds between checks to see if the bridging configuration has been updated. Default is 60. | |
| BridgingServerStatusReportConfiguration | statusReport |
| Details for producing a status report. | |
| ExternalHealthCheckResponder | externalHealthCheckResponder |
| Details concerning the server's interaction with an external health-checker such as a load-balancer. | |
| BridgingServerInternals | internals |
| Internal settings. | |
| std::string | certStoreFileName |
| Path to the certificate store. | |
| std::string | certStorePasswordHex |
| Hex password for the certificate store (if any) | |
| EnginePolicy | enginePolicy |
| The policy to be used for the underlying Engage Engine. | |
| std::string | configurationCheckSignalName |
| Name to use for signalling a configuration check. | |
| FipsCryptoSettings | fipsCrypto |
| [Optional] Settings for the FIPS crypto. | |
| NsmNode | nsmNode |
| [Optional] Settings for embedded NSM node behavior. | |
| RtiCloudSettings | rtiCloud |
| [Optional] Rally Tactical cloud (RTI) integration. | |
| Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase | |
| nlohmann::json | _attached |
Additional Inherited Members | |
| Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase | |
| bool | _documenting |
Detailed Description
Configuration for the bridging server.
Helper C++ class to serialize and de-serialize BridgingServerConfiguration JSON
Example:
Definition at line 12617 of file ConfigurationObjects.h.
Member Enumeration Documentation
◆ OpMode_t
Enum describing the default mode the bridging service runs in. Values of omRaw, omMultistream, omAnonymousMixedStream all cause the service to force the groups in a bridge to the appropriate type. A value of omADictatedByGroup prevents the service from forcing the individual groups' "type" and "bom" values and instead relies on the individual groups to be correctly defined in the configuration.
| Enumerator | |
|---|---|
| omRaw | Raw mode (default) - packet payloads are not accessed or modified and forwarded as raw packets. |
| omMultistream | Audio payloads are transformed, headers are preserved, multiple parallel output streams are possible/expected. In this mode all groups must be gtAudio (type = 1). |
| omMixedStream | Audio payloads are mixed - output is anonymous (i.e. no metadata) even if the target group(s) allow header extensions. In this mode all groups must be gtAudio (type = 1). |
| omADictatedByGroup | Operation is dictated by the individual groups in the bridge. |
Definition at line 12629 of file ConfigurationObjects.h.
Constructor & Destructor Documentation
◆ BridgingServerConfiguration()
|
inline |
Definition at line 12694 of file ConfigurationObjects.h.
Member Function Documentation
◆ clear()
|
inline |
Definition at line 12699 of file ConfigurationObjects.h.
Member Data Documentation
◆ bridgingConfigurationFileCheckSecs
| int AppConfigurationObjects::BridgingServerConfiguration::bridgingConfigurationFileCheckSecs |
Number of seconds between checks to see if the bridging configuration has been updated. Default is 60.
Definition at line 12662 of file ConfigurationObjects.h.
◆ bridgingConfigurationFileCommand
| std::string AppConfigurationObjects::BridgingServerConfiguration::bridgingConfigurationFileCommand |
Command-line to execute that returns a bridging configuration.
Definition at line 12659 of file ConfigurationObjects.h.
◆ bridgingConfigurationFileName
| std::string AppConfigurationObjects::BridgingServerConfiguration::bridgingConfigurationFileName |
Name of a file containing the bridging configuration.
Definition at line 12656 of file ConfigurationObjects.h.
◆ certStoreFileName
| std::string AppConfigurationObjects::BridgingServerConfiguration::certStoreFileName |
Path to the certificate store.
Definition at line 12674 of file ConfigurationObjects.h.
◆ certStorePasswordHex
| std::string AppConfigurationObjects::BridgingServerConfiguration::certStorePasswordHex |
Hex password for the certificate store (if any)
Definition at line 12677 of file ConfigurationObjects.h.
◆ configurationCheckSignalName
| std::string AppConfigurationObjects::BridgingServerConfiguration::configurationCheckSignalName |
Name to use for signalling a configuration check.
Definition at line 12683 of file ConfigurationObjects.h.
◆ enginePolicy
| EnginePolicy AppConfigurationObjects::BridgingServerConfiguration::enginePolicy |
The policy to be used for the underlying Engage Engine.
Definition at line 12680 of file ConfigurationObjects.h.
◆ externalHealthCheckResponder
| ExternalHealthCheckResponder AppConfigurationObjects::BridgingServerConfiguration::externalHealthCheckResponder |
Details concerning the server's interaction with an external health-checker such as a load-balancer.
- See also
- ExternalHealthCheckResponder
Definition at line 12668 of file ConfigurationObjects.h.
◆ fipsCrypto
| FipsCryptoSettings AppConfigurationObjects::BridgingServerConfiguration::fipsCrypto |
[Optional] Settings for the FIPS crypto.
Definition at line 12686 of file ConfigurationObjects.h.
◆ id
| std::string AppConfigurationObjects::BridgingServerConfiguration::id |
A unqiue identifier for the bridge server.
Definition at line 12647 of file ConfigurationObjects.h.
◆ internals
| BridgingServerInternals AppConfigurationObjects::BridgingServerConfiguration::internals |
Internal settings.
Definition at line 12671 of file ConfigurationObjects.h.
◆ mode
| OpMode_t AppConfigurationObjects::BridgingServerConfiguration::mode |
Specifies the default operation mode (see OpMode_t).
Definition at line 12650 of file ConfigurationObjects.h.
◆ nsmNode
| NsmNode AppConfigurationObjects::BridgingServerConfiguration::nsmNode |
[Optional] Settings for embedded NSM node behavior.
Definition at line 12689 of file ConfigurationObjects.h.
◆ rtiCloud
| RtiCloudSettings AppConfigurationObjects::BridgingServerConfiguration::rtiCloud |
[Optional] Rally Tactical cloud (RTI) integration.
Definition at line 12692 of file ConfigurationObjects.h.
◆ serviceConfigurationFileCheckSecs
| int AppConfigurationObjects::BridgingServerConfiguration::serviceConfigurationFileCheckSecs |
Number of seconds between checks to see if the service configuration has been updated. Default is 60.
Definition at line 12653 of file ConfigurationObjects.h.
◆ statusReport
| BridgingServerStatusReportConfiguration AppConfigurationObjects::BridgingServerConfiguration::statusReport |
Details for producing a status report.
Definition at line 12665 of file ConfigurationObjects.h.
The documentation for this class was generated from the following file:
- engage/src/api/c/include/ConfigurationObjects.h
