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

TODO: Configuration to enable external systems to use to check if the service is still running. 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

int listenPort
 
bool immediateClose
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

TODO: Configuration to enable external systems to use to check if the service is still running.

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

Example:

See also
RallypointServer

Definition at line 7966 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ ExternalHealthCheckResponder()

AppConfigurationObjects::ExternalHealthCheckResponder::ExternalHealthCheckResponder ( )
inline

Definition at line 7979 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::ExternalHealthCheckResponder::clear ( )
inline

Definition at line 7984 of file ConfigurationObjects.h.

Member Data Documentation

◆ immediateClose

bool AppConfigurationObjects::ExternalHealthCheckResponder::immediateClose

[Optional, Default: true] If true, closes the inbound socket connection immediately.

Definition at line 7977 of file ConfigurationObjects.h.

◆ listenPort

int AppConfigurationObjects::ExternalHealthCheckResponder::listenPort

The network port to listen on for connections

Definition at line 7974 of file ConfigurationObjects.h.


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