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

Rallypoint. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

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 5000] 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
 
- 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 2574 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ Rallypoint()

AppConfigurationObjects::Rallypoint::Rallypoint ( )
inline

Definition at line 2644 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::Rallypoint::clear ( )
inline

Definition at line 2649 of file ConfigurationObjects.h.

◆ matches()

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

Definition at line 2662 of file ConfigurationObjects.h.

Member Data Documentation

◆ allowSelfSignedCertificate

bool AppConfigurationObjects::Rallypoint::allowSelfSignedCertificate

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

Definition at line 2621 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 2626 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 2598 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 2611 of file ConfigurationObjects.h.

◆ connectionTimeoutSecs

int AppConfigurationObjects::Rallypoint::connectionTimeoutSecs

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

Definition at line 2639 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 2636 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 2585 of file ConfigurationObjects.h.

◆ tcpTxOptions

TcpNetworkTxOptions AppConfigurationObjects::Rallypoint::tcpTxOptions

[Optional] Tx options for the TCP link

Definition at line 2642 of file ConfigurationObjects.h.

◆ transactionTimeoutMs

int AppConfigurationObjects::Rallypoint::transactionTimeoutMs

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

Definition at line 2631 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 2616 of file ConfigurationObjects.h.


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