Simple Service Discovery Protocol settings. 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
	[Optional, Default: false] Enables the Engage Engine to use SSDP for asset discovery.

std::string	interfaceName
	[Optional, Default: default system interface] The network interface to bind to for discovery packets.

NetworkAddress	address
	[Optional, Default 255.255.255.255:1900] IP address and port.

std::vector< std::string >	searchTerms
	[Optional] An array of regex strings to be used to filter SSDP requests and responses.

int	ageTimeoutMs
	[Optional, Default 30000] Number of milliseconds of no SSDP announcment before the advertised entity is considered "gone".

Advertising	advertising
	Parameters for advertising.

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

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

Detailed Description

Simple Service Discovery Protocol settings.

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

Example:

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

See also: engageInitialize, ConfigurationObjects::DiscoveryConfiguration

Definition at line 7186 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ DiscoverySsdp()

AppConfigurationObjects::DiscoverySsdp::DiscoverySsdp ( )

inline

Definition at line 7211 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::DiscoverySsdp::clear ( )

inline

Definition at line 7216 of file ConfigurationObjects.h.

Member Data Documentation

◆ address

NetworkAddress AppConfigurationObjects::DiscoverySsdp::address

[Optional, Default 255.255.255.255:1900] IP address and port.

Definition at line 7200 of file ConfigurationObjects.h.

◆ advertising

Advertising AppConfigurationObjects::DiscoverySsdp::advertising

Parameters for advertising.

Definition at line 7209 of file ConfigurationObjects.h.

◆ ageTimeoutMs

int AppConfigurationObjects::DiscoverySsdp::ageTimeoutMs

[Optional, Default 30000] Number of milliseconds of no SSDP announcment before the advertised entity is considered "gone".

Definition at line 7206 of file ConfigurationObjects.h.

◆ enabled

bool AppConfigurationObjects::DiscoverySsdp::enabled

[Optional, Default: false] Enables the Engage Engine to use SSDP for asset discovery.

Definition at line 7194 of file ConfigurationObjects.h.

◆ interfaceName

std::string AppConfigurationObjects::DiscoverySsdp::interfaceName

[Optional, Default: default system interface] The network interface to bind to for discovery packets.

Definition at line 7197 of file ConfigurationObjects.h.

◆ searchTerms

std::vector<std::string> AppConfigurationObjects::DiscoverySsdp::searchTerms

[Optional] An array of regex strings to be used to filter SSDP requests and responses.

Definition at line 7203 of file ConfigurationObjects.h.

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

engage/src/api/c/include/ConfigurationObjects.h

Public Member Functions

Public Attributes

Additional Inherited Members