#include <PacketHandler.h>

Inheritance diagram for PacketHandler:

Public Member Functions
	PacketHandler (ReadOnlyTargetRules Target)

PACKETHANDLER_API	PacketHandler (FDDoSDetection *InDDoS=nullptr)

PACKETHANDLER_API void	Initialize (UE::Handler::Mode Mode, uint32 InMaxPacketBits, bool bConnectionlessOnly=false, TSharedPtr< class IAnalyticsProvider > InProvider=nullptr, FDDoSDetection *InDDoS=nullptr, FName InDriverProfile=NAME_None)

PACKETHANDLER_API void	InitializeDelegates (FPacketHandlerLowLevelSendTraits InLowLevelSendDel, FPacketHandlerNotifyAddHandler InAddHandlerDel=FPacketHandlerNotifyAddHandler())

PACKETHANDLER_API void	InitFaultRecovery (UE::Net::FNetConnectionFaultRecoveryBase *InFaultRecovery)

PACKETHANDLER_API void	NotifyAnalyticsProvider (TSharedPtr< IAnalyticsProvider > InProvider, TSharedPtr< FNetAnalyticsAggregator > InAggregator)

PACKETHANDLER_API void	InitializeComponents ()

PACKETHANDLER_API void	BeginHandshaking (FPacketHandlerHandshakeComplete InHandshakeDel=FPacketHandlerHandshakeComplete())

PACKETHANDLER_API void	Tick (float DeltaTime)

PACKETHANDLER_API void	AddHandler (TSharedPtr< HandlerComponent > &NewHandler, bool bDeferInitialize=false)

PACKETHANDLER_API TSharedPtr< HandlerComponent >	AddHandler (const FString &ComponentStr, bool bDeferInitialize=false)

PACKETHANDLER_API void	IncomingHigh (FBitReader &Reader)

PACKETHANDLER_API void	OutgoingHigh (FBitWriter &Writer)

const ProcessedPacket	Incoming (uint8 *Packet, int32 CountBytes)

EIncomingResult	Incoming (FReceivedPacketView &PacketView)

const ProcessedPacket	Outgoing (uint8 *Packet, int32 CountBits, FOutPacketTraits &Traits)

const ProcessedPacket	IncomingConnectionless (const TSharedPtr< const FInternetAddr > &Address, uint8 *Packet, int32 CountBytes)

EIncomingResult	IncomingConnectionless (FReceivedPacketView &PacketView)

const ProcessedPacket	OutgoingConnectionless (const TSharedPtr< const FInternetAddr > &Address, uint8 *Packet, int32 CountBits, FOutPacketTraits &Traits)

PACKETHANDLER_API TSharedPtr< FEncryptionComponent >	GetEncryptionComponent ()

PACKETHANDLER_API TSharedPtr< HandlerComponent >	GetComponentByName (FName ComponentName) const

PACKETHANDLER_API void	CountBytes (FArchive &Ar) const

PACKETHANDLER_API void	SendHandlerPacket (HandlerComponent *InComponent, FBitWriter &Writer, FOutPacketTraits &Traits)

PACKETHANDLER_API void	HandlerComponentInitialized (HandlerComponent *InComponent)

void	QueuePacketForRawSending (BufferedPacket *PacketToQueue)

void	QueueHandlerPacketForSending (BufferedPacket *PacketToQueue)

PACKETHANDLER_API BufferedPacket *	GetQueuedPacket ()

PACKETHANDLER_API BufferedPacket *	GetQueuedRawPacket ()

PACKETHANDLER_API BufferedPacket *	GetQueuedConnectionlessPacket ()

PACKETHANDLER_API int32	GetTotalReservedPacketBits ()

void	SetRawSend (bool bInEnabled)

bool	GetRawSend ()

bool	IsFullyInitialized ()

FDDoSDetection *	GetDDoS () const

TSharedPtr< IAnalyticsProvider >	GetProvider () const

TSharedPtr< FNetAnalyticsAggregator >	GetAggregator () const

