Defines settings for Rallypoint websockets functionality. 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
bool	enabled
	[Default: false] Websocket is enabled

int	listenPort
	Listen port (TCP). Default is 8443.

SecurityCertificate	certificate
	Certificate to be used for WebSockets.

bool	requireClientCertificate
	[Default: false] Indicates whether the client is required to present a certificate

bool	requireTls
	[Default: false] Indicates whether TLS is required

Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json	_attached

Additional Inherited Members
Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool	_documenting

Detailed Description

Defines settings for Rallypoint websockets functionality.

Example:

Definition at line 9010 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ RallypointWebsocketSettings()

AppConfigurationObjects::RallypointWebsocketSettings::RallypointWebsocketSettings ( )

inline

Definition at line 9031 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::RallypointWebsocketSettings::clear ( )

inline

Definition at line 9036 of file ConfigurationObjects.h.

Member Data Documentation

◆ certificate

SecurityCertificate AppConfigurationObjects::RallypointWebsocketSettings::certificate

Certificate to be used for WebSockets.

Definition at line 9023 of file ConfigurationObjects.h.

◆ enabled

bool AppConfigurationObjects::RallypointWebsocketSettings::enabled

[Default: false] Websocket is enabled

Definition at line 9017 of file ConfigurationObjects.h.

◆ listenPort

int AppConfigurationObjects::RallypointWebsocketSettings::listenPort

Listen port (TCP). Default is 8443.

Definition at line 9020 of file ConfigurationObjects.h.

◆ requireClientCertificate

bool AppConfigurationObjects::RallypointWebsocketSettings::requireClientCertificate

[Default: false] Indicates whether the client is required to present a certificate

Definition at line 9026 of file ConfigurationObjects.h.

◆ requireTls

bool AppConfigurationObjects::RallypointWebsocketSettings::requireTls

[Default: false] Indicates whether TLS is required

Definition at line 9029 of file ConfigurationObjects.h.

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

engage/src/api/c/include/ConfigurationObjects.h

Public Member Functions

Public Attributes

Additional Inherited Members