#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types
enum	ConnectionStrategy_t { csRoundRobin = 0 , csFailback = 1 }
	Connection strategy enum. More...

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
ConnectionStrategy_t	connectionStrategy
	[Optional, Default: csRoundRobin] Specifies the connection strategy to be followed. See ConnectionStrategy_t for all strategy types

std::vector< Rallypoint >	rallypoints
	List of Rallypoints.

int	rolloverSecs
	Seconds between switching to a new target.

int	connectionTimeoutSecs
	[Optional, Default: 0] Default connection timeout in seconds to any RP in the cluster

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

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

Detailed Description

RallypointCluster.

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

TODO: Complete this Class

Example:

Definition at line 2886 of file ConfigurationObjects.h.

Member Enumeration Documentation

◆ ConnectionStrategy_t

enum AppConfigurationObjects::RallypointCluster::ConnectionStrategy_t

Connection strategy enum.

More detailed ConnectionStrategy_t description.

Enumerator
csRoundRobin	Connect in round-robin fashion.
csFailback	Fail back to high-order RP when available.

Definition at line 2897 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ RallypointCluster()

AppConfigurationObjects::RallypointCluster::RallypointCluster ( )

inline

Definition at line 2918 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::RallypointCluster::clear ( )

inline

Definition at line 2923 of file ConfigurationObjects.h.

Member Data Documentation

◆ connectionStrategy

ConnectionStrategy_t AppConfigurationObjects::RallypointCluster::connectionStrategy

[Optional, Default: csRoundRobin] Specifies the connection strategy to be followed. See ConnectionStrategy_t for all strategy types

Definition at line 2907 of file ConfigurationObjects.h.

◆ connectionTimeoutSecs

int AppConfigurationObjects::RallypointCluster::connectionTimeoutSecs

[Optional, Default: 0] Default connection timeout in seconds to any RP in the cluster

Definition at line 2916 of file ConfigurationObjects.h.

◆ rallypoints

std::vector<Rallypoint> AppConfigurationObjects::RallypointCluster::rallypoints

List of Rallypoints.

Definition at line 2910 of file ConfigurationObjects.h.

◆ rolloverSecs

int AppConfigurationObjects::RallypointCluster::rolloverSecs

Seconds between switching to a new target.

Definition at line 2913 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