Static Public Member Functions
static PACKETHANDLER_API bool	DoesAnyProfileHaveComponent (const FString &InComponentName)

static PACKETHANDLER_API bool	DoesProfileHaveComponent (const FName InNetDriverName, const FString &InComponentName)

static PACKETHANDLER_API FPacketHandlerAddComponentByNameDelegate &	GetAddComponentByNameDelegate ()

static PACKETHANDLER_API FPacketHandlerAddComponentDelegate &	GetAddComponentDelegate ()

Public Attributes
UE::Handler::Mode	Mode

Protected Member Functions
const ProcessedPacket	Incoming_Internal (uint8 *Packet, int32 CountBytes, bool bConnectionless, const TSharedPtr< const FInternetAddr > &Address)

PACKETHANDLER_API EIncomingResult	Incoming_Internal (FReceivedPacketView &PacketView)

PACKETHANDLER_API const ProcessedPacket	Outgoing_Internal (uint8 *Packet, int32 CountBits, FOutPacketTraits &Traits, bool bConnectionless, const TSharedPtr< const FInternetAddr > &Address)

Detailed Description

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

Constructor & Destructor Documentation

◆ PacketHandler() [1/2]

PacketHandler.PacketHandler ( ReadOnlyTargetRules Target )

inline

◆ PacketHandler() [2/2]

PacketHandler::PacketHandler ( FDDoSDetection * InDDoS = nullptr )

Base constructor

Parameters

InDDoS Reference to the owning net drivers DDoS detection handler

PacketHandler

Member Function Documentation

◆ AddHandler() [1/2]

TSharedPtr< HandlerComponent > PacketHandler::AddHandler	(	const FString &	ComponentStr,
		bool	bDeferInitialize = `false`
	)

As above, but initializes from a string specifying the component module, and (optionally) additional options

Parameters

ComponentStr	The handler component to load
bDeferInitialize	Whether or not to defer triggering Initialize (for batch-adds - code calling this, triggers it instead)

◆ AddHandler() [2/2]

void PacketHandler::AddHandler	(	TSharedPtr< HandlerComponent > &	NewHandler,
		bool	bDeferInitialize = `false`
	)

Adds a HandlerComponent to the pipeline, prior to initialization (none can be added after initialization)

Parameters

NewHandler	The HandlerComponent to add
bDeferInitialize	Whether or not to defer triggering Initialize (for batch-adds - code calling this, triggers it instead)

◆ BeginHandshaking()

void PacketHandler::BeginHandshaking ( FPacketHandlerHandshakeComplete InHandshakeDel = FPacketHandlerHandshakeComplete() )

Triggered by the higher level netcode, to begin any required HandlerComponent handshakes

◆ CountBytes()

void PacketHandler::CountBytes ( FArchive & Ar ) const

◆ DoesAnyProfileHaveComponent()

bool PacketHandler::DoesAnyProfileHaveComponent ( const FString & InComponentName )

static

Searches the PacketHandler profile configurations to find if a component is listed.

Parameters

InComponentName The PacketHandler Component to search for

Returns: if there is a profile that has the component included.

◆ DoesProfileHaveComponent()

bool PacketHandler::DoesProfileHaveComponent	(	const FName	InNetDriverName,
		const FString &	InComponentName
	)

static

Searches the PacketHandler profile configuration for the given netdriver to find if a component is listed.

Parameters

InNetDriverName	The name of the netdriver to search configuration for
InComponentName	The component to search for

Returns: if the component is listed in the profile configuration.

◆ GetAddComponentByNameDelegate()

FPacketHandlerAddComponentByNameDelegate & PacketHandler::GetAddComponentByNameDelegate ( )

static

◆ GetAddComponentDelegate()

FPacketHandlerAddComponentDelegate & PacketHandler::GetAddComponentDelegate ( )

static

◆ GetAggregator()

TSharedPtr< FNetAnalyticsAggregator > PacketHandler.GetAggregator ( ) const

inline

Returns the analytics aggregator

