Engage Engine API  1.244.9084
Loading...
Searching...
No Matches
AppConfigurationObjects::WatchdogSettings Class Reference

Inherits AppConfigurationObjects::ConfigurationObjectBase.

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

bool enabled
 [Optional, Default: true] Enables/disables a watchdog.
 
int intervalMs
 [Optional, Default: 5000] Interval at which checks are made.
 
int hangDetectionMs
 [Optional, Default: 2000] Number of milliseconds that must pass before a hang is assumed.
 
bool abortOnHang
 [Optional, Default: true] If true, aborts the process if a hang is detected.
 
int slowExecutionThresholdMs
 [Optional, Default: 100] Maximum number of milliseconds that a task may take before being considered slow.
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Definition at line 507 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ WatchdogSettings()

AppConfigurationObjects::WatchdogSettings::WatchdogSettings ( )
inline

Definition at line 528 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::WatchdogSettings::clear ( )
inline

Definition at line 533 of file ConfigurationObjects.h.

◆ initForDocumenting()

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

Reimplemented from AppConfigurationObjects::ConfigurationObjectBase.

Definition at line 542 of file ConfigurationObjects.h.

Member Data Documentation

◆ abortOnHang

bool AppConfigurationObjects::WatchdogSettings::abortOnHang

[Optional, Default: true] If true, aborts the process if a hang is detected.

Definition at line 523 of file ConfigurationObjects.h.

◆ enabled

bool AppConfigurationObjects::WatchdogSettings::enabled

[Optional, Default: true] Enables/disables a watchdog.

Definition at line 514 of file ConfigurationObjects.h.

◆ hangDetectionMs

int AppConfigurationObjects::WatchdogSettings::hangDetectionMs

[Optional, Default: 2000] Number of milliseconds that must pass before a hang is assumed.

Definition at line 520 of file ConfigurationObjects.h.

◆ intervalMs

int AppConfigurationObjects::WatchdogSettings::intervalMs

[Optional, Default: 5000] Interval at which checks are made.

Definition at line 517 of file ConfigurationObjects.h.

◆ slowExecutionThresholdMs

int AppConfigurationObjects::WatchdogSettings::slowExecutionThresholdMs

[Optional, Default: 100] Maximum number of milliseconds that a task may take before being considered slow.

Definition at line 526 of file ConfigurationObjects.h.


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