Navigation
API > API/Runtime > API/Runtime/NetCore
Manages initialization/application of escalation states, and tracking various counters/timers used to calculate state change quotas/thresholds.
| Name | FEscalationManager |
| Type | class |
| Header File | /Engine/Source/Runtime/Net/Core/Public/Net/Core/Connection/EscalationStates.h |
| Include Path | #include "Net/Core/Connection/EscalationStates.h" |
Syntax
class FEscalationManager
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Net/Core/Connection/EscalationStates.h | |||
FEscalationManager
(
FEscalationManagerParms Parms |
FEscalationManager | Net/Core/Connection/EscalationStates.h |
Classes
| Name | Remarks |
|---|---|
| TStructOnScopeLite | Simple type wrapper for FStructOnScope, without any allocation and without owning the memory |
Structs
| Name | Remarks |
|---|---|
| FEscalationManagerInitParms | |
| FEscalationManagerParms |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveState | int8 | The currently active escalation severity state settings | Net/Core/Connection/EscalationStates.h | |
| BaseConfig | const UEscalationManagerConfig * | The state configuration object for this manager | Net/Core/Connection/EscalationStates.h | |
| bEnabled | bool | Whether or not this escalation manager is enabled | Net/Core/Connection/EscalationStates.h | |
| CountersPerPeriodHistory | TArrayView< FEscalationCounter > | Counter history which is precalculated/cached from CountersPerSecHistory, for tracking per-period time (up to a maximum of 16s) | Net/Core/Connection/EscalationStates.h | |
| CountersPerSecHistory | TArray< TArrayView< FEscalationCounter > > | Stores enough per second quota history, to allow all EscalationSeverity states to recalculate if their CooloffTime is reached | Net/Core/Connection/EscalationStates.h | |
| CountersPerSecHistoryAlloc | TArray< FEscalationCounter > | Allocation for the above array, to reduce indirection | Net/Core/Connection/EscalationStates.h | |
| FrameCounters | TArrayView< FEscalationCounter > | Per-frame counters | Net/Core/Connection/EscalationStates.h | |
| LastCountersPerSecHistoryIdx | int32 | The last written index of CountersPerSecHistory | Net/Core/Connection/EscalationStates.h | |
| LastMetEscalationConditions | double | The last time the previous severity states escalation conditions were met (to prevent bouncing up/down between states) | Net/Core/Connection/EscalationStates.h | |
| LastPerSecQuotaBegin | double | Timestamp for the last time per-second quota counting began | Net/Core/Connection/EscalationStates.h | |
| ManagerContext | FString | Extra context to use when logging severity state updates (e.g. Player IP) | Net/Core/Connection/EscalationStates.h | |
| NotifySeverityUpdate | FNotifySeverityUpdate | The callback to use to notify of state severity escalation/de-escalation | Net/Core/Connection/EscalationStates.h | |
| NumCounters | int32 | The number of different counter types this escalation manager keeps track of | Net/Core/Connection/EscalationStates.h | |
| RegisteredCounters | const TArrayView< TArrayView< int32 > > | Lists of registered counters, per category | Net/Core/Connection/EscalationStates.h | |
| SecondCounters | TArrayView< FEscalationCounter > | Per-second counters (approximate - may cover more than one second, in the case of expensive/long-running counted events) | Net/Core/Connection/EscalationStates.h | |
| State | TStructOnScopeLite< FEscalationState > | The managers escalation state | Net/Core/Connection/EscalationStates.h | |
| UEscalationManagerConfig | friend | Net/Core/Connection/EscalationStates.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CheckQuotas() |
Checks if any escalation quota's have been hit, and if so, updates/escalates the severity state | Net/Core/Connection/EscalationStates.h | |
bool DoesRequireTick() |
Whether or not calls to Tick are presently required | Net/Core/Connection/EscalationStates.h | |
const UEscalationManagerConfig * GetBaseConfig() |
Returns a reference to the BaseConfig object | Net/Core/Connection/EscalationStates.h | |
FEscalationCounter & GetFrameCounter
(
int32 CounterIndex |
Accessor for the current frames counter (this is the primary place where counters are incremented). | Net/Core/Connection/EscalationStates.h | |
bool IsDormant() |
Whether or not the current state is a dormant state, which does not require ticking | Net/Core/Connection/EscalationStates.h | |
void SetManagerContext
(
FString InManagerContext |
Sets a new ManagerContext value | Net/Core/Connection/EscalationStates.h | |
void SetNotifySeverityUpdate
(
FNotifySeverityUpdate&& InNotifySeverityUpdate |
Sets a new NotifySeverityUpdate value | Net/Core/Connection/EscalationStates.h | |
void TickRealtime
(
double TimeSeconds |
Ticks the escalation manager NOTE: This takes the current time, in seconds, rather than DeltaTime. | Net/Core/Connection/EscalationStates.h |