◆ GetComponentByName()

TSharedPtr< HandlerComponent > PacketHandler::GetComponentByName ( FName ComponentName ) const

Returns a pointer to the first component in the HandlerComponents array with the specified name.

◆ GetDDoS()

FDDoSDetection * PacketHandler.GetDDoS ( ) const

inline

Returns a pointer to the DDoS detection handler

◆ GetEncryptionComponent()

TSharedPtr< FEncryptionComponent > PacketHandler::GetEncryptionComponent ( )

Returns a pointer to the component set as the encryption handler, if any.

◆ GetProvider()

TSharedPtr< IAnalyticsProvider > PacketHandler.GetProvider ( ) const

inline

Returns the analytics provider

◆ GetQueuedConnectionlessPacket()

BufferedPacket * PacketHandler::GetQueuedConnectionlessPacket ( )

Gets a packet from the buffered connectionless packet queue for sending

Returns: The packet to be sent, or nullptr if none are to be sent

◆ GetQueuedPacket()

BufferedPacket * PacketHandler::GetQueuedPacket ( )

Gets a packet from the buffered packet queue for sending

Returns: The packet to be sent, or nullptr if none are to be sent

◆ GetQueuedRawPacket()

BufferedPacket * PacketHandler::GetQueuedRawPacket ( )

Gets a packet from the buffered packet queue for sending (as a raw packet)

Returns: The packet to be sent, or nullptr if none are to be sent

◆ GetRawSend()

bool PacketHandler.GetRawSend ( )

inline

Whether or not raw packet sends are enabled

◆ GetTotalReservedPacketBits()

int32 PacketHandler::GetTotalReservedPacketBits ( )

Gets the combined reserved packet/protocol bits from all handlers, for reserving space in the parent connections packets

Returns: The combined reserved packet/protocol bits

◆ HandlerComponentInitialized()

void PacketHandler::HandlerComponentInitialized ( HandlerComponent * InComponent )

Triggered when a child HandlerComponent has been initialized

◆ Incoming() [1/2]

EIncomingResult PacketHandler.Incoming ( FReceivedPacketView & PacketView )

inline

Processes incoming packets at the PacketHandler level, before any UNetConnection processing takes place on the packet.

Use this for more complex changes to packets, such as compression/encryption, but be aware that compatibility problems with other HandlerComponent's are more likely.

Parameters

PacketView View of the packet being processed - PacketView.Data should be used to return the result

Returns: Returns Success/Failure

◆ Incoming() [2/2]

const ProcessedPacket PacketHandler.Incoming	(	uint8 *	Packet,
		int32	CountBytes
	)

inline

◆ Incoming_Internal() [1/2]

EIncomingResult PacketHandler::Incoming_Internal ( FReceivedPacketView & PacketView )

protected

Internal handling for Incoming/IncomingConnectionless

Parameters

PacketView View of the packet being processed - PacketView.Data should be used to return the result

Returns: Returns Success/Failure

◆ Incoming_Internal() [2/2]

const ProcessedPacket PacketHandler.Incoming_Internal	(	uint8 *	Packet,
		int32	CountBytes,
		bool	bConnectionless,
		const TSharedPtr< const FInternetAddr > &	Address
	)

inlineprotected

◆ IncomingConnectionless() [1/2]

const ProcessedPacket PacketHandler.IncomingConnectionless	(	const TSharedPtr< const FInternetAddr > &	Address,
		uint8 *	Packet,
		int32	CountBytes
	)

inline

◆ IncomingConnectionless() [2/2]

EIncomingResult PacketHandler.IncomingConnectionless ( FReceivedPacketView & PacketView )

inline

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 NOTE: Connectionless packets are unreliable.

Parameters

PacketView View of the packet being processed - PacketView.Data should be used to return the result

Returns: Returns Success/Failure

◆ IncomingHigh()

void PacketHandler::IncomingHigh ( FBitReader & Reader )

Processes incoming packets at the UNetConnection level, after uncapping the packet into an FBitReader.

