RTS internal use. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types
enum	OutboundLeafPolicy_t { olpUseRpConfiguration = 0 , olpIsMeshLeaf = 1 , olpNotMeshLeaf = 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)

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": ""
}

See also: RallypointServer

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

Constructor & Destructor Documentation

◆ RallypointPeer()

AppConfigurationObjects::RallypointPeer::RallypointPeer ( )

inline

Definition at line 8045 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::RallypointPeer::clear ( )

inline

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

◆ certificate

SecurityCertificate AppConfigurationObjects::RallypointPeer::certificate

Internal certificate detail.

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

◆ enabled

bool AppConfigurationObjects::RallypointPeer::enabled

Internal enablement setting.

Definition at line 8020 of file ConfigurationObjects.h.

◆ forceIsMeshLeaf

bool AppConfigurationObjects::RallypointPeer::forceIsMeshLeaf

Internal enablement setting.

Definition at line 8032 of file ConfigurationObjects.h.

◆ host

NetworkAddress AppConfigurationObjects::RallypointPeer::host

Internal host detail.

Definition at line 8023 of file ConfigurationObjects.h.

◆ id

std::string AppConfigurationObjects::RallypointPeer::id

Internal ID.

Definition at line 8017 of file ConfigurationObjects.h.

◆ outboundLeafPolicy

OutboundLeafPolicy_t AppConfigurationObjects::RallypointPeer::outboundLeafPolicy

Definition at line 8034 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 8040 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 8037 of file ConfigurationObjects.h.

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

c/include/ConfigurationObjects.h

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members