Engage Engine API  1.244.9084
Loading...
Searching...
No Matches
AppConfigurationObjects::DiscoverySap Class Reference

Session Announcement Discovery settings 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 SAP for asset discovery.
 
std::string interfaceName
 [Optional, Default: default system interface] The network interface to bind to for discovery packets.

 
NetworkAddress address
 [Optional, Default 224.2.127.254:9875] IP address and port.
 
int ageTimeoutMs
 [Optional, Default 30000] Number of milliseconds of no SAP 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

Session Announcement Discovery settings settings.

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

Example:

{
"address": {
"address": "",
"port": 0
},
"advertising": {
"alwaysAdvertise": false,
"enabled": false,
"intervalMs": 20000
},
"ageTimeoutMs": 30000,
"enabled": false,
"interfaceName": ""
}
See also
engageInitialize, ConfigurationObjects::DiscoveryConfiguration

Definition at line 6398 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ DiscoverySap()

AppConfigurationObjects::DiscoverySap::DiscoverySap ( )
inline

Definition at line 6419 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::DiscoverySap::clear ( )
inline

Definition at line 6424 of file ConfigurationObjects.h.

Member Data Documentation

◆ address

NetworkAddress AppConfigurationObjects::DiscoverySap::address

[Optional, Default 224.2.127.254:9875] IP address and port.

Definition at line 6411 of file ConfigurationObjects.h.

◆ advertising

Advertising AppConfigurationObjects::DiscoverySap::advertising

Parameters for advertising.

Definition at line 6417 of file ConfigurationObjects.h.

◆ ageTimeoutMs

int AppConfigurationObjects::DiscoverySap::ageTimeoutMs

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

Definition at line 6414 of file ConfigurationObjects.h.

◆ enabled

bool AppConfigurationObjects::DiscoverySap::enabled

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

Definition at line 6405 of file ConfigurationObjects.h.

◆ interfaceName

std::string AppConfigurationObjects::DiscoverySap::interfaceName

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

Definition at line 6408 of file ConfigurationObjects.h.


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