Use this for simple data additions to packets, and for maximum compatibility with other HandlerComponent's.

Parameters

Reader The FBitReader for the incoming packet

◆ InitFaultRecovery()

void PacketHandler::InitFaultRecovery ( UE::Net::FNetConnectionFaultRecoveryBase * InFaultRecovery )

Initializes a reference to the NetConnection fault recovery interface (does not require Engine dependency)

Parameters

InFaultRecovery A reference to the fault recovery interface

◆ Initialize()

void PacketHandler::Initialize	(	UE::Handler::Mode	Mode,
		uint32	InMaxPacketBits,
		bool	bConnectionlessOnly = `false`,
		TSharedPtr< class IAnalyticsProvider >	InProvider = `nullptr`,
		FDDoSDetection *	InDDoS = `nullptr`,
		FName	InDriverProfile = `NAME_None`
	)

Handles initialization of manager

Parameters

Mode	The mode the manager should be initialized in
InMaxPacketBits	The maximum supported packet size
bConnectionlessOnly	Whether or not this is a connectionless-only manager (ignores .ini components)
InProvider	The analytics provider
InDDoS	Reference to the owning net drivers DDoS detection handler
InDriverProfile	The PacketHandler configuration profile to use

◆ InitializeComponents()

void PacketHandler::InitializeComponents ( )

Triggers initialization of HandlerComponents.

◆ InitializeDelegates()

void PacketHandler::InitializeDelegates	(	FPacketHandlerLowLevelSendTraits	InLowLevelSendDel,
		FPacketHandlerNotifyAddHandler	InAddHandlerDel = `FPacketHandlerNotifyAddHandler()`
	)

Used for external initialization of delegates

Parameters

InLowLevelSendDel	The delegate the PacketHandler should use for triggering packet sends
InAddHandlerDel	Callback for notifying of new HandlerComponent's

◆ IsFullyInitialized()

bool PacketHandler.IsFullyInitialized ( )

inline

Whether or not the packet handler is fully initialized, post-handshake etc.

◆ NotifyAnalyticsProvider()

void PacketHandler::NotifyAnalyticsProvider	(	TSharedPtr< IAnalyticsProvider >	InProvider,
		TSharedPtr< FNetAnalyticsAggregator >	InAggregator
	)

Notification that the NetDriver analytics provider has been updated (NOT called on first initialization) NOTE: Can also mean disabled, e.g. during hotfix

Parameters

InProvider	The analytics provider
InAggregator	The net analytics aggregator

◆ Outgoing()

const ProcessedPacket PacketHandler.Outgoing	(	uint8 *	Packet,
		int32	CountBits,
		FOutPacketTraits &	Traits
	)

inline

Processes outgoing packets at the PacketHandler level, after all UNetConnection processing.

Use this for more complex changes to packets, such as compression/encryption, but be aware that compatibility problems with other HandlerComponent's are more likely.

Parameters

Packet	The packet data to be processed
CountBits	The size of the packet data in bits
Traits	Traits for the packet, passed down from the NetConnection

Returns: Returns the final packet

◆ Outgoing_Internal()

const ProcessedPacket PacketHandler::Outgoing_Internal	(	uint8 *	Packet,
		int32	CountBits,
		FOutPacketTraits &	Traits,
		bool	bConnectionless,
		const TSharedPtr< const FInternetAddr > &	Address
	)

protected

Internal handling for Outgoing/OutgoingConnectionless

Parameters

Packet	The packet data to be processed
CountBits	The size of the packet data in bits
Traits	Traits for the packet, passed down from the NetConnection, if applicable
bConnectionless	Whether or not this should be sent as a connectionless packet
Address	The address the packet is being sent to

Returns: Returns the final packet

◆ OutgoingConnectionless()

const ProcessedPacket PacketHandler.OutgoingConnectionless	(	const TSharedPtr< const FInternetAddr > &	Address,
		uint8 *	Packet,
		int32	CountBits,
		FOutPacketTraits &	Traits
	)

