FDelinquencyAnalytics Struct Reference

#include <NetAnalyticsTypes.h>

Public Member Functions
ENGINE_API	FDelinquencyAnalytics (const uint32 InNumberOfTopOffendersToTrack)
ENGINE_API	FDelinquencyAnalytics (FDelinquencyAnalytics &&Other)
	FDelinquencyAnalytics (const FDelinquencyAnalytics &)=delete
const FDelinquencyAnalytics &	operator= (const FDelinquencyAnalytics &)=delete
FDelinquencyAnalytics &	operator= (FDelinquencyAnalytics &&)=default
void	Emplace (FName Name, float TimeSeconds)
ENGINE_API void	Add (FDelinquencyNameTimePair &&ToTrack)
const TArray< FDelinquencyNameTimePair > &	GetTopOffenders () const
const TSet< FDelinquencyNameTimePair, FDelinquencyKeyFuncs > &	GetAllDelinquents () const
const float	GetTotalTime () const
const uint32	GetNumberOfTopOffendersToTrack () const
ENGINE_API void	Reset ()
ENGINE_API void	CountBytes (class FArchive &Ar) const

Detailed Description

Convenience type that can be used to tracks information about things that can result in prolonged periods of apparent network inactivity, despite actually receiving traffic.

The overall number of entries is expected to be small, but ultimately is left up to callers.

Constructor & Destructor Documentation

FDelinquencyAnalytics() [1/3]

FDelinquencyAnalytics::FDelinquencyAnalytics ( const uint32  InNumberOfTopOffendersToTrack )

explicit

FDelinquencyAnalytics() [2/3]

FDelinquencyAnalytics::FDelinquencyAnalytics

(

FDelinquencyAnalytics &&

Other

)

FDelinquencyAnalytics() [3/3]

FDelinquencyAnalytics::FDelinquencyAnalytics ( const FDelinquencyAnalytics &  )

delete

Member Function Documentation

Add()

void FDelinquencyAnalytics::Add

(

FDelinquencyNameTimePair &&

ToTrack

)

Adds the event to the delinquency tracking, by accumulating its time into total time, and updating any existing events to choose the one with the highest time.

When NumberOfTopOffendersToTrack == 0, we will just track the set of all events as well as the total time.

When NumberOfTopOffendersToTrack > 0, we will track the set, total time, and also maintain sorted list (highest to lowest) of events that occurred.

By setting NumberOfTopOffendersToTrack to 0, users can manage their own lists of "TopOffenders", or otherwise avoid the per add overhead of this tracking.

CountBytes()

void FDelinquencyAnalytics::CountBytes

(

class FArchive &

Ar

)

const

Emplace()

void FDelinquencyAnalytics::Emplace ( FName  Name, float  TimeSeconds  )

inline

GetAllDelinquents()

const TSet< FDelinquencyNameTimePair, FDelinquencyKeyFuncs > & FDelinquencyAnalytics::GetAllDelinquents ( ) const

inline

GetNumberOfTopOffendersToTrack()

const uint32 FDelinquencyAnalytics::GetNumberOfTopOffendersToTrack ( ) const

inline

GetTopOffenders()

const TArray< FDelinquencyNameTimePair > & FDelinquencyAnalytics::GetTopOffenders ( ) const

inline

GetTotalTime()

const float FDelinquencyAnalytics::GetTotalTime ( ) const

inline

operator=() [1/2]

const FDelinquencyAnalytics & FDelinquencyAnalytics::operator= ( const FDelinquencyAnalytics &  )

delete

operator=() [2/2]

FDelinquencyAnalytics & FDelinquencyAnalytics::operator= ( FDelinquencyAnalytics &&  )

default

Reset()

void FDelinquencyAnalytics::Reset

(

)

---

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

• Engine/Source/Runtime/Engine/Public/Net/NetAnalyticsTypes.h
• Engine/Source/Runtime/Engine/Private/Net/NetAnalyticsTypes.cpp