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

Network Transmit Options. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Inherited by AppConfigurationObjects::TcpNetworkTxOptions.

Public Member Functions

void clear ()
 
virtual void initForDocumenting ()
 
- Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase
virtual std::string toString ()
 
virtual bool isDocumenting () const
 

Public Attributes

TxPriority_t priority
 [Optional, Default: priVoice] Transmission priority. This has meaning on some operating systems based on how their IP stack operates. It may or may not affect final packet marking.
 
int ttl
 [Optional, Default: 1] Time to live or hop limit is a mechanism that limits the lifespan or lifetime of data in a network. TTL prevents a data packet from circulating indefinitely.
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Network Transmit Options.

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

TODO: Complete this Class

Example:

{
"priority": 4,
"ttl": 128
}
See also
Group

Definition at line 2041 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ NetworkTxOptions()

AppConfigurationObjects::NetworkTxOptions::NetworkTxOptions ( )
inline

Definition at line 2057 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::NetworkTxOptions::clear ( )
inline

Definition at line 2062 of file ConfigurationObjects.h.

◆ initForDocumenting()

virtual void AppConfigurationObjects::NetworkTxOptions::initForDocumenting ( )
inlinevirtual

Reimplemented from AppConfigurationObjects::ConfigurationObjectBase.

Definition at line 2068 of file ConfigurationObjects.h.

Member Data Documentation

◆ priority

TxPriority_t AppConfigurationObjects::NetworkTxOptions::priority

[Optional, Default: priVoice] Transmission priority. This has meaning on some operating systems based on how their IP stack operates. It may or may not affect final packet marking.

Definition at line 2048 of file ConfigurationObjects.h.

◆ ttl

int AppConfigurationObjects::NetworkTxOptions::ttl

[Optional, Default: 1] Time to live or hop limit is a mechanism that limits the lifespan or lifetime of data in a network. TTL prevents a data packet from circulating indefinitely.

E.g If you don't want multicast data to leave your local network, set the TTL to 1.

Definition at line 2055 of file ConfigurationObjects.h.


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