UE::Net::TEscalationManager< CountersEnum, EscalationStateType, CounterCategoriesEnum > Class Template Reference

#include <EscalationStates.h>

Inheritance diagram for UE::Net::TEscalationManager< CountersEnum, EscalationStateType, CounterCategoriesEnum >:

Public Member Functions
	TEscalationManager ()
void	Init (FString ConfigContext)
int32	AddNewCounter (int32 Count=1)
void	RegisterCounterCategory (int32 CategoryIndex, int32 CounterIndex)
Public Member Functions inherited from UE::Net::FEscalationManager
FEscalationCounter &	GetFrameCounter (int32 CounterIndex)
NETCORE_API void	CheckQuotas ()
NETCORE_API void	TickRealtime (double TimeSeconds)
bool	DoesRequireTick () const
NETCORE_API bool	IsDormant () const
NETCORE_API const UEscalationManagerConfig *	GetBaseConfig () const
NETCORE_API void	SetManagerContext (FString InManagerContext)
NETCORE_API void	SetNotifySeverityUpdate (FNotifySeverityUpdate &&InNotifySeverityUpdate)

Detailed Description

template<typename CountersEnum, typename EscalationStateType, typename CounterCategoriesEnum = EEmptyCategories>
class UE::Net::TEscalationManager< CountersEnum, EscalationStateType, CounterCategoriesEnum >

Manages initialization/application of escalation states for the specified escalation state type, and allocation/tracking of the specified counters/timers used to calculate state change quotas/thresholds.

The different counter types are specified in sequential order in the 'CountersEnum' enum, followed by a final/unused Max value.

Constructor & Destructor Documentation

TEscalationManager()

template<typename CountersEnum , typename EscalationStateType , typename CounterCategoriesEnum = EEmptyCategories>

UE::Net::TEscalationManager< CountersEnum, EscalationStateType, CounterCategoriesEnum >::TEscalationManager ( )

inline

Base constructor

Member Function Documentation

AddNewCounter()

template<typename CountersEnum , typename EscalationStateType , typename CounterCategoriesEnum = EEmptyCategories>

int32 UE::Net::TEscalationManager< CountersEnum, EscalationStateType, CounterCategoriesEnum >::AddNewCounter ( int32  Count = 1 )

inline

Dynamically adds a new counter not specified in CountersEnum, and returns its index. If NumPrealloc (or Max if not specified) is exceeded, counter tracking will switch from inline allocation to the heap.

Parameters

Count

The number of counters to add

Returns

The index of the first added counter

Init()

template<typename CountersEnum , typename EscalationStateType , typename CounterCategoriesEnum = EEmptyCategories>

void UE::Net::TEscalationManager< CountersEnum, EscalationStateType, CounterCategoriesEnum >::Init ( FString  ConfigContext )

inline

Initializes the escalation manager

Parameters

ConfigContext

Additional context to use for state configuration (e.g. NetDriver name, to separate config for each NetDriver)

RegisterCounterCategory()

template<typename CountersEnum , typename EscalationStateType , typename CounterCategoriesEnum = EEmptyCategories>

void UE::Net::TEscalationManager< CountersEnum, EscalationStateType, CounterCategoriesEnum >::RegisterCounterCategory ( int32  CategoryIndex, int32  CounterIndex  )

inline

Registers a counter for automatic processing under the specified counter category, as set by CounterCategoriesEnum (each category can implement a different type of custom processing, in HasHitAnyQuota)

Parameters

CategoryIndex	The processing category the counter should be registered under
CounterIndex	The index of the counter to register

---

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

• Engine/Source/Runtime/Net/Core/Public/Net/Core/Connection/EscalationStates.h