FNetAnalyticsAggregator Class Reference

#include <NetAnalytics.h>

Public Types
using	FAnalyticsAppender = TFunction< void(TArray< FAnalyticsEventAttribute > &)>

Public Member Functions
NETCORE_API	FNetAnalyticsAggregator (TSharedPtr< IAnalyticsProvider > InProvider, FName InNetDriverName)
	FNetAnalyticsAggregator ()=delete
NETCORE_API void	Init ()
NETCORE_API void	InitConfig ()
NETCORE_API void	AppendGameInstanceAttributes (TArray< FAnalyticsEventAttribute > &OutAttributes)
NETCORE_API void	SendAnalytics ()
NETCORE_API TNetAnalyticsDataPtr	RegisterAnalyticsData_Internal (TNetAnalyticsDataRef<> InData, const FName &InDataName, FString InTypeName)
const TSharedPtr< IAnalyticsProvider > &	GetAnalyticsProvider ()
FName	GetNetDriverName () const
NETCORE_API void	SetAnalyticsAppender (FAnalyticsAppender AppenderFunction)

Detailed Description

Central object (usually within NetDriver) which handles registration/retrieval/type-checking of net analytics data holders.

Member Typedef Documentation

FAnalyticsAppender

using FNetAnalyticsAggregator::FAnalyticsAppender = TFunction<void(TArray<FAnalyticsEventAttribute>&)>

Constructor & Destructor Documentation

FNetAnalyticsAggregator() [1/2]

FNetAnalyticsAggregator::FNetAnalyticsAggregator	(	TSharedPtr< IAnalyticsProvider >	InProvider,
		FName	InNetDriverName
	)

Base constructor

FNetAnalyticsAggregator

FNetAnalyticsAggregator() [2/2]

FNetAnalyticsAggregator::FNetAnalyticsAggregator ( )

delete

Member Function Documentation

AppendGameInstanceAttributes()

void FNetAnalyticsAggregator::AppendGameInstanceAttributes

(

TArray< FAnalyticsEventAttribute > &

OutAttributes

)

Adds game and engine specific attributes to the passed in array.

GetAnalyticsProvider()

const TSharedPtr< IAnalyticsProvider > & FNetAnalyticsAggregator::GetAnalyticsProvider ( )

inline

Accessor for AnalyticsProvider

GetNetDriverName()

FName FNetAnalyticsAggregator::GetNetDriverName ( ) const

inline

Accessor for NetDriverName

Init()

void FNetAnalyticsAggregator::Init

(

)

Initialize the net analytics aggregator

InitConfig()

void FNetAnalyticsAggregator::InitConfig

(

)

Initialize the net analytics aggregator config - must support hotfixing

RegisterAnalyticsData_Internal()

TNetAnalyticsDataPtr FNetAnalyticsAggregator::RegisterAnalyticsData_Internal	(	TNetAnalyticsDataRef<>	InData,
		const FName &	InDataName,
		FString	InTypeName
	)

Use REGISTER_NET_ANALYTICS instead. Internal function, which registers a net analytics data holder, with an associated key name, and does type checking to ensure there have been no mixups with the data holder type.

NOTE: May return nullptr! Analytics can be selectively enabled/disabled, based on the specified analytics data name.

Parameters

InData	The analytics data shared reference to be registered
InDataName	The name given for referencing the analytics data
InTypeName	Compile-time derived type name for the analytics data - for type checking

Returns

Returns the newly added analytics data shared reference

SendAnalytics()

void FNetAnalyticsAggregator::SendAnalytics

(

)

Tells the analytics data holders to finish aggregating their analytics data, and to dispatch it. Only called once, at NetDriver shutdown.

SetAnalyticsAppender()

void FNetAnalyticsAggregator::SetAnalyticsAppender

(

FAnalyticsAppender

AppenderFunction

)

---

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

• Engine/Source/Runtime/Net/Core/Public/Net/Core/Analytics/NetAnalytics.h
• Engine/Source/Runtime/Net/Core/Private/Net/Core/Analytics/NetAnalytics.cpp