Engage Engine API  1.243.9083
Loading...
Searching...
No Matches
AppConfigurationObjects::RallypointAdvertisingSettings Class Reference

Defines settings for Rallypoint advertising. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

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

bool enabled
 [Default: false] Advertising is enabled
 
std::string meshName
 [Optional] This Rallypoint's mesh name
 
std::string hostName
 [Optional] This Rallypoint's DNS-SD host name
 
std::string serviceName
 [Optional, Default "_rallypoint._tcp.local."] The service name
 
std::string interfaceName
 The multicast network interface for mDNS.
 
int port
 [Default: RP port] The multicast network interface for mDNS
 
int ttl
 [Default: 60] TTL for service TTL
 
std::vector< std::string > extraMeshes
 [Optional] List of additional meshes that can be reached via this RP
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Defines settings for Rallypoint advertising.

Example:

Definition at line 8218 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ RallypointAdvertisingSettings()

AppConfigurationObjects::RallypointAdvertisingSettings::RallypointAdvertisingSettings ( )
inline

Definition at line 8249 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::RallypointAdvertisingSettings::clear ( )
inline

Definition at line 8254 of file ConfigurationObjects.h.

Member Data Documentation

◆ enabled

bool AppConfigurationObjects::RallypointAdvertisingSettings::enabled

[Default: false] Advertising is enabled

Definition at line 8225 of file ConfigurationObjects.h.

◆ extraMeshes

std::vector<std::string> AppConfigurationObjects::RallypointAdvertisingSettings::extraMeshes

[Optional] List of additional meshes that can be reached via this RP

Definition at line 8246 of file ConfigurationObjects.h.

◆ hostName

std::string AppConfigurationObjects::RallypointAdvertisingSettings::hostName

[Optional] This Rallypoint's DNS-SD host name

Definition at line 8231 of file ConfigurationObjects.h.

◆ interfaceName

std::string AppConfigurationObjects::RallypointAdvertisingSettings::interfaceName

The multicast network interface for mDNS.

Definition at line 8237 of file ConfigurationObjects.h.

◆ meshName

std::string AppConfigurationObjects::RallypointAdvertisingSettings::meshName

[Optional] This Rallypoint's mesh name

Definition at line 8228 of file ConfigurationObjects.h.

◆ port

int AppConfigurationObjects::RallypointAdvertisingSettings::port

[Default: RP port] The multicast network interface for mDNS

Definition at line 8240 of file ConfigurationObjects.h.

◆ serviceName

std::string AppConfigurationObjects::RallypointAdvertisingSettings::serviceName

[Optional, Default "_rallypoint._tcp.local."] The service name

Definition at line 8234 of file ConfigurationObjects.h.

◆ ttl

int AppConfigurationObjects::RallypointAdvertisingSettings::ttl

[Default: 60] TTL for service TTL

Definition at line 8243 of file ConfigurationObjects.h.


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