#include <EngineAnalyticsSessionSummary.h>

Public Member Functions
ENGINE_API	FEngineAnalyticsSessionSummary (TSharedPtr< IAnalyticsPropertyStore > Storage, uint32 MonitorProcessId)

virtual	~FEngineAnalyticsSessionSummary ()=default

ENGINE_API void	Tick (float DeltaTime)

ENGINE_API void	Shutdown ()

void	SetPersistPeriod (const FTimespan &Period)

FTimespan	GetPersistPeriod () const

ENGINE_API void	LowDriveSpaceDetected ()

Protected Member Functions
virtual void	ShutdownInternal ()

virtual bool	UpdateSessionProgressInternal (bool bCrashing)

IAnalyticsPropertyStore *	GetStore ()

Detailed Description

Collects engine events/stats and stores a summary on disk until reported by the analytics session summary manager.

Constructor & Destructor Documentation

◆ FEngineAnalyticsSessionSummary()

FEngineAnalyticsSessionSummary::FEngineAnalyticsSessionSummary	(	TSharedPtr< IAnalyticsPropertyStore >	Storage,
		uint32	MonitorProcessId
	)

Constructs an analytics summary collector.

Parameters

Storage	Where to store the engine summary properties that are sent on exit.
MonitorProcessId	The process ID of CRC launched at start up in 'monitor mode', zero otherwise.

◆ ~FEngineAnalyticsSessionSummary()

virtual FEngineAnalyticsSessionSummary::~FEngineAnalyticsSessionSummary ( )

virtualdefault

Destructor.

Member Function Documentation

◆ GetPersistPeriod()

FTimespan FEngineAnalyticsSessionSummary::GetPersistPeriod ( ) const

inline

Get the period used to update and persist the properties to disk.

◆ GetStore()

IAnalyticsPropertyStore * FEngineAnalyticsSessionSummary::GetStore ( )

inlineprotected

Returns the property store used by the summary.

◆ LowDriveSpaceDetected()

void FEngineAnalyticsSessionSummary::LowDriveSpaceDetected ( )

Invoked by the engine when the user is running low on disk space..

◆ SetPersistPeriod()

void FEngineAnalyticsSessionSummary::SetPersistPeriod ( const FTimespan & Period )

inline

Set the period used to persist the properties to disk. Some events ignore this setting and persist the properties right away.

◆ Shutdown()

void FEngineAnalyticsSessionSummary::Shutdown ( )

Shuts down the session, unregistering the callbacks and closing the session.

◆ ShutdownInternal()

virtual void FEngineAnalyticsSessionSummary::ShutdownInternal ( )

inlineprotectedvirtual

Invoked during Shutdown() to let derived classes hook in the shutdown. Default implementation does nothing.

◆ Tick()

void FEngineAnalyticsSessionSummary::Tick ( float DeltaTime )

Ticks the session. This calls UpdateSessionProgress() at the configured update period which calls UpdateSessionProgressInternal() for derived classes.

◆ UpdateSessionProgressInternal()

virtual bool FEngineAnalyticsSessionSummary::UpdateSessionProgressInternal ( bool bCrashing )