inline

Processes outgoing packets without a UNetConnection, in the same manner as 'Outgoing' above NOTE: Connectionless packets are unreliable.

Parameters

Address	The address the packet is being sent to
Packet	The packet data to be processed
CountBits	The size of the packet data in bits
Traits	Traits for the packet, if applicable

Returns: Returns the final packet

◆ OutgoingHigh()

void PacketHandler::OutgoingHigh ( FBitWriter & Writer )

Processes outgoing packets at the UNetConnection level, after game data is written, and just before the packet is capped.

Use this for simple data additions to packets, and for maximum compatibility with other HandlerComponent's.

Parameters

Writer The FBitWriter for the outgoing packet

◆ QueueHandlerPacketForSending()

void PacketHandler.QueueHandlerPacketForSending ( BufferedPacket * PacketToQueue )

inline

Queue's a packet to be sent through 'SendHandlerPacket'

Parameters

PacketToQueue The packet to be queued

◆ QueuePacketForRawSending()

void PacketHandler.QueuePacketForRawSending ( BufferedPacket * PacketToQueue )

inline

Queue's a packet to be sent when the handler is ticked (as a raw packet, since it's already been processed)

Parameters

PacketToQueue The packet to be queued

◆ SendHandlerPacket()

void PacketHandler::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. NOTE: Requires that InitializeDelegates is called, with a valid LowLevelSend delegate.

Parameters

Component	The HandlerComponent sending the packet
Writer	The packet being sent
Traits	The traits applied to the packet, if applicable

◆ SetRawSend()

void PacketHandler.SetRawSend ( bool bInEnabled )

inline

Sets whether or not outgoing packets should bypass this handler - used when raw packet sends are necessary (such as for the stateless handshake)

Parameters

bInEnabled Whether or not raw sends are enabled

◆ Tick()

void PacketHandler::Tick ( float DeltaTime )

Member Data Documentation

◆ Mode

UE::Handler::Mode PacketHandler.Mode

Mode of the handler, Client or Server

The documentation for this class was generated from the following files:

Engine/Source/Runtime/PacketHandlers/PacketHandler/PacketHandler.Build.cs
Engine/Source/Runtime/PacketHandlers/PacketHandler/Public/PacketHandler.h
Engine/Source/Runtime/PacketHandlers/PacketHandler/Private/PacketHandler.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PacketHandler() [1/2]

◆ PacketHandler() [2/2]

Member Function Documentation

◆ AddHandler() [1/2]

◆ AddHandler() [2/2]

◆ BeginHandshaking()

◆ CountBytes()

◆ DoesAnyProfileHaveComponent()

◆ DoesProfileHaveComponent()

◆ GetAddComponentByNameDelegate()

◆ GetAddComponentDelegate()

◆ GetAggregator()

◆ GetComponentByName()

◆ GetDDoS()

◆ GetEncryptionComponent()

◆ GetProvider()

◆ GetQueuedConnectionlessPacket()

◆ GetQueuedPacket()

◆ GetQueuedRawPacket()

◆ GetRawSend()

◆ GetTotalReservedPacketBits()

◆ HandlerComponentInitialized()

◆ Incoming() [1/2]

◆ Incoming() [2/2]

◆ Incoming_Internal() [1/2]

◆ Incoming_Internal() [2/2]

◆ IncomingConnectionless() [1/2]

◆ IncomingConnectionless() [2/2]

◆ IncomingHigh()

◆ InitFaultRecovery()

◆ Initialize()

◆ InitializeComponents()

◆ InitializeDelegates()

◆ IsFullyInitialized()

◆ NotifyAnalyticsProvider()

◆ Outgoing()

◆ Outgoing_Internal()

◆ OutgoingConnectionless()

◆ OutgoingHigh()

◆ QueueHandlerPacketForSending()

◆ QueuePacketForRawSending()

◆ SendHandlerPacket()

◆ SetRawSend()

◆ Tick()

Member Data Documentation

◆ Mode