AppConfigurationObjects::RallypointPeer Class Reference

RTS internal use. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types
enum	OutboundLeafPolicy_t { olpUseRpConfiguration = 0 , olpIsMeshLeaf = 1 , olpNotMeshLeaf = 2 }
enum	OutboundWebSocketTlsPolicy_t { olpUseRpWebSocketTlsConfiguration = 0 , olpUseTlsForWebSocket = 1 , olpDoNotUseTlsForWebSocket = 2 }

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
	Internal ID.
bool	enabled
	Internal enablement setting.
NetworkAddress	host
	Internal host detail.
SecurityCertificate	certificate
	Internal certificate detail.
int	connectionTimeoutSecs
	[Optional, Default: 0 - OS platform default] Connection timeout in seconds to the peer
bool	forceIsMeshLeaf
	Internal enablement setting.
OutboundLeafPolicy_t	outboundLeafPolicy
Rallypoint::RpProtocol_t	protocol
	[Optional, Default: Rallypoint::RpProtocol_t::rppTlsTcp] Protocol to use for the peer
std::string	path
	[Optional, Default: ""] Path to use for the peer (only used for WebSocket)
std::string	additionalProtocols
	[Optional, Default: ""] Additional protocols to use for the peer (only used for WebSocket)
std::string	sni
	[Optional] A user-defined string sent as the Server Name Indication (SNI) field in the TLS setup when connecting to this peer. Must match an additionalIdentities name on the far-end Rallypoint to select a non-default server certificate. Be aware that this data is sent in the clear in the client hello message.
OutboundWebSocketTlsPolicy_t	outboundWebSocketTlsPolicy
	Internal enablement setting.
Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json	_attached

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

Detailed Description

RTS internal use.

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

Example:

{
   "certificate": {
      "certificate": "",
      "key": ""
   },
   "enabled": true,
   "host": {
      "address": "",
      "port": 0
   },
   "id": "",
   "sni": ""
}

See also

RallypointServer

Definition at line 8392 of file ConfigurationObjects.h.

Member Enumeration Documentation

OutboundLeafPolicy_t

enum AppConfigurationObjects::RallypointPeer::OutboundLeafPolicy_t

Enumerator
olpUseRpConfiguration	Use the RP's configuration.
olpIsMeshLeaf	Mark as a domain leaf.
olpNotMeshLeaf	Do not mark as a domain leaf.

Definition at line 8398 of file ConfigurationObjects.h.

OutboundWebSocketTlsPolicy_t

enum AppConfigurationObjects::RallypointPeer::OutboundWebSocketTlsPolicy_t

Enumerator
olpUseRpWebSocketTlsConfiguration	Use the RP's configuration.
olpUseTlsForWebSocket	Use TLS for WebSocket connections.
olpDoNotUseTlsForWebSocket	Do not use TLS for WebSocket connections.

Definition at line 8410 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

RallypointPeer()

AppConfigurationObjects::RallypointPeer::RallypointPeer ( )

inline

Definition at line 8462 of file ConfigurationObjects.h.

Member Function Documentation

clear()

void AppConfigurationObjects::RallypointPeer::clear ( )

inline

Definition at line 8467 of file ConfigurationObjects.h.

Member Data Documentation

additionalProtocols

std::string AppConfigurationObjects::RallypointPeer::additionalProtocols

[Optional, Default: ""] Additional protocols to use for the peer (only used for WebSocket)

Definition at line 8449 of file ConfigurationObjects.h.

certificate

SecurityCertificate AppConfigurationObjects::RallypointPeer::certificate

Internal certificate detail.

Definition at line 8432 of file ConfigurationObjects.h.

connectionTimeoutSecs

int AppConfigurationObjects::RallypointPeer::connectionTimeoutSecs

[Optional, Default: 0 - OS platform default] Connection timeout in seconds to the peer

Definition at line 8435 of file ConfigurationObjects.h.

enabled

bool AppConfigurationObjects::RallypointPeer::enabled

Internal enablement setting.

Definition at line 8426 of file ConfigurationObjects.h.

forceIsMeshLeaf

bool AppConfigurationObjects::RallypointPeer::forceIsMeshLeaf

Internal enablement setting.

Definition at line 8438 of file ConfigurationObjects.h.

host

NetworkAddress AppConfigurationObjects::RallypointPeer::host

Internal host detail.

Definition at line 8429 of file ConfigurationObjects.h.

id

std::string AppConfigurationObjects::RallypointPeer::id

Internal ID.

Definition at line 8423 of file ConfigurationObjects.h.

outboundLeafPolicy

OutboundLeafPolicy_t AppConfigurationObjects::RallypointPeer::outboundLeafPolicy

Definition at line 8440 of file ConfigurationObjects.h.

outboundWebSocketTlsPolicy

OutboundWebSocketTlsPolicy_t AppConfigurationObjects::RallypointPeer::outboundWebSocketTlsPolicy

Internal enablement setting.

Definition at line 8460 of file ConfigurationObjects.h.

path

std::string AppConfigurationObjects::RallypointPeer::path

[Optional, Default: ""] Path to use for the peer (only used for WebSocket)

Definition at line 8446 of file ConfigurationObjects.h.

protocol

Rallypoint::RpProtocol_t AppConfigurationObjects::RallypointPeer::protocol

[Optional, Default: Rallypoint::RpProtocol_t::rppTlsTcp] Protocol to use for the peer

Definition at line 8443 of file ConfigurationObjects.h.

sni

std::string AppConfigurationObjects::RallypointPeer::sni

[Optional] A user-defined string sent as the Server Name Indication (SNI) field in the TLS setup when connecting to this peer. Must match an additionalIdentities name on the far-end Rallypoint to select a non-default server certificate. Be aware that this data is sent in the clear in the client hello message.

Definition at line 8457 of file ConfigurationObjects.h.

---

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

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