Engage Engine API  1.263.9113
Real-time tactical communications engine API
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
AppConfigurationObjects::TransportImpairment Class Reference

Description of a transport impairment. 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

int jitterMs
 [Optional, Default: 0] Max random delay in milliseconds applied to a packet.
 
int lossPercentage
 [Optional, Default: 0] Percentage of packets to drop (0-100).
 
int errorPercentage
 [Optional, Default: 0] When > 0, percentage of packets forced to error path.
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Description of a transport impairment.

Helper C++ class to serialize and de-serialize TransportImpairment JSON.

Example:

Definition at line 2643 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ TransportImpairment()

AppConfigurationObjects::TransportImpairment::TransportImpairment ( )
inline

Definition at line 2656 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::TransportImpairment::clear ( )
inline

Definition at line 2661 of file ConfigurationObjects.h.

Member Data Documentation

◆ errorPercentage

int AppConfigurationObjects::TransportImpairment::errorPercentage

[Optional, Default: 0] When > 0, percentage of packets forced to error path.

Definition at line 2654 of file ConfigurationObjects.h.

◆ jitterMs

int AppConfigurationObjects::TransportImpairment::jitterMs

[Optional, Default: 0] Max random delay in milliseconds applied to a packet.

Definition at line 2650 of file ConfigurationObjects.h.

◆ lossPercentage

int AppConfigurationObjects::TransportImpairment::lossPercentage

[Optional, Default: 0] Percentage of packets to drop (0-100).

Definition at line 2652 of file ConfigurationObjects.h.

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