Detailed information for a group connection. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types
enum	ConnectionType_t { ctUndefined = 0 , ctDirectDatagram = 1 , ctRallypoint = 2 }
	Connection type. 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
std::string	id
	ID of the group.

ConnectionType_t	connectionType
	The connection type.

std::string	peer
	Peer information.

bool	asFailover
	Indicates whether the connection is for purposes of failover.

std::string	reason
	[Optional] Additional reason information

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

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

Detailed Description

Detailed information for a group connection.

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

Definition at line 9454 of file ConfigurationObjects.h.

Member Enumeration Documentation

◆ ConnectionType_t

enum AppConfigurationObjects::GroupConnectionDetail::ConnectionType_t

Connection type.

Enumerator
ctUndefined	Undefined.
ctDirectDatagram	Direct datagram.
ctRallypoint	Rallypoint.

Definition at line 9462 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ GroupConnectionDetail()

AppConfigurationObjects::GroupConnectionDetail::GroupConnectionDetail ( )

inline

Definition at line 9489 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::GroupConnectionDetail::clear ( )

inline

Definition at line 9494 of file ConfigurationObjects.h.

Member Data Documentation

◆ asFailover

bool AppConfigurationObjects::GroupConnectionDetail::asFailover

Indicates whether the connection is for purposes of failover.

Definition at line 9484 of file ConfigurationObjects.h.

◆ connectionType

ConnectionType_t AppConfigurationObjects::GroupConnectionDetail::connectionType

The connection type.

Definition at line 9478 of file ConfigurationObjects.h.

◆ id

std::string AppConfigurationObjects::GroupConnectionDetail::id

ID of the group.

Definition at line 9475 of file ConfigurationObjects.h.

◆ peer

std::string AppConfigurationObjects::GroupConnectionDetail::peer

Peer information.

Definition at line 9481 of file ConfigurationObjects.h.

◆ reason

std::string AppConfigurationObjects::GroupConnectionDetail::reason

[Optional] Additional reason information

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