Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AnalyticsET > FAnalyticsProviderETEventCache

Light Theme

Dark Theme

FAnalyticsProviderETEventCache

Mixin class for Epic Telemetry implementors.

Windows

MacOS

Linux

References

Module	AnalyticsET
Header	/Engine/Source/Runtime/Analytics/AnalyticsET/Public/AnalyticsProviderETEventCache.h
Include	#include "AnalyticsProviderETEventCache.h"

Syntax

class FAnalyticsProviderETEventCache

Remarks

Mixin class for Epic Telemetry implementors. The purpose of this class is to support the concept of caching events that are added via the standard RecordEvent API and serializing them into a payload in a Json format compatible with Epic's backend data collectors. The job of transporting these payloads to an external collector (generally expected to be via HTTP) is left to higher level classes to implement.

All public APIs in this class are threadsafe. Implemented via crappy critical sections for now, but they are safe.

Constructors

	Name	Description
	FAnalyticsProviderETEventCache ( int32 MaximumPayloadSize, int32 InPreallocatedPayloadSize )	Default ctor.

Functions

	Name	Description
void	AddToCache ( FString EventName )	Adds a new event to the cache.
void	AddToCache ( FString EventName, const TArray< FAnalyticsEventAttrib... )	Adds a new event to the cache.
bool	CanFlush()	Determines whether we have anything we need to flush, either a queued flush or existing events in the payload.
TArray< uint...	FlushCacheUTF8()	Flushes the cache as a UTF8 char array.
FAnalyticsEv...	GetDefaultAttribute ( int32 AttributeIndex )	Range checking is not done, similar to TArray.
int32	GetDefaultAttributeCount()
TArray< FAna...	GetDefaultAttributes()
int	GetNumCachedEvents()	Gets the number of cached events (doesn't include any flushes that are already queued for flush).
int32	GetSetPreallocatedPayloadSize()	Gets the preallocated size of the payload buffer.
bool	HasFlushesQueued()	Lets external code know that there are payloads queued for flush.
void	SetDefaultAttributes ( TArray< FAnalyticsEventAttribute > ... )	Sets an array of attributes that will automatically be appended to any event that is sent.
void	SetPreallocatedPayloadSize ( int32 InSetPreallocatedPayloadSize )	Sets the preallocated payload size

Classes

	Name	Description
	Lock	For when you need to take a lock across multiple API calls

Deprecated Functions

		Name	Description
	FString	FlushCache ( SIZE_T* OutEventCount )	This method has been deprecated, use FlushCacheUTF8() instead.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss