Configuration for a Nsm node. 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 | |
| FipsCryptoSettings | fipsCrypto |
| [Optional] Settings for the FIPS crypto. | |
| WatchdogSettings | watchdog |
| [Optional] Settings for the node's watchdog. | |
| std::string | id |
| Unique identifier for this process instance (also used as default state machine id when stateMachine.id is empty). | |
| std::string | name |
| Human-readable label for operators. | |
| std::string | domainId |
| Logical domain id for this election channel. Required and unique when more than one NSM node is configured; bridge entries bind via nsmResource.domainId. | |
| IpFamilyType_t | ipFamily |
| [Optional, Default IpFamilyType_t::ifIp4] Address family for interface validation and logging. | |
| std::string | multicastInterfaceName |
| Multicast bind / subscription NIC (SO_BINDTODEVICE / IP_ADD_MEMBERSHIP). | |
| NsmConfiguration | stateMachine |
| Core NSM protocol and networking configuration (UDP, tokens, timing). | |
| int | defaultPriority |
| [Optional, Default: 0] Election priority byte when a resource omits priority or uses -1 (see NsmNodeResource.priority). | |
| int | fixedToken |
| [Optional, Default: -1] Fixed global token for testing; >= 0 forces that token, -1 uses random per election. | |
| bool | dashboardToken |
| [Optional, Default: false] When true with dashboard logging, show resource token in the UI. | |
| NsmNodeScripts | scripts |
| Lifecycle hook scripts. | |
| NsmNodeLogging | logging |
| Console / syslog logging. | |
| NsmNodeCotSettings | cot |
| Optional CoT wrapping for wire payloads. | |
| std::vector< NsmNodePeriodic > | periodics |
| Periodic commands (JSON output, external token range, etc.). | |
| NsmNodeElectionGateSettings | electionGate |
| Optional external gate for election wire participation (Seeker active/standby, etc.). | |
| NsmNodeActiveHealthCheckSettings | activeHealthCheck |
| Optional per-resource health monitoring while ACTIVE. | |
| NsmNodeStatusReportConfiguration | statusReport |
| Details for producing a status report. | |
| StatusUploadConfiguration | statusUpload |
| [Optional] Process-level status report HTTP upload (standalone nsmd). Ignored when embedded; host passes its own upload settings. | |
| std::string | configurationCheckSignalName |
| Name to use for signalling a configuration check. | |
| Licensing | licensing |
| Licensing settings. | |
| Featureset | featureset |
| Optional feature set. | |
| PacketCapturer | rxCapture |
| Details for capture of received packets | |
| PacketCapturer | txCapture |
| Details for capture of transmitted packets | |
| TuningSettings | tuning |
| [Optional] Low-level tuning | |
| Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase | |
| nlohmann::json | _attached |
Additional Inherited Members | |
| Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase | |
| bool | _documenting |
Detailed Description
Configuration for a Nsm node.
Helper C++ class to serialize and de-serialize NsmNode JSON
Example:
Definition at line 10350 of file ConfigurationObjects.h.
Constructor & Destructor Documentation
◆ NsmNode()
|
inline |
Definition at line 10432 of file ConfigurationObjects.h.
Member Function Documentation
◆ clear()
|
inline |
Definition at line 10437 of file ConfigurationObjects.h.
Member Data Documentation
◆ activeHealthCheck
| NsmNodeActiveHealthCheckSettings AppConfigurationObjects::NsmNode::activeHealthCheck |
Optional per-resource health monitoring while ACTIVE.
- See also
- NsmNodeActiveHealthCheckSettings
Definition at line 10406 of file ConfigurationObjects.h.
◆ configurationCheckSignalName
| std::string AppConfigurationObjects::NsmNode::configurationCheckSignalName |
Name to use for signalling a configuration check.
Definition at line 10415 of file ConfigurationObjects.h.
◆ cot
| NsmNodeCotSettings AppConfigurationObjects::NsmNode::cot |
Optional CoT wrapping for wire payloads.
Definition at line 10397 of file ConfigurationObjects.h.
◆ dashboardToken
| bool AppConfigurationObjects::NsmNode::dashboardToken |
[Optional, Default: false] When true with dashboard logging, show resource token in the UI.
Definition at line 10388 of file ConfigurationObjects.h.
◆ defaultPriority
| int AppConfigurationObjects::NsmNode::defaultPriority |
[Optional, Default: 0] Election priority byte when a resource omits priority or uses -1 (see NsmNodeResource.priority).
Definition at line 10382 of file ConfigurationObjects.h.
◆ domainId
| std::string AppConfigurationObjects::NsmNode::domainId |
Logical domain id for this election channel. Required and unique when more than one NSM node is configured; bridge entries bind via nsmResource.domainId.
Definition at line 10370 of file ConfigurationObjects.h.
◆ electionGate
| NsmNodeElectionGateSettings AppConfigurationObjects::NsmNode::electionGate |
Optional external gate for election wire participation (Seeker active/standby, etc.).
Definition at line 10403 of file ConfigurationObjects.h.
◆ featureset
| Featureset AppConfigurationObjects::NsmNode::featureset |
Optional feature set.
Definition at line 10421 of file ConfigurationObjects.h.
◆ fipsCrypto
| FipsCryptoSettings AppConfigurationObjects::NsmNode::fipsCrypto |
[Optional] Settings for the FIPS crypto.
Definition at line 10358 of file ConfigurationObjects.h.
◆ fixedToken
| int AppConfigurationObjects::NsmNode::fixedToken |
[Optional, Default: -1] Fixed global token for testing; >= 0 forces that token, -1 uses random per election.
Definition at line 10385 of file ConfigurationObjects.h.
◆ id
| std::string AppConfigurationObjects::NsmNode::id |
Unique identifier for this process instance (also used as default state machine id when stateMachine.id is empty).
Definition at line 10364 of file ConfigurationObjects.h.
◆ ipFamily
| IpFamilyType_t AppConfigurationObjects::NsmNode::ipFamily |
[Optional, Default IpFamilyType_t::ifIp4] Address family for interface validation and logging.
Definition at line 10373 of file ConfigurationObjects.h.
◆ licensing
| Licensing AppConfigurationObjects::NsmNode::licensing |
Licensing settings.
Definition at line 10418 of file ConfigurationObjects.h.
◆ logging
| NsmNodeLogging AppConfigurationObjects::NsmNode::logging |
Console / syslog logging.
Definition at line 10394 of file ConfigurationObjects.h.
◆ multicastInterfaceName
| std::string AppConfigurationObjects::NsmNode::multicastInterfaceName |
Multicast bind / subscription NIC (SO_BINDTODEVICE / IP_ADD_MEMBERSHIP).
Definition at line 10376 of file ConfigurationObjects.h.
◆ name
| std::string AppConfigurationObjects::NsmNode::name |
Human-readable label for operators.
Definition at line 10367 of file ConfigurationObjects.h.
◆ periodics
| std::vector<NsmNodePeriodic> AppConfigurationObjects::NsmNode::periodics |
Periodic commands (JSON output, external token range, etc.).
Definition at line 10400 of file ConfigurationObjects.h.
◆ rxCapture
| PacketCapturer AppConfigurationObjects::NsmNode::rxCapture |
Details for capture of received packets
Definition at line 10424 of file ConfigurationObjects.h.
◆ scripts
| NsmNodeScripts AppConfigurationObjects::NsmNode::scripts |
Lifecycle hook scripts.
Definition at line 10391 of file ConfigurationObjects.h.
◆ stateMachine
| NsmConfiguration AppConfigurationObjects::NsmNode::stateMachine |
Core NSM protocol and networking configuration (UDP, tokens, timing).
- See also
- NsmConfiguration
Definition at line 10379 of file ConfigurationObjects.h.
◆ statusReport
| NsmNodeStatusReportConfiguration AppConfigurationObjects::NsmNode::statusReport |
Details for producing a status report.
- See also
- NsmNodeStatusReportConfiguration
Definition at line 10409 of file ConfigurationObjects.h.
◆ statusUpload
| StatusUploadConfiguration AppConfigurationObjects::NsmNode::statusUpload |
[Optional] Process-level status report HTTP upload (standalone nsmd). Ignored when embedded; host passes its own upload settings.
Definition at line 10412 of file ConfigurationObjects.h.
◆ tuning
| TuningSettings AppConfigurationObjects::NsmNode::tuning |
[Optional] Low-level tuning
Definition at line 10430 of file ConfigurationObjects.h.
◆ txCapture
| PacketCapturer AppConfigurationObjects::NsmNode::txCapture |
Details for capture of transmitted packets
Definition at line 10427 of file ConfigurationObjects.h.
◆ watchdog
| WatchdogSettings AppConfigurationObjects::NsmNode::watchdog |
[Optional] Settings for the node's watchdog.
Definition at line 10361 of file ConfigurationObjects.h.
The documentation for this class was generated from the following file:
- engage/src/api/c/include/ConfigurationObjects.h
