Engine Policy Timeline configuration. 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
bool	enabled
	[Optional, Default: true] Specifies if Time Lines are enabled by default.

std::string	storageRoot
	Specifies where the timeline recordings will be stored physically.

int	maxStorageMb
	Specifies the maximum storage space to use.

int	maxMemMb
	Specifies the maximum memory to use - defaults to maxStorageMb.

int	maxAudioEventMemMb
	Specifies the maximum number of megabytes to allow for a single audio event's memory block - defaults to maxMemMb.

int	maxDiskMb
	Specifies the maximum disk space to use - defaults to maxStorageMb.

long	maxEventAgeSecs
	Maximum age of an event after which it is to be erased.

int	maxEvents
	Maximum number of events to be retained.

long	groomingIntervalSecs
	Interval at which events are to be checked for age-based grooming.

SecurityCertificate	security
	The certificate to use for signing the recording.

long	autosaveIntervalSecs
	[Default 5] Interval at which events are to be saved from memory to disk (a slow operation)

bool	disableSigningAndVerification
	[Default false] If true, prevents signing of events - i.e. no anti-tanpering features will be available

bool	ephemeral
	[Default false] If true, recordings are automatically purged when the Engine is shut down and/or reinitialized.

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

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

Detailed Description

Engine Policy Timeline configuration.

Timelines are used to record audio for instant replay and archival purposes. The audio files contain "anti tampering" features.

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

Example:

{
   "enabled": true,
   "groomingIntervalSecs": 1800,
   "maxEventAgeSecs": 2592000,
   "maxEvents": 1000,
   "maxStorageMb": 128,
   "security": {
      "certificate": "",
      "key": ""
   },
   "storageRoot": ""
}

See also: engageInitialize, engageQueryGroupTimeline, EnginePolicy

Definition at line 7311 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ EnginePolicyTimelines()

AppConfigurationObjects::EnginePolicyTimelines::EnginePolicyTimelines ( )

inline

Definition at line 7367 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::EnginePolicyTimelines::clear ( )

inline

Definition at line 7372 of file ConfigurationObjects.h.

Member Data Documentation

◆ autosaveIntervalSecs

long AppConfigurationObjects::EnginePolicyTimelines::autosaveIntervalSecs

[Default 5] Interval at which events are to be saved from memory to disk (a slow operation)

Definition at line 7359 of file ConfigurationObjects.h.

◆ disableSigningAndVerification

bool AppConfigurationObjects::EnginePolicyTimelines::disableSigningAndVerification

[Default false] If true, prevents signing of events - i.e. no anti-tanpering features will be available

Definition at line 7362 of file ConfigurationObjects.h.

◆ enabled

bool AppConfigurationObjects::EnginePolicyTimelines::enabled

[Optional, Default: true] Specifies if Time Lines are enabled by default.

Certain time line settings can be overridden at a per group level using the ConfigurationObjects::GroupTimeline configuration.

Definition at line 7323 of file ConfigurationObjects.h.

◆ ephemeral

bool AppConfigurationObjects::EnginePolicyTimelines::ephemeral

[Default false] If true, recordings are automatically purged when the Engine is shut down and/or reinitialized.

Definition at line 7365 of file ConfigurationObjects.h.

◆ groomingIntervalSecs

long AppConfigurationObjects::EnginePolicyTimelines::groomingIntervalSecs

Interval at which events are to be checked for age-based grooming.

Definition at line 7347 of file ConfigurationObjects.h.

◆ maxAudioEventMemMb

int AppConfigurationObjects::EnginePolicyTimelines::maxAudioEventMemMb

Specifies the maximum number of megabytes to allow for a single audio event's memory block - defaults to maxMemMb.

Definition at line 7335 of file ConfigurationObjects.h.

◆ maxDiskMb

int AppConfigurationObjects::EnginePolicyTimelines::maxDiskMb

Specifies the maximum disk space to use - defaults to maxStorageMb.

Definition at line 7338 of file ConfigurationObjects.h.

◆ maxEventAgeSecs

long AppConfigurationObjects::EnginePolicyTimelines::maxEventAgeSecs

Maximum age of an event after which it is to be erased.

Definition at line 7341 of file ConfigurationObjects.h.

◆ maxEvents

int AppConfigurationObjects::EnginePolicyTimelines::maxEvents

Maximum number of events to be retained.

Definition at line 7344 of file ConfigurationObjects.h.

◆ maxMemMb

int AppConfigurationObjects::EnginePolicyTimelines::maxMemMb

Specifies the maximum memory to use - defaults to maxStorageMb.

Definition at line 7332 of file ConfigurationObjects.h.

◆ maxStorageMb

int AppConfigurationObjects::EnginePolicyTimelines::maxStorageMb

Specifies the maximum storage space to use.

Definition at line 7329 of file ConfigurationObjects.h.

◆ security

SecurityCertificate AppConfigurationObjects::EnginePolicyTimelines::security

The certificate to use for signing the recording.

This is part of the anti tampering feature where the certificate and it's private key are used to digitally sign the event. The public portion of the certificate is added to the event file for later verification.

Definition at line 7356 of file ConfigurationObjects.h.

◆ storageRoot

std::string AppConfigurationObjects::EnginePolicyTimelines::storageRoot

Specifies where the timeline recordings will be stored physically.

Definition at line 7326 of file ConfigurationObjects.h.

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

c/include/ConfigurationObjects.h

Public Member Functions

Public Attributes

Additional Inherited Members