Optional pacing for asynchronous Engage API calls. More...

#include <ConfigurationObjects.h>

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
ApiCallPacingLaneSettings	topology
	[Optional] Pacing for topology mutations (e.g. engageCreateGroup).

ApiCallPacingLaneSettings	transmission
	[Optional] Pacing for transmission-related API calls.

ApiCallPacingLaneSettings	configuration
	[Optional] Pacing for configuration-related API calls.

Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json	_attached

Additional Inherited Members
Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool	_documenting

Detailed Description

Optional pacing for asynchronous Engage API calls.

When intervalMs is non-zero for a lane, calls assigned to that lane are queued and submitted to the engine at the configured rate. All intervals default to 0 (no pacing).

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

See also: EnginePolicyInternals, engageCreateGroup

Definition at line 7512 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ ApiCallPacingSettings()

AppConfigurationObjects::ApiCallPacingSettings::ApiCallPacingSettings ( )

inline

Definition at line 7527 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::ApiCallPacingSettings::clear ( )

inline

Definition at line 7532 of file ConfigurationObjects.h.

◆ initForDocumenting()

virtual void AppConfigurationObjects::ApiCallPacingSettings::initForDocumenting ( )

inlinevirtual

Reimplemented from AppConfigurationObjects::ConfigurationObjectBase.

Definition at line 7539 of file ConfigurationObjects.h.

Member Data Documentation

◆ configuration

ApiCallPacingLaneSettings AppConfigurationObjects::ApiCallPacingSettings::configuration

[Optional] Pacing for configuration-related API calls.

Definition at line 7525 of file ConfigurationObjects.h.

◆ topology

ApiCallPacingLaneSettings AppConfigurationObjects::ApiCallPacingSettings::topology

[Optional] Pacing for topology mutations (e.g. engageCreateGroup).

Definition at line 7519 of file ConfigurationObjects.h.

◆ transmission

ApiCallPacingLaneSettings AppConfigurationObjects::ApiCallPacingSettings::transmission

[Optional] Pacing for transmission-related API calls.

Definition at line 7522 of file ConfigurationObjects.h.

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

engage/src/api/c/include/ConfigurationObjects.h

Public Member Functions

Public Attributes

Additional Inherited Members