1. Epic GamesDeveloper
  3. FRPCDoSDetection

FRPCDoSDetection

RPC DoS detection

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Net

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/Net/RPCDoSDetection.h
Include #include "Net/RPCDoSDetection.h"

Syntax

class FRPCDoSDetection : protected FRPCDoSState

Remarks

RPC DoS detection

Implements DoS detection for NetConnection RPC's, using an escalating series of detection states depending on the severity of the DoS, to prevent false positives and minimize any performance impact.

RPC's are profiled based on count and execution time, with careful implementation of tracking to balance lookup speed, memory usage, timing, and analytics tracking.

Functions

  Type Name Description
Public function void

Init ( FName NetDriverName,
TSharedPtr< FNetAnalyticsAggregator >& AnalyticsAggregator,
FGetWorld&& InWorldFunc,
FGetRPCDoSAddress&& InAddressFunc,
FGetRPCDoSPlayerUID&& InPlayerUIDFunc,
FRPCDoSKickPlayer&& InKickPlayerFunc
)

 Initialize RPC DoS Detection, inputting callbacks for retrieving external information necessary for analytics.
Public function void

InitConfig ( FName NetDriverName
)

 Initializes configuration settings for RPC DoS Detection - with support for hot reloading
Public function Const bool Whether or not RPC DoS Detection is enabled
Public function void

LightweightReceivedRPC ( UFunction* Function,
FName FunctionName
)

 If RPC monitoring is disabled, does extremely lightweight tracking of RPC calls, for monitoring tracking triggers, and to allow a chance for deducing full RPC tracking information if monitoring is enabled while receiving (so that e.g. if an RPC DoS attack enables monitoring, information on the RPC responsible can be recovered).
Public function void Triggered upon NetConnection Close (for committing analytics)
Public function ERPCNotifyResult

NotifyReceivedRPC ( FNetBitReader& Reader,
TSet< FNetworkGUID >& UnmappedGuids,
UObject* Object,
UFunction* Function,
FName FunctionName
)

 If RPC monitoring is enabled, provides a notification for every RPC that is received, with the ability to block it.
Public function void

PostReceivedPacket ( double TimeSeconds
)

 Called after the current NetConnection receives a packet.
Public function void Called after the current NetConnection receives an RPC.
Public function void

PostReceivedRPCPacket ( double TimeSeconds
)

 Called after the current NetConnection receives a packet, when RPC DoS Detection is active and the packet contains an RPC.
Public function void

PostSequentialRPC ( EPostSequentialRPCType SequenceType,
double TimeSeconds,
FRPCDoSCounters* RPCCounter,
FRPCTrackingInfo* RPCTrackingInfo
)

 Called after the same RPC was received once or multiple times sequentially, for optimal timing
Public function void Called after the packet-loop TickDispatch
Public function void

PreReceivedPacket ( double TimeSeconds
)

 Called prior to the current NetConnection receiving a packet.
Public function void

PreTickDispatch ( double TimeSeconds
)

 Called prior to the packet-loop TickDispatch
Public function void

SetAddressFunc ( FGetRPCDoSAddress&& InAddressFunc
)

 Overrides the current AddressFunc
Public function void

SetKickPlayerFunc ( FRPCDoSKickPlayer&& InKickPlayerFunc
)

 Overrides the current KickPlayerFunc
Public function void

SetPlayerUIDFunc ( FGetRPCDoSPlayerUID&& InPlayerUIDFunc
)

 Overrides the current PlayerUIDFunc
Public function Const bool Whether or not monitoring of received RPC's (i.e. calling of NotifyReceivedRPC) should be performed

Constants

Name Description
DefaultActiveRPCTrackingSize Default size for ActiveRPCTracking, to minimize realloc
TimeQuotaCheckInterval Interval for time quota checks, in seconds

Deprecated Functions

  Type Name Description
Public function void

UpdateSeverity ( ERPCDoSSeverityUpdate Update,
ERPCDoSEscalateReason Reason
)

 UpdateSeverity will be made private soon.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page