FAnalyticsProviderET Class Reference

Inheritance diagram for FAnalyticsProviderET:

Public Member Functions
	FAnalyticsProviderET (const FAnalyticsET::Config &ConfigValues)
bool	Tick (float DeltaSeconds) override
virtual bool	StartSession (FString InSessionID, const TArray< FAnalyticsEventAttribute > &Attributes) override
virtual void	EndSession () override
virtual void	FlushEvents () override
virtual void	SetAppID (FString &&AppID) override
virtual void	SetAppVersion (FString &&AppVersion) override
virtual void	SetUserID (const FString &InUserID) override
virtual FString	GetUserID () const override
virtual FString	GetSessionID () const override
virtual bool	SetSessionID (const FString &InSessionID) override
virtual bool	ShouldRecordEvent (const FString &EventName) const override
virtual void	RecordEvent (FString &&EventName, const TArray< FAnalyticsEventAttribute > &Attributes) override
virtual void	RecordEvent (FString &&EventName, const TArray< FAnalyticsEventAttribute > &Attributes, EAnalyticsRecordEventMode Mode) override
virtual void	SetDefaultEventAttributes (TArray< FAnalyticsEventAttribute > &&Attributes) override
virtual TArray< FAnalyticsEventAttribute >	GetDefaultEventAttributesSafe () const override
virtual int32	GetDefaultEventAttributeCount () const override
virtual FAnalyticsEventAttribute	GetDefaultEventAttribute (int AttributeIndex) const override
virtual void	SetEventCallback (const OnEventRecorded &Callback) override
virtual void	SetUrlDomain (const FString &Domain, const TArray< FString > &AltDomains) override
virtual void	SetUrlPath (const FString &Path) override
virtual void	SetHeader (const FString &HeaderName, const FString &HeaderValue) override
virtual void	BlockUntilFlushed (float InTimeoutSec) override
virtual void	SetShouldRecordEventFunc (const ShouldRecordEventFunction &InShouldRecordEventFunc) override
virtual FOnPreAnalyticsEventProcessed &	OnPreAnalyticsEventProcessed () override
virtual FOnAnalyticsEventQueued &	OnAnalyticsEventQueued () override
virtual	~FAnalyticsProviderET ()
virtual const FAnalyticsET::Config &	GetConfig () const override
Public Member Functions inherited from FTSTickerObjectBase
	UE_NONCOPYABLE (FTSTickerObjectBase)
CORE_API	FTSTickerObjectBase (float InDelay=0.0f, FTSTicker &Ticker=FTSTicker::GetCoreTicker())
virtual CORE_API	~FTSTickerObjectBase ()
Public Member Functions inherited from TSharedFromThis< FAnalyticsProviderET >
TSharedRef< FAnalyticsProviderET, Mode >	AsShared ()
TSharedRef< FAnalyticsProviderET const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FAnalyticsProviderET, Mode >	AsWeak ()
TWeakPtr< FAnalyticsProviderET const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FAnalyticsProviderET >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< FAnalyticsProviderET >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

Implementation of analytics for Epic Telemetry. Supports caching events and flushing them periodically (currently hardcoded limits). Also supports a set of default attributes that will be added to every event. For efficiency, this set of attributes is added directly into the set of cached events with a special flag to indicate its purpose. This allows the set of cached events to be used like a set of commands to be executed on flush, and allows us to inject the default attributes efficiently into many events without copying the array at all. If Config.APIServerET is empty, this will act as a NULL provider by forcing ShouldRecordEvent() to return false all the time.

Constructor & Destructor Documentation

FAnalyticsProviderET()

FAnalyticsProviderET::FAnalyticsProviderET

(

const FAnalyticsET::Config &

ConfigValues

)

Perform any initialization.

~FAnalyticsProviderET()

FAnalyticsProviderET::~FAnalyticsProviderET ( )

virtual

Member Function Documentation

BlockUntilFlushed()

void FAnalyticsProviderET::BlockUntilFlushed ( float  InTimeoutSec )

overridevirtual

EndSession()

void FAnalyticsProviderET::EndSession ( )

overridevirtual

End capturing stats and queue the upload

FlushEvents()

void FAnalyticsProviderET::FlushEvents ( )

overridevirtual

GetConfig()

virtual const FAnalyticsET::Config & FAnalyticsProviderET::GetConfig ( ) const

inlineoverridevirtual

GetDefaultEventAttribute()

FAnalyticsEventAttribute FAnalyticsProviderET::GetDefaultEventAttribute ( int  AttributeIndex ) const

overridevirtual

GetDefaultEventAttributeCount()

int32 FAnalyticsProviderET::GetDefaultEventAttributeCount ( ) const

overridevirtual

GetDefaultEventAttributesSafe()

TArray< FAnalyticsEventAttribute > FAnalyticsProviderET::GetDefaultEventAttributesSafe ( ) const

overridevirtual

GetSessionID()

FString FAnalyticsProviderET::GetSessionID ( ) const

overridevirtual

GetUserID()

FString FAnalyticsProviderET::GetUserID ( ) const

overridevirtual

OnAnalyticsEventQueued()

virtual FOnAnalyticsEventQueued & FAnalyticsProviderET::OnAnalyticsEventQueued ( )

inlineoverridevirtual

OnPreAnalyticsEventProcessed()

virtual FOnPreAnalyticsEventProcessed & FAnalyticsProviderET::OnPreAnalyticsEventProcessed ( )

inlineoverridevirtual

RecordEvent() [1/2]

void FAnalyticsProviderET::RecordEvent ( FString &&  EventName, const TArray< FAnalyticsEventAttribute > &  Attributes  )

overridevirtual

RecordEvent() [2/2]

void FAnalyticsProviderET::RecordEvent ( FString &&  EventName, const TArray< FAnalyticsEventAttribute > &  Attributes, EAnalyticsRecordEventMode  Mode  )

overridevirtual

SetAppID()

void FAnalyticsProviderET::SetAppID ( FString &&  AppID )

overridevirtual

SetAppVersion()

void FAnalyticsProviderET::SetAppVersion ( FString &&  AppVersion )

overridevirtual

SetDefaultEventAttributes()

void FAnalyticsProviderET::SetDefaultEventAttributes ( TArray< FAnalyticsEventAttribute > &&  Attributes )

overridevirtual

SetEventCallback()

void FAnalyticsProviderET::SetEventCallback ( const OnEventRecorded &  Callback )

overridevirtual

SetHeader()

void FAnalyticsProviderET::SetHeader ( const FString &  HeaderName, const FString &  HeaderValue  )

overridevirtual

SetSessionID()

bool FAnalyticsProviderET::SetSessionID ( const FString &  InSessionID )

overridevirtual

SetShouldRecordEventFunc()

void FAnalyticsProviderET::SetShouldRecordEventFunc ( const ShouldRecordEventFunction &  InShouldRecordEventFunc )

overridevirtual

SetUrlDomain()

void FAnalyticsProviderET::SetUrlDomain ( const FString &  Domain, const TArray< FString > &  AltDomains  )

overridevirtual

SetUrlPath()

void FAnalyticsProviderET::SetUrlPath ( const FString &  Path )

overridevirtual

SetUserID()

void FAnalyticsProviderET::SetUserID ( const FString &  InUserID )

overridevirtual

ShouldRecordEvent()

bool FAnalyticsProviderET::ShouldRecordEvent ( const FString &  EventName ) const

overridevirtual

StartSession()

bool FAnalyticsProviderET::StartSession ( FString  InSessionID, const TArray< FAnalyticsEventAttribute > &  Attributes  )

overridevirtual

Tick()

bool FAnalyticsProviderET::Tick ( float  DeltaTime )

overridevirtual

Pure virtual that must be overloaded by the inheriting class.

Parameters

DeltaTime

time passed since the last call.

Returns

true if should continue ticking

Implements FTSTickerObjectBase.

---

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

• Engine/Source/Runtime/Analytics/AnalyticsET/Private/IAnalyticsProviderET.cpp