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

Definition of a static group for Rallypoints. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Types

enum  DirectionRestriction_t { drNone = 0 , drRxOnly = 1 , drTxOnly = 2 }
 Enum describing direction(s) for the reflector. More...
 

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

std::string id
 Unique identity for the group.
 
NetworkAddress rx
 The network address for receiving network traffic on.
 
NetworkAddress tx
 The network address for transmitting network traffic to.
 
std::string multicastInterfaceName
 [Optional] The name of the NIC on which to send and receive multicast traffic.
 
std::vector< NetworkAddressadditionalTx
 [Optional] Vector of additional TX addresses .
 
DirectionRestriction_t directionRestriction
 [Optional] Restriction of direction of traffic flow
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Definition of a static group for Rallypoints.

Example:

Definition at line 8134 of file ConfigurationObjects.h.

Member Enumeration Documentation

◆ DirectionRestriction_t

Enum describing direction(s) for the reflector.

Enumerator
drNone 

No restriction - both directions allowed.

drRxOnly 

RX only.

drTxOnly 

TX only.

Definition at line 8141 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ RallypointReflector()

AppConfigurationObjects::RallypointReflector::RallypointReflector ( )
inline

Definition at line 8173 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::RallypointReflector::clear ( )
inline

Definition at line 8178 of file ConfigurationObjects.h.

Member Data Documentation

◆ additionalTx

std::vector<NetworkAddress> AppConfigurationObjects::RallypointReflector::additionalTx

[Optional] Vector of additional TX addresses .

Definition at line 8168 of file ConfigurationObjects.h.

◆ directionRestriction

DirectionRestriction_t AppConfigurationObjects::RallypointReflector::directionRestriction

[Optional] Restriction of direction of traffic flow

Definition at line 8171 of file ConfigurationObjects.h.

◆ id

std::string AppConfigurationObjects::RallypointReflector::id

Unique identity for the group.

Definition at line 8156 of file ConfigurationObjects.h.

◆ multicastInterfaceName

std::string AppConfigurationObjects::RallypointReflector::multicastInterfaceName

[Optional] The name of the NIC on which to send and receive multicast traffic.

Definition at line 8165 of file ConfigurationObjects.h.

◆ rx

NetworkAddress AppConfigurationObjects::RallypointReflector::rx

The network address for receiving network traffic on.

Definition at line 8159 of file ConfigurationObjects.h.

◆ tx

NetworkAddress AppConfigurationObjects::RallypointReflector::tx

The network address for transmitting network traffic to.

Definition at line 8162 of file ConfigurationObjects.h.


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