Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > NetCore > Net > Core > Misc > FDDoSDetection

Light Theme

Dark Theme

FDDoSDetection

The main DDoS detection tracking class, for counting packets and applying restrictions.

Windows

MacOS

Linux

Inheritance Hierarchy

FDDoSPacketCounters

FDDoSState

FDDoSDetection

References

Module	NetCore
Header	/Engine/Source/Runtime/Net/Core/Public/Net/Core/Misc/DDoSDetection.h
Include	#include "Net/Core/Misc/DDoSDetection.h"

Syntax

class FDDoSDetection :
protected FDDoSPacketCounters,
protected FDDoSState

Remarks

The main DDoS detection tracking class, for counting packets and applying restrictions. Implemented separate to the NetDriver, to allow wider use e.g. potentially at socket level, if useful.

Variables

	Name	Description
int8	ActiveState	The currently active DDoS severity state settings
bool	bDDoSAnalytics	Whether or not analytics for DDoS detection is enabled
bool	bDDoSDetection	Whether or not DDoS detection is presently enabled
bool	bDDoSLogRestrictions	Whether or not restriction of log messages from non-NetConnection packets is enabled
bool	bHitFrameNetConnLimit	Whether or not the current frame has reached NetConnection packet limits, and should block ALL further packets
bool	bHitFrameNonConnLimit	Whether or not the current frame has reached non-NetConnection packet limits, and should block non-NetConnection packets
bool	bMetEscalationConditionsThisFrame	Limit checking previous states escalation conditions to once per frame
TArray< FDDoSPa...	CounterPerSecHistory	Stores enough per second quota history, to allow all DetectionSeverity states to recalculate if their CooloffTime is reached
int32	DDoSLogSpamLimit	The maximum number of non-NetConnection triggered log messages per frame, before further logs are dropped this frame
TArray< FDDoSSt...	DetectionSeverity	The different DDoS detection states, of escalating severity, depending on the strength of the DDoS
double	EndFrameRecvTimestamp	Timestamp for the end of the last frames receive loop
double	ExpectedFrameTime	The expected time between frames (1.0 / MaxTickRate) - used for adjusting limits/quota's based on DeltaTime
float	FrameAdjustment	The current frames adjustment/deviation, from ExpectedFrameTime
int32	HitchFrameCount	The number of consecutive frames spent hitching
int8	HitchFrameTolerance	The number of frames spent hitching, before disabling false positive detection, and treating packet buildup as potential DDoS
int32	HitchTimeQuotaMS	The amount of time since the previous frame, for detecting frame hitches, to prevent DDoS detection false positives
int32	LastCounterPerSecHistoryIdx	The last written index of CounterPerSecHistory
double	LastMetEscalationConditions	The last time the previous severity states escalation conditions were met (to prevent bouncing up/down between states)
double	LastPerSecQuotaBegin	Timestamp for the last time per-second quota counting began
int32	LogHitCounter	Counter for log restriction hits, in the current frame
FDDoSSeverityEs...	NotifySeverityEscalation	Analytics delegate for notifying of severity state escalations
int32	StartFramePacketCount	Counts the packets from the start of the current frame
double	StartFrameRecvTimestamp	The timestamp for the start of the current frames receive
int8	WorstActiveState	The worst DDoS severity state that has been active - used for limiting analytics events

Constructors

	Name	Description
	FDDoSDetection()	Default constructor

Functions

	Name	Description
bool	CheckLogRestrictions()	Accessor for bDDoSLogRestrictions - doubles as a per-frame logspam counter, automatically disabling logs after a quota
bool	CheckNetConnLimits()	Performs periodic checks on NetConnection packet limits
bool	CheckNonConnQuotasAndLimits()	Performs periodic checks on trigger quota's and packet limits, for non-NetConnection packets
void	CondCheckNetConnLimits()	Rate limited call to CheckNetConnLimits
void	CondCheckNonConnQuotasAndLimits()	Rate limited call to CheckNonConnQuotasAndLimits
int32	GetBadPacketCounter()
int32	GetDisconnPacketCounter()
int32	GetDroppedPacketCounter()
int32	GetErrorPacketCounter()
int32	GetNetConnPacketCounter()
int32	GetNonConnPacketCounter()
void	IncBadPacketCounter()
void	IncDisconnPacketCounter()
void	IncDroppedPacketCounter ( int32 Count )
void	IncErrorPacketCounter()
void	IncNetConnPacketCounter()
void	IncNonConnPacketCounter()
void	Init ( int32 MaxTickRate )	Initializes the DDoS detection settings
void	InitConfig()	Initializes the settings from the .ini file - must support reloading of settings on-the-fly
bool	IsDDoSAnalyticsEnabled()
bool	IsDDoSDetectionEnabled()
void	PostFrameReceive()	Triggered after packet receive ends, during the current frame
void	PreFrameReceive ( float DeltaTime )	Triggered before packet receive begins, during the current frame
bool	ShouldBlockNetConnPackets()
bool	ShouldBlockNonConnPackets()
void	UpdateSeverity ( bool bEscalate )	Updates the current DDoS detection severity state

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss