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 > PacketHandler > PacketHandler

Light Theme

Dark Theme

PacketHandler

This class maintains an array of all [PacketHandler](API\Runtime\PacketHandler\PacketHandler) Components and forwards incoming and outgoing packets the each component

Windows

MacOS

Linux

Inheritance Hierarchy

FVirtualDestructor

PacketHandler

References

Module	PacketHandler
Header	/Engine/Source/Runtime/PacketHandlers/PacketHandler/Public/PacketHandler.h
Include	#include "PacketHandler.h"

Syntax

class PacketHandler : public FVirtualDestructor

Remarks

This class maintains an array of all PacketHandler Components and forwards incoming and outgoing packets the each component

Variables

		Name	Description
	Handler::Mode	Mode	Mode of the handler, Client or Server

Constructors

	Name	Description
	PacketHandler ( FDDoSDetection* InDDoS )	Base constructor PacketHandler

Name

Description

PacketHandler

(
FDDoSDetection* InDDoS
)

Base constructor

PacketHandler

Functions

	Name	Description
void	AddHandler ( TSharedPtr< HandlerComponent >& Ne..., bool bDeferInitialize )	Adds a HandlerComponent to the pipeline, prior to initialization (none can be added after initialization)
TSharedPtr< ...	AddHandler ( const FString& ComponentStr, bool bDeferInitialize )	As above, but initializes from a string specifying the component module, and (optionally) additional options
void	BeginHandshaking ( FPacketHandlerHandshakeComplete InH... )	Triggered by the higher level netcode, to begin any required HandlerComponent handshakes
void	CountBytes ( FArchive& Ar )
bool	DoesAnyProfileHaveComponent ( const FString& InComponentName )	Searches the PacketHandler profile configurations to find if a component is listed.
bool	DoesProfileHaveComponent ( const FName InNetDriverName, const FString& InComponentName )	Searches the PacketHandler profile configuration for the given netdriver to find if a component is listed.
FPacketHandl...	GetAddComponentByNameDelegate()
FPacketHandl...	GetAddComponentDelegate()
TSharedPtr< ...	GetAggregator()	Returns the analytics aggregator
TSharedPtr< ...	GetComponentByName ( FName ComponentName )	Returns a pointer to the first component in the HandlerComponents array with the specified name.
FDDoSDetecti...	GetDDoS()	Returns a pointer to the DDoS detection handler
TSharedPtr< ...	GetEncryptionComponent()	Returns a pointer to the component set as the encryption handler, if any.
TSharedPtr< ...	GetProvider()	Returns the analytics provider
BufferedPack...	GetQueuedConnectionlessPacket()	Gets a packet from the buffered connectionless packet queue for sending
BufferedPack...	GetQueuedPacket()	Gets a packet from the buffered packet queue for sending
BufferedPack...	GetQueuedRawPacket()	Gets a packet from the buffered packet queue for sending (as a raw packet)
bool	GetRawSend()	Whether or not raw packet sends are enabled
int32	GetTotalReservedPacketBits()	Gets the combined reserved packet/protocol bits from all handlers, for reserving space in the parent connections packets
void	HandlerComponentInitialized ( HandlerComponent* InComponent )	Triggered when a child HandlerComponent has been initialized
EIncomingRes...	Incoming ( FReceivedPacketView& PacketView )	Processes incoming packets at the PacketHandler level, before any UNetConnection processing takes place on the packet.
EIncomingRes...	Incoming_Internal ( FReceivedPacketView& PacketView )	Internal handling for Incoming/IncomingConnectionless
EIncomingRes...	IncomingConnectionless ( FReceivedPacketView& PacketView )	Processes incoming packets without a UNetConnection, in the same manner as 'Incoming' above IMPORTANT: Net drivers triggering this, should call 'UNetDriver::FlushHandler' shortly afterwards, to minimize packet buffering
void	IncomingHigh ( FBitReader& Reader )	Add runtime-calculated arrays for each packet pipeline type, to reduce redundant iterations, (there are 3x iterations now, 1 for each packet pipeline type), and to ignore inactive HandlerComponent's
void	Initialize ( Handler::Mode Mode, uint32 InMaxPacketBits, bool bConnectionlessOnly, TSharedPtr< class IAnalyticsProvide..., FDDoSDetection* InDDoS, FName InDriverProfile )	Handles initialization of manager
void	InitializeComponents()	Triggers initialization of HandlerComponents.
void	InitializeDelegates ( FPacketHandlerLowLevelSendTraits In... )	Used for external initialization of delegates
bool	IsFullyInitialized()	Whether or not the packet handler is fully initialized, post-handshake etc.
void	NotifyAnalyticsProvider ( TSharedPtr< IAnalyticsProvider > In..., TSharedPtr< FNetAnalyticsAggregator... )	Notification that the NetDriver analytics provider has been updated (NOT called on first initialization)
const Proces...	Outgoing ( uint8* Packet, int32 CountBits, FOutPacketTraits& Traits )	Processes outgoing packets at the PacketHandler level, after all UNetConnection processing.
const Proces...	Outgoing_Internal ( uint8* Packet, int32 CountBits, FOutPacketTraits& Traits, bool bConnectionless, const TSharedPtr< const FInternetAd... )	Internal handling for Outgoing/OutgoingConnectionless
const Proces...	OutgoingConnectionless ( const TSharedPtr< const FInternetAd..., uint8* Packet, int32 CountBits, FOutPacketTraits& Traits )	Processes outgoing packets without a UNetConnection, in the same manner as 'Outgoing' above
void	OutgoingHigh ( FBitWriter& Writer )	Work in progress, don't use yet.
void	QueueHandlerPacketForSending ( BufferedPacket* PacketToQueue )	Queue's a packet to be sent through 'SendHandlerPacket'
void	QueuePacketForRawSending ( BufferedPacket* PacketToQueue )	Queue's a packet to be sent when the handler is ticked (as a raw packet, since it's already been processed)
void	SendHandlerPacket ( HandlerComponent* InComponent, FBitWriter& Writer, FOutPacketTraits& Traits )	Send a packet originating from a HandlerComponent - will process through the HandlerComponents chain, starting after the triggering component.
void	SetRawSend ( bool bInEnabled )	Sets whether or not outgoing packets should bypass this handler - used when raw packet sends are necessary (such as for the stateless handshake)
void	Tick ( float DeltaTime )

Deprecated Functions

	Name	Description
const Proces...	Incoming ( uint8* Packet, int32 CountBytes )	Incoming now uses FReceivedPacketView.
const Proces...	Incoming_Internal ( uint8* Packet, int32 CountBytes, bool bConnectionless, const TSharedPtr< const FInternetAd... )	Incoming_Internal now uses FReceivedPacketView
const Proces...	IncomingConnectionless ( const TSharedPtr< const FInternetAd..., uint8* Packet, int32 CountBytes )	IncomingConnectionless now uses FReceivedPacketView.

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

Take our survey

Dismiss