UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TBasicNetAnalyticsData< TDataStruct > Struct Template Reference

#include <NetAnalytics.h>

+ Inheritance diagram for TBasicNetAnalyticsData< TDataStruct >:

Public Member Functions

 GENERATE_MEMBER_FUNCTION_CHECK (CommitAnalytics, void,, TDataStruct &)
 
void CommitAnalytics (TDataStruct &AnalyticsVars)
 
- Public Member Functions inherited from FNetAnalyticsData
NETCORE_API FNetAnalyticsData ()
 
virtual NETCORE_API ~FNetAnalyticsData ()
 
virtual void SendAnalytics ()=0
 
- Public Member Functions inherited from FVirtualDestructor
virtual ~FVirtualDestructor ()
 
- Public Member Functions inherited from TSharedFromThis< FNetAnalyticsData, NetAnalyticsThreadSafety >
TSharedRef< FNetAnalyticsData, Mode > AsShared ()
 
TSharedRef< FNetAnalyticsData const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< FNetAnalyticsData, Mode > AsWeak ()
 
TWeakPtr< FNetAnalyticsData 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 FNetAnalyticsData
virtual NETCORE_API void InternalSendAnalytics ()
 
virtual void NotifyFinalRelease ()
 
- Protected Member Functions inherited from TSharedFromThis< FNetAnalyticsData, NetAnalyticsThreadSafety >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from TSharedFromThis< FNetAnalyticsData, NetAnalyticsThreadSafety >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 
- Protected Attributes inherited from FNetAnalyticsData
FNetAnalyticsAggregatorAggregator
 

Detailed Description

template<class TDataStruct>
struct TBasicNetAnalyticsData< TDataStruct >

Basic single-threaded-only (i.e. good for NetConnection level code) analytics data holder, which just wraps around a simple struct, which defines the analytics variables and implements their aggregation.

The passed in struct will have to implement a CommitAnalytics function, which implements aggregation of the struct data, and the class which references this net analytics data will have to trigger this classes CommitAnalytics on the locally stored struct, when finished collecting local analytics data.

Member Function Documentation

◆ CommitAnalytics()

template<class TDataStruct >
void TBasicNetAnalyticsData< TDataStruct >::CommitAnalytics ( TDataStruct &  AnalyticsVars)
inline

Called by the class/code which is locally collecting analytics data, to commit the local data for aggregation when done.

Parameters
AnalyticsVarsThe local analytics variables to be committed/aggregated

◆ GENERATE_MEMBER_FUNCTION_CHECK()

template<class TDataStruct >
TBasicNetAnalyticsData< TDataStruct >::GENERATE_MEMBER_FUNCTION_CHECK ( CommitAnalytics  ,
void  ,
TDataStruct &   
)

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