AppConfigurationObjects::DiscoveryConfiguration Class Reference

Configuration for the Discovery features. 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
DiscoveryMagellan	magellan
DiscoverySsdp	ssdp
DiscoverySap	sap
DiscoveryCistech	cistech
DiscoveryTrellisware	trellisware
Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json	_attached

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

Detailed Description

Configuration for the Discovery features.

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

Example:

{
   "cistech": {
      "address": {
         "address": "",
         "port": 0
      },
      "ageTimeoutMs": 30000,
      "enabled": false,
      "interfaceName": ""
   },
   "sap": {
      "address": {
         "address": "",
         "port": 0
      },
      "advertising": {
         "alwaysAdvertise": false,
         "enabled": false,
         "intervalMs": 20000
      },
      "ageTimeoutMs": 30000,
      "enabled": false,
      "interfaceName": ""
   },
   "ssdp": {
      "address": {
         "address": "",
         "port": 0
      },
      "advertising": {
         "alwaysAdvertise": false,
         "enabled": false,
         "intervalMs": 20000
      },
      "ageTimeoutMs": 30000,
      "enabled": false,
      "interfaceName": "",
      "searchTerms": []
   },
   "trellisware": {
      "enabled": false
   }
}

See also

engageInitialize, ConfigurationObjects::EnginePolicy

Definition at line 6581 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

DiscoveryConfiguration()

AppConfigurationObjects::DiscoveryConfiguration::DiscoveryConfiguration ( )

inline

Definition at line 6602 of file ConfigurationObjects.h.

Member Function Documentation

clear()

void AppConfigurationObjects::DiscoveryConfiguration::clear ( )

inline

Definition at line 6607 of file ConfigurationObjects.h.

Member Data Documentation

cistech

DiscoveryCistech AppConfigurationObjects::DiscoveryConfiguration::cistech

[Optional] SSDP (Simple Session Discovery Protocol) configuration.

Definition at line 6597 of file ConfigurationObjects.h.

magellan

DiscoveryMagellan AppConfigurationObjects::DiscoveryConfiguration::magellan

[Optional] Magellan (Magellan Discovery Protocol) configuration.

Definition at line 6588 of file ConfigurationObjects.h.

sap

DiscoverySap AppConfigurationObjects::DiscoveryConfiguration::sap

[Optional] SAP (Simple Session Discovery Protocol) configuration.

Definition at line 6594 of file ConfigurationObjects.h.

ssdp

DiscoverySsdp AppConfigurationObjects::DiscoveryConfiguration::ssdp

[Optional] SSDP (Simple Session Discovery Protocol) configuration.

Definition at line 6591 of file ConfigurationObjects.h.

trellisware

DiscoveryTrellisware AppConfigurationObjects::DiscoveryConfiguration::trellisware

[Optional] SSDP (Simple Session Discovery Protocol) configuration.

Definition at line 6600 of file ConfigurationObjects.h.

---

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

• c/include/ConfigurationObjects.h