FPacketAudit | Unreal Engine 5.7 Documentation

Uses inter-process-communication, to audit every stage of packet processing, for verifying that packets are processing properly, and that the client/server are in sync at every stage of reading/writing.

Since this relies on IPC, it is only suitable for testing on a single machine.

IMPORTANT: Only supports interaction between a single server, and a single client.


Name	FPacketAudit
Type	class
Header File	/Engine/Source/Runtime/Net/Core/Public/Net/Core/Misc/PacketAudit.h
Include Path	#include "Net/Core/Misc/PacketAudit.h"

Syntax

class FPacketAudit

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FPacketAudit ( FPlatformProcess::FSemaphore* InGameMutex )	Default constructorFPacketAudit	Net/Core/Misc/PacketAudit.h
FPacketAudit ()	Default constructor	Net/Core/Misc/PacketAudit.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
~FPacketAudit()	Default destructor	Net/Core/Misc/PacketAudit.h

Structs

Name	Remarks
FScopedAuditAccess	Provides scoped exclusive access to GSendPacketAudits and GReceivePacketAudits within the .cpp file

Functions

Protected

Name	Remarks	Include Path
void AddStage_Internal ( FString StageName, FBitWriter& OutPacket, bool bByteAligned )		Net/Core/Misc/PacketAudit.h
void CheckStage_Internal ( FString StageName, FBitReader& InPacket, bool bByteAligned )		Net/Core/Misc/PacketAudit.h
void DumpAuditData ( FScopedAuditAccess& AuditLock, uint32 InPacketCRC )	Dumps the collected packet audit data to the log	Net/Core/Misc/PacketAudit.h
void NotifyLowLevelReceive_Internal ( FBitReader& InPacket )		Net/Core/Misc/PacketAudit.h
void NotifyLowLevelSend_Internal ( FBitWriter& OutPacket )		Net/Core/Misc/PacketAudit.h

Static

Name	Remarks	Include Path
static void AddStage ( FString StageName, FBitWriter& OutPacket, bool bByteAligned )	On the send side, marks a named stage during packet writing, which should be audited on the receive side.	Net/Core/Misc/PacketAudit.h
static void CheckStage ( FString StageName, FBitReader& InPacket, bool bByteAligned )	On the receive side, checks to see that a named stage was marked for auditing on the send side, and audits the packet data.	Net/Core/Misc/PacketAudit.h
static void Destruct()	Destroy GPacketAuditor	Net/Core/Misc/PacketAudit.h
static void Init()	Initialize GPacketAudtor	Net/Core/Misc/PacketAudit.h
static void NotifyLowLevelReceive ( uint8* Data, uint32 DataLen )		Net/Core/Misc/PacketAudit.h
static void NotifyLowLevelReceive ( FBitReader& InPacket )	Low level netcode hook, notifying of incoming packets	Net/Core/Misc/PacketAudit.h
static void NotifyLowLevelSend ( FBitWriter& OutPacket )	Low level netcode hook, notifying of outgoing packets	Net/Core/Misc/PacketAudit.h
static void NotifyLowLevelSend ( uint8* Data, uint32 DataLen, uint32 DataLenBits )		Net/Core/Misc/PacketAudit.h
static uint32 PacketCRC ( uint8* Data, uint32 DataLenBits )	Gets the CRC of a packet, zeroing any unwritten bits in the last byte beforehand.	Net/Core/Misc/PacketAudit.h

Navigation