#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types
enum	RpProtocol_t { rppTlsTcp = 0 , rppTlsWs = 1 , rppQuic = 2 , rppInvalid = -1 }
	RP protocol enum. More...

Public Member Functions
void	clear ()

bool	matches (const Rallypoint &other)

Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase
virtual void	initForDocumenting ()

virtual std::string	toString ()

virtual bool	isDocumenting () const

Public Attributes
NetworkAddress	host
	This is the host address for the Engine to connect to the RallyPoint service.

std::string	certificate
	This is the X509 certificate to use for mutual authentication.

std::string	certificateKey
	This is the private key used to generate the X509 certificate.

bool	verifyPeer
	[Optional, Default true] Indicates whether the connection peer is to be verified by checking the validaity of its X.509 certificate.

bool	allowSelfSignedCertificate
	[Optional, Default false] Allows the Rallypoint to accept self-signed certificates from the far-end

std::vector< std::string >	caCertificates
	[Optional] A vector of certificates (raw content, file names, or certificate store elements) used to verify far-end X.509 certificates.

int	transactionTimeoutMs
	[Optional, Default 10000] Number of milliseconds that a transaction may take before the link is considered broken.

bool	disableMessageSigning
	[Optional, Default false] Indicates whether to forego ECSDA signing of control-plane messages.

int	connectionTimeoutSecs
	[Optional, Default: 5] Connection timeout in seconds to the RP

TcpNetworkTxOptions	tcpTxOptions
	[Optional] Tx options for the TCP link

std::string	sni
	[Optional] A user-defined string sent as the Server Name Indication (SNI) field in the TLS setup. Be aware that this data is sent in the clear in the client hello message.

RpProtocol_t	protocol
	[Optional, Default: rppTlsTcp] Specifies the protocol to be used for the Rallypoint connection. See RpProtocol_t for all protocol types

std::string	path
	[Optional, Default: ""] Path to use for the RP connection (only used for WebSocket)

std::string	additionalProtocols
	[Optional, Default: ""] Additional protocols to use for the Rallypoint connection (only used for WebSocket)

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

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

Detailed Description

Rallypoint.

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

Example:

{
   "allowSelfSignedCertificate": true,
   "caCertificates": [],
   "certificate": "",
   "certificateKey": "",
   "host": {
      "address": "",
      "port": 0
   },
   "verifyPeer": false
}

Definition at line 2927 of file ConfigurationObjects.h.

Member Enumeration Documentation

◆ RpProtocol_t

enum AppConfigurationObjects::Rallypoint::RpProtocol_t

RP protocol enum.

Enumerator
rppTlsTcp	[Default] TLS over TCP
rppTlsWs	WebSocket over TLS.
rppQuic	QUIC (TLS 1.3 over UDP, one reliable stream)
rppInvalid	Invalid.

Definition at line 2937 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ Rallypoint()

AppConfigurationObjects::Rallypoint::Rallypoint ( )

inline

Definition at line 3033 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::Rallypoint::clear ( )

inline

Definition at line 3038 of file ConfigurationObjects.h.

◆ matches()

bool AppConfigurationObjects::Rallypoint::matches ( const Rallypoint & other )

inline

Definition at line 3055 of file ConfigurationObjects.h.

Member Data Documentation

◆ additionalProtocols

std::string AppConfigurationObjects::Rallypoint::additionalProtocols

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

Definition at line 3030 of file ConfigurationObjects.h.

◆ allowSelfSignedCertificate

bool AppConfigurationObjects::Rallypoint::allowSelfSignedCertificate

[Optional, Default false] Allows the Rallypoint to accept self-signed certificates from the far-end

Definition at line 2992 of file ConfigurationObjects.h.

◆ caCertificates

std::vector<std::string> AppConfigurationObjects::Rallypoint::caCertificates

[Optional] A vector of certificates (raw content, file names, or certificate store elements) used to verify far-end X.509 certificates.

Definition at line 2997 of file ConfigurationObjects.h.

◆ certificate

std::string AppConfigurationObjects::Rallypoint::certificate

This is the X509 certificate to use for mutual authentication.

The full contents of the cert can be specified or the file path to where the cert is located can be specified by using an @ replacement string e.g

certificate="@/privatestore/certs/rp_cert.pem"

Definition at line 2969 of file ConfigurationObjects.h.

◆ certificateKey

std::string AppConfigurationObjects::Rallypoint::certificateKey

This is the private key used to generate the X509 certificate.

The full contents of the key can be specified or the file path to where the key is located can be specified by using an @ replacement string e.g

certificate="@/privatestore/certs/rp_private_key.key"

Definition at line 2982 of file ConfigurationObjects.h.

◆ connectionTimeoutSecs

int AppConfigurationObjects::Rallypoint::connectionTimeoutSecs

[Optional, Default: 5] Connection timeout in seconds to the RP

Definition at line 3010 of file ConfigurationObjects.h.

◆ disableMessageSigning

bool AppConfigurationObjects::Rallypoint::disableMessageSigning

[Optional, Default false] Indicates whether to forego ECSDA signing of control-plane messages.

Definition at line 3007 of file ConfigurationObjects.h.

◆ host

NetworkAddress AppConfigurationObjects::Rallypoint::host

This is the host address for the Engine to connect to the RallyPoint service.

Definition at line 2956 of file ConfigurationObjects.h.

◆ path

std::string AppConfigurationObjects::Rallypoint::path

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

Definition at line 3027 of file ConfigurationObjects.h.

◆ protocol

RpProtocol_t AppConfigurationObjects::Rallypoint::protocol

[Optional, Default: rppTlsTcp] Specifies the protocol to be used for the Rallypoint connection. See RpProtocol_t for all protocol types

Definition at line 3024 of file ConfigurationObjects.h.

◆ sni

std::string AppConfigurationObjects::Rallypoint::sni

[Optional] A user-defined string sent as the Server Name Indication (SNI) field in the TLS setup. Be aware that this data is sent in the clear in the client hello message.

Definition at line 3020 of file ConfigurationObjects.h.

◆ tcpTxOptions

TcpNetworkTxOptions AppConfigurationObjects::Rallypoint::tcpTxOptions

[Optional] Tx options for the TCP link

Definition at line 3013 of file ConfigurationObjects.h.

◆ transactionTimeoutMs

int AppConfigurationObjects::Rallypoint::transactionTimeoutMs

[Optional, Default 10000] Number of milliseconds that a transaction may take before the link is considered broken.

Definition at line 3002 of file ConfigurationObjects.h.

◆ verifyPeer

bool AppConfigurationObjects::Rallypoint::verifyPeer

[Optional, Default true] Indicates whether the connection peer is to be verified by checking the validaity of its X.509 certificate.

Definition at line 2987 of file ConfigurationObjects.h.

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

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

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ RpProtocol_t

Constructor & Destructor Documentation

◆ Rallypoint()

Member Function Documentation

◆ clear()

◆ matches()

Member Data Documentation

◆ additionalProtocols

◆ allowSelfSignedCertificate

◆ caCertificates

◆ certificate

◆ certificateKey

◆ connectionTimeoutSecs

◆ disableMessageSigning

◆ host

◆ path

◆ protocol

◆ sni

◆ tcpTxOptions

◆ transactionTimeoutMs

◆ verifyPeer