UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
PacketHandler.cpp File Reference

Macros

#define NET_LIGHTWEIGHT_TIME_GUARD_BEGIN(Name, ThresholdMS)
 
#define NET_LIGHTWEIGHT_TIME_GUARD_END(Name, NameStringCode)
 

Functions

 IMPLEMENT_MODULE (FPacketHandlerComponentModuleInterface, PacketHandler)
 
 DEFINE_LOG_CATEGORY (PacketHandlerLog)
 
 DECLARE_CYCLE_STAT (TEXT("PacketHandler Incoming_Internal"), Stat_PacketHandler_Incoming_Internal, STATGROUP_Net)
 
 DECLARE_CYCLE_STAT (TEXT("PacketHandler Outgoing_Internal"), Stat_PacketHandler_Outgoing_Internal, STATGROUP_Net)
 
template<typename OutType , typename InType >
OutType IntCastLog (InType In)
 

Variables

int32 GPacketHandlerCRCDump = 0
 
FAutoConsoleVariableRef CVarNetPacketHandlerCRCDump (TEXT("net.PacketHandlerCRCDump"), GPacketHandlerCRCDump, TEXT("Enables or disables dumping of packet CRC's for every HandlerComponent, Incoming and Outgoing, for debugging."))
 
bool GPacketHandlerDiscardTimeguardMeasurement = false
 

Macro Definition Documentation

◆ NET_LIGHTWEIGHT_TIME_GUARD_BEGIN

#define NET_LIGHTWEIGHT_TIME_GUARD_BEGIN (   Name,
  ThresholdMS 
)
Value:
uint64 PREPROCESSOR_JOIN(__TimeGuard_StartCycles_, Name) = ( ThresholdMS > 0.0f && GPacketHandlerTimeguardLimit > 0 ) ? FPlatformTime::Cycles64() : 0; \
FPlatformTypes::uint64 uint64
A 64-bit unsigned integer.
Definition Platform.h:1117
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
bool GPacketHandlerDiscardTimeguardMeasurement
Definition PacketHandler.cpp:43
#define PREPROCESSOR_JOIN(TokenA, TokenB)
Definition PreprocessorHelpers.h:104
static uint64 Cycles64()
Definition AndroidPlatformTime.h:34

◆ NET_LIGHTWEIGHT_TIME_GUARD_END

#define NET_LIGHTWEIGHT_TIME_GUARD_END (   Name,
  NameStringCode 
)
Value:
if ( PREPROCESSOR_JOIN(__TimeGuard_ThresholdMS_, Name) > 0.0f && GPacketHandlerTimeguardLimit > 0 && !GPacketHandlerDiscardTimeguardMeasurement ) \
{\
{ \
GPacketHandlerTimeguardLimit--; \
} \
}
#define TEXT(x)
Definition Platform.h:1272
static double ToMilliseconds64(const uint64 Cycles)
Definition GenericPlatformTime.h:202

Function Documentation

◆ DECLARE_CYCLE_STAT() [1/2]

DECLARE_CYCLE_STAT ( TEXT("PacketHandler Incoming_Internal" ,
Stat_PacketHandler_Incoming_Internal  ,
STATGROUP_Net   
)

◆ DECLARE_CYCLE_STAT() [2/2]

DECLARE_CYCLE_STAT ( TEXT("PacketHandler Outgoing_Internal" ,
Stat_PacketHandler_Outgoing_Internal  ,
STATGROUP_Net   
)

◆ DEFINE_LOG_CATEGORY()

DEFINE_LOG_CATEGORY ( PacketHandlerLog  )

◆ IMPLEMENT_MODULE()

◆ IntCastLog()

OutType IntCastLog ( InType  In)

Variable Documentation

◆ CVarNetPacketHandlerCRCDump

FAutoConsoleVariableRef CVarNetPacketHandlerCRCDump(TEXT("net.PacketHandlerCRCDump"), GPacketHandlerCRCDump, TEXT("Enables or disables dumping of packet CRC's for every HandlerComponent, Incoming and Outgoing, for debugging.")) ( TEXT("net.PacketHandlerCRCDump")  ,
GPacketHandlerCRCDump  ,
TEXT("Enables or disables dumping of packet CRC's for every HandlerComponent, Incoming and Outgoing, for debugging."  
)

◆ GPacketHandlerCRCDump

int32 GPacketHandlerCRCDump = 0

◆ GPacketHandlerDiscardTimeguardMeasurement

bool GPacketHandlerDiscardTimeguardMeasurement = false