Engage Engine API  1.246.9086
Loading...
Searching...
No Matches
AppConfigurationObjects::BridgingServerConfiguration Class Reference

Configuration for the bridging server. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types

enum  OpMode_t { omRaw = 0 , omPayloadTransformation = 1 , omAnonymousMixing = 2 , omLanguageTranslation = 3 }
 Enum describing the modes the briging service runs in. 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 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.
 
NsmConfiguration nsm
 [Optional] Settings for NSM.
 
- 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 11125 of file ConfigurationObjects.h.

Member Enumeration Documentation

◆ OpMode_t

Enum describing the modes the briging service runs in.

Enumerator
omRaw 

Raw mode (default) - packet payloads are not accessed or modified and forwarded as raw packets.

omPayloadTransformation 

Audio payloads are transformed, headers are preserved, multiple parallel output streams are possible/expected.

omAnonymousMixing 

Audio payloads are mixed - output is anonymous (i.e. no metadata) if if the target group(s) allow header extensions.

omLanguageTranslation 

Audio payloads are translated between group-specific languages.

Definition at line 11132 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ BridgingServerConfiguration()

AppConfigurationObjects::BridgingServerConfiguration::BridgingServerConfiguration ( )
inline

Definition at line 11192 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::BridgingServerConfiguration::clear ( )
inline

Definition at line 11197 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 11163 of file ConfigurationObjects.h.

◆ bridgingConfigurationFileCommand

std::string AppConfigurationObjects::BridgingServerConfiguration::bridgingConfigurationFileCommand

Command-line to execute that returns a bridging configuration.

Definition at line 11160 of file ConfigurationObjects.h.

◆ bridgingConfigurationFileName

std::string AppConfigurationObjects::BridgingServerConfiguration::bridgingConfigurationFileName

Name of a file containing the bridging configuration.

Definition at line 11157 of file ConfigurationObjects.h.

◆ certStoreFileName

std::string AppConfigurationObjects::BridgingServerConfiguration::certStoreFileName

Path to the certificate store.

Definition at line 11175 of file ConfigurationObjects.h.

◆ certStorePasswordHex

std::string AppConfigurationObjects::BridgingServerConfiguration::certStorePasswordHex

Hex password for the certificate store (if any)

Definition at line 11178 of file ConfigurationObjects.h.

◆ configurationCheckSignalName

std::string AppConfigurationObjects::BridgingServerConfiguration::configurationCheckSignalName

Name to use for signalling a configuration check.

Definition at line 11184 of file ConfigurationObjects.h.

◆ enginePolicy

EnginePolicy AppConfigurationObjects::BridgingServerConfiguration::enginePolicy

The policy to be used for the underlying Engage Engine.

Definition at line 11181 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 11169 of file ConfigurationObjects.h.

◆ fipsCrypto

FipsCryptoSettings AppConfigurationObjects::BridgingServerConfiguration::fipsCrypto

[Optional] Settings for the FIPS crypto.

Definition at line 11187 of file ConfigurationObjects.h.

◆ id

std::string AppConfigurationObjects::BridgingServerConfiguration::id

A unqiue identifier for the bridge server.

Definition at line 11148 of file ConfigurationObjects.h.

◆ internals

BridgingServerInternals AppConfigurationObjects::BridgingServerConfiguration::internals

Internal settings.

Definition at line 11172 of file ConfigurationObjects.h.

◆ mode

OpMode_t AppConfigurationObjects::BridgingServerConfiguration::mode

Specifies the operation mode (see OpMode_t).

Definition at line 11151 of file ConfigurationObjects.h.

◆ nsm

NsmConfiguration AppConfigurationObjects::BridgingServerConfiguration::nsm

[Optional] Settings for NSM.

Definition at line 11190 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 11154 of file ConfigurationObjects.h.

◆ statusReport

BridgingServerStatusReportConfiguration AppConfigurationObjects::BridgingServerConfiguration::statusReport

Details for producing a status report.

See also
BridgingServerStatusReportConfiguration

Definition at line 11166 of file ConfigurationObjects.h.


The documentation for this class was generated from the following file: