Engage Engine API  1.244.9084
Loading...
Searching...
No Matches
AppConfigurationObjects::EngageSemServerConfiguration Class Reference

Configuration for the EFC 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 EFC server.
 
int serviceConfigurationFileCheckSecs
 Number of seconds between checks to see if the service configuration has been updated. Default is 60.
 
std::string groupsConfigurationFileName
 Name of a file containing the EFC configuration.
 
std::string groupsConfigurationFileCommand
 Command-line to execute that returns a configuration.
 
int groupsConfigurationFileCheckSecs
 Number of seconds between checks to see if the configuration has been updated. Default is 60.
 
EngageSemServerStatusReportConfiguration 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.
 
EngageSemServerInternals 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.
 
int maxQueueLen
 
int minQueuingMs
 
int maxQueuingMs
 
int minPriority
 
int maxPriority
 
- 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 EFC server.

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

Example:

Definition at line 11417 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ EngageSemServerConfiguration()

AppConfigurationObjects::EngageSemServerConfiguration::EngageSemServerConfiguration ( )
inline

Definition at line 11472 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::EngageSemServerConfiguration::clear ( )
inline

Definition at line 11477 of file ConfigurationObjects.h.

Member Data Documentation

◆ certStoreFileName

std::string AppConfigurationObjects::EngageSemServerConfiguration::certStoreFileName

Path to the certificate store.

Definition at line 11449 of file ConfigurationObjects.h.

◆ certStorePasswordHex

std::string AppConfigurationObjects::EngageSemServerConfiguration::certStorePasswordHex

Hex password for the certificate store (if any)

Definition at line 11452 of file ConfigurationObjects.h.

◆ configurationCheckSignalName

std::string AppConfigurationObjects::EngageSemServerConfiguration::configurationCheckSignalName

Name to use for signalling a configuration check.

Definition at line 11458 of file ConfigurationObjects.h.

◆ enginePolicy

EnginePolicy AppConfigurationObjects::EngageSemServerConfiguration::enginePolicy

The policy to be used for the underlying Engage Engine.

Definition at line 11455 of file ConfigurationObjects.h.

◆ externalHealthCheckResponder

ExternalHealthCheckResponder AppConfigurationObjects::EngageSemServerConfiguration::externalHealthCheckResponder

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

See also
ExternalHealthCheckResponder

Definition at line 11443 of file ConfigurationObjects.h.

◆ fipsCrypto

FipsCryptoSettings AppConfigurationObjects::EngageSemServerConfiguration::fipsCrypto

[Optional] Settings for the FIPS crypto.

Definition at line 11461 of file ConfigurationObjects.h.

◆ groupsConfigurationFileCheckSecs

int AppConfigurationObjects::EngageSemServerConfiguration::groupsConfigurationFileCheckSecs

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

Definition at line 11437 of file ConfigurationObjects.h.

◆ groupsConfigurationFileCommand

std::string AppConfigurationObjects::EngageSemServerConfiguration::groupsConfigurationFileCommand

Command-line to execute that returns a configuration.

Definition at line 11434 of file ConfigurationObjects.h.

◆ groupsConfigurationFileName

std::string AppConfigurationObjects::EngageSemServerConfiguration::groupsConfigurationFileName

Name of a file containing the EFC configuration.

Definition at line 11431 of file ConfigurationObjects.h.

◆ id

std::string AppConfigurationObjects::EngageSemServerConfiguration::id

A unqiue identifier for the EFC server.

Definition at line 11425 of file ConfigurationObjects.h.

◆ internals

EngageSemServerInternals AppConfigurationObjects::EngageSemServerConfiguration::internals

Internal settings.

Definition at line 11446 of file ConfigurationObjects.h.

◆ maxPriority

int AppConfigurationObjects::EngageSemServerConfiguration::maxPriority

Definition at line 11470 of file ConfigurationObjects.h.

◆ maxQueueLen

int AppConfigurationObjects::EngageSemServerConfiguration::maxQueueLen

Definition at line 11466 of file ConfigurationObjects.h.

◆ maxQueuingMs

int AppConfigurationObjects::EngageSemServerConfiguration::maxQueuingMs

Definition at line 11468 of file ConfigurationObjects.h.

◆ minPriority

int AppConfigurationObjects::EngageSemServerConfiguration::minPriority

Definition at line 11469 of file ConfigurationObjects.h.

◆ minQueuingMs

int AppConfigurationObjects::EngageSemServerConfiguration::minQueuingMs

Definition at line 11467 of file ConfigurationObjects.h.

◆ nsm

NsmConfiguration AppConfigurationObjects::EngageSemServerConfiguration::nsm

[Optional] Settings for NSM.

Definition at line 11464 of file ConfigurationObjects.h.

◆ serviceConfigurationFileCheckSecs

int AppConfigurationObjects::EngageSemServerConfiguration::serviceConfigurationFileCheckSecs

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

Definition at line 11428 of file ConfigurationObjects.h.

◆ statusReport

EngageSemServerStatusReportConfiguration AppConfigurationObjects::EngageSemServerConfiguration::statusReport

Details for producing a status report.

See also
EngageSemServerStatusReportConfiguration

Definition at line 11440 of file ConfigurationObjects.h.


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