FNetFaultState Struct Reference

#include <NetConnectionFaultRecoveryBase.h>

Inheritance diagram for FNetFaultState:

Static Public Member Functions
static NETCORE_API const TCHAR *	GetConfigSection ()
static NETCORE_API UClass *	GetBaseConfigClass ()

Public Attributes
bool	bCloseConnection = false
int16	EscalateQuotaFaultsPerPeriod = -1
int8	EscalateQuotaFaultPercentPerPeriod = -1
int16	DescalateQuotaFaultsPerPeriod = -1
int8	DescalateQuotaFaultPercentPerPeriod = -1
int8	EscalateQuotaTimePeriod = -1
Public Attributes inherited from FEscalationState
friend	UEscalationManagerConfig
bool	bLogEscalate = false
bool	bDormant = false
int16	CooloffTime = -1
int16	AutoEscalateTime = -1

Protected Member Functions
virtual NETCORE_API EInitStateDefaultsResult	InitConfigDefaultsInternal () override
virtual NETCORE_API void	ApplyImpliedValuesInternal () override
virtual NETCORE_API void	ValidateConfigInternal () override
Protected Member Functions inherited from FEscalationState
NETCORE_API void	ValidateTimePeriod (int8 &Value, const TCHAR *PropertyName, EValidateTime Requirement=EValidateTime::Optional)

Additional Inherited Members
Public Member Functions inherited from FEscalationState
NETCORE_API bool	IsDormant () const
NETCORE_API int8	GetHighestTimePeriod () const
NETCORE_API const TArray< int8 > &	GetAllTimePeriods () const
Public Member Functions inherited from FStateStruct
virtual	~FStateStruct ()
NETCORE_API FString	GetStateName () const
Protected Types inherited from FEscalationState
enum class	EValidateTime : uint8 { Optional , MustBeSet }
Protected Attributes inherited from FEscalationState
int8	HighestTimePeriod = 0
TArray< int8 >	AllTimePeriods

Detailed Description

Generic escalation state definition used to implement attempted recovery from faults/errors in the NetConnection level netcode. Fault handlers may have their own separate escalation tracking.

Member Function Documentation

ApplyImpliedValuesInternal()

void FNetFaultState::ApplyImpliedValuesInternal ( )

overrideprotectedvirtual

Reimplemented from FStateStruct.

GetBaseConfigClass()

UClass * FNetFaultState::GetBaseConfigClass ( )

static

GetConfigSection()

const TCHAR * FNetFaultState::GetConfigSection ( )

static

FNetFaultState

InitConfigDefaultsInternal()

EInitStateDefaultsResult FNetFaultState::InitConfigDefaultsInternal ( )

overrideprotectedvirtual

To be implemented by subclasses

Reimplemented from FStateStruct.

ValidateConfigInternal()

void FNetFaultState::ValidateConfigInternal ( )

overrideprotectedvirtual

FEscalationState

Reimplemented from FEscalationState.

Member Data Documentation

bCloseConnection

bool FNetFaultState::bCloseConnection = false

Whether or not the current escalation state should immediately Close the connection

DescalateQuotaFaultPercentPerPeriod

int8 FNetFaultState::DescalateQuotaFaultPercentPerPeriod = -1

Percentage of faults out of total number of recent packets, before de-escalating into this state (adds hysteresis/lag to state changes)

DescalateQuotaFaultsPerPeriod

int16 FNetFaultState::DescalateQuotaFaultsPerPeriod = -1

The number of faults per period before de-escalating into this state (adds hysteresis/lag to state changes)

EscalateQuotaFaultPercentPerPeriod

int8 FNetFaultState::EscalateQuotaFaultPercentPerPeriod = -1

Percentage of faults out of total number of recent packets, before the next stage of escalation is triggered

EscalateQuotaFaultsPerPeriod

int16 FNetFaultState::EscalateQuotaFaultsPerPeriod = -1

Escalation limits - for escalating to a more strict fault state The number of faults per period before the next stage of escalation is triggered

EscalateQuotaTimePeriod

int8 FNetFaultState::EscalateQuotaTimePeriod = -1

The time period to use for determining escalation/de-escalation quotas (Max: 16)

---

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

• Engine/Source/Runtime/Net/Core/Public/Net/Core/Connection/NetConnectionFaultRecoveryBase.h
• Engine/Source/Runtime/Net/Core/Private/Net/Core/Connection/NetConnectionFaultRecoveryBase.cpp