Engage Engine API  1.246.9086
Loading...
Searching...
No Matches
AppConfigurationObjects::Advertising Class Reference

Defines parameters for advertising of an entity such as a known, public, group. 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] Enabled advertising
 
int intervalMs
 [Optional, Default: 20000] Interval at which the advertisement should be sent in milliseconds.
 
bool alwaysAdvertise
 [Optional, Default: false] If true, the node will advertise the item even if it detects other nodes making the same advertisement
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Defines parameters for advertising of an entity such as a known, public, group.

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

Example:

{
"alwaysAdvertise": false,
"enabled": false,
"intervalMs": 20000
}
See also
DiscoverySsdp, DiscoverySap

Definition at line 4005 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ Advertising()

AppConfigurationObjects::Advertising::Advertising ( )
inline

Definition at line 4020 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::Advertising::clear ( )
inline

Definition at line 4025 of file ConfigurationObjects.h.

Member Data Documentation

◆ alwaysAdvertise

bool AppConfigurationObjects::Advertising::alwaysAdvertise

[Optional, Default: false] If true, the node will advertise the item even if it detects other nodes making the same advertisement

Definition at line 4018 of file ConfigurationObjects.h.

◆ enabled

bool AppConfigurationObjects::Advertising::enabled

[Optional, Default: false] Enabled advertising

Definition at line 4012 of file ConfigurationObjects.h.

◆ intervalMs

int AppConfigurationObjects::Advertising::intervalMs

[Optional, Default: 20000] Interval at which the advertisement should be sent in milliseconds.

Definition at line 4015 of file ConfigurationObjects.h.


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