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

Configuration for the linguistics 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

std::string id
 A unqiue identifier for the linguistics server.
 
int serviceConfigurationFileCheckSecs
 Number of seconds between checks to see if the service configuration has been updated. Default is 60.
 
std::string lingoConfigurationFileName
 Name of a file containing the linguistics configuration.
 
std::string lingoConfigurationFileCommand
 Command-line to execute that returns a linguistics configuration.
 
int lingoConfigurationFileCheckSecs
 Number of seconds between checks to see if the linguistics configuration has been updated. Default is 60.
 
LingoServerStatusReportConfiguration 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.
 
LingoServerInternals 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.
 
NetworkAddress proxy
 Address and port of the proxy.
 
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 linguistics server.

Helper C++ class to serialize and de-serialize LingoServerConfiguration JSON

Example:

Definition at line 10703 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ LingoServerConfiguration()

AppConfigurationObjects::LingoServerConfiguration::LingoServerConfiguration ( )
inline

Definition at line 10754 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::LingoServerConfiguration::clear ( )
inline

Definition at line 10759 of file ConfigurationObjects.h.

Member Data Documentation

◆ certStoreFileName

std::string AppConfigurationObjects::LingoServerConfiguration::certStoreFileName

Path to the certificate store.

Definition at line 10734 of file ConfigurationObjects.h.

◆ certStorePasswordHex

std::string AppConfigurationObjects::LingoServerConfiguration::certStorePasswordHex

Hex password for the certificate store (if any)

Definition at line 10737 of file ConfigurationObjects.h.

◆ configurationCheckSignalName

std::string AppConfigurationObjects::LingoServerConfiguration::configurationCheckSignalName

Name to use for signalling a configuration check.

Definition at line 10743 of file ConfigurationObjects.h.

◆ enginePolicy

EnginePolicy AppConfigurationObjects::LingoServerConfiguration::enginePolicy

The policy to be used for the underlying Engage Engine.

Definition at line 10740 of file ConfigurationObjects.h.

◆ externalHealthCheckResponder

ExternalHealthCheckResponder AppConfigurationObjects::LingoServerConfiguration::externalHealthCheckResponder

Details concerning the server's interaction with an external health-checker such as a load-balancer.

See also
ExternalHealthCheckResponder

Definition at line 10728 of file ConfigurationObjects.h.

◆ fipsCrypto

FipsCryptoSettings AppConfigurationObjects::LingoServerConfiguration::fipsCrypto

[Optional] Settings for the FIPS crypto.

Definition at line 10746 of file ConfigurationObjects.h.

◆ id

std::string AppConfigurationObjects::LingoServerConfiguration::id

A unqiue identifier for the linguistics server.

Definition at line 10710 of file ConfigurationObjects.h.

◆ internals

LingoServerInternals AppConfigurationObjects::LingoServerConfiguration::internals

Internal settings.

Definition at line 10731 of file ConfigurationObjects.h.

◆ lingoConfigurationFileCheckSecs

int AppConfigurationObjects::LingoServerConfiguration::lingoConfigurationFileCheckSecs

Number of seconds between checks to see if the linguistics configuration has been updated. Default is 60.

Definition at line 10722 of file ConfigurationObjects.h.

◆ lingoConfigurationFileCommand

std::string AppConfigurationObjects::LingoServerConfiguration::lingoConfigurationFileCommand

Command-line to execute that returns a linguistics configuration.

Definition at line 10719 of file ConfigurationObjects.h.

◆ lingoConfigurationFileName

std::string AppConfigurationObjects::LingoServerConfiguration::lingoConfigurationFileName

Name of a file containing the linguistics configuration.

Definition at line 10716 of file ConfigurationObjects.h.

◆ nsm

NsmConfiguration AppConfigurationObjects::LingoServerConfiguration::nsm

[Optional] Settings for NSM.

Definition at line 10752 of file ConfigurationObjects.h.

◆ proxy

NetworkAddress AppConfigurationObjects::LingoServerConfiguration::proxy

Address and port of the proxy.

Definition at line 10749 of file ConfigurationObjects.h.

◆ serviceConfigurationFileCheckSecs

int AppConfigurationObjects::LingoServerConfiguration::serviceConfigurationFileCheckSecs

Number of seconds between checks to see if the service configuration has been updated. Default is 60.

Definition at line 10713 of file ConfigurationObjects.h.

◆ statusReport

LingoServerStatusReportConfiguration AppConfigurationObjects::LingoServerConfiguration::statusReport

Details for producing a status report.

See also
LingoServerStatusReportConfiguration

Definition at line 10725 of file ConfigurationObjects.h.


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