1. Epic GamesDeveloper
  3. PacketHandler

PacketHandler

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

Unreal Engine C++ API Reference > Runtime > PacketHandler

References

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

Syntax

class PacketHandler

Remarks

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

Variables

  Type Name Description
Public variable UE::Handler::Mode Mode Mode of the handler, Client or Server

Constructors

  Type Name Description
Public function   Base constructorPacketHandler

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function TSharedPtr< HandlerComponent >

AddHandler ( const FString& ComponentStr,
bool bDeferInitialize
)

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

AddHandler ( TSharedPtr< HandlerComponent >& NewHandler,
bool bDeferInitialize
)

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

BeginHandshaking ( FPacketHandlerHandshakeComplete InHandshakeDel
)

 Triggered by the higher level netcode, to begin any required HandlerComponent handshakes
Public function Virtual Const void  
Public function Static bool

DoesAnyProfileHaveComponent ( const FString& InComponentName
)

 Searches the PacketHandler profile configurations to find if a component is listed.
Public function Static bool

DoesProfileHaveComponent ( const FName InNetDriverName,
const FString& InComponentName
)

 Searches the PacketHandler profile configuration for the given netdriver to find if a component is listed.
Public function Static FPacketHandlerAddComponentByNameDelegate &  
Public function Static FPacketHandlerAddComponentDelegate &  
Public function Const TSharedPtr< FNetAnalyticsAggregator > Returns the analytics aggregator
Public function Const TSharedPtr< HandlerComponent >

GetComponentByName ( FName ComponentName
)

 Returns a pointer to the first component in the HandlerComponents array with the specified name.
Public function Const FDDoSDetection *

GetDDoS ()

 Returns a pointer to the DDoS detection handler
Public function TSharedPtr< FEncryptionComponent > Returns a pointer to the component set as the encryption handler, if any.
Public function Const TSharedPtr< IAnalyticsProvider > Returns the analytics provider
Public function BufferedPacket * Gets a packet from the buffered connectionless packet queue for sending
Public function BufferedPacket * Gets a packet from the buffered packet queue for sending
Public function BufferedPacket * Gets a packet from the buffered packet queue for sending (as a raw packet)
Public function bool Whether or not raw packet sends are enabled
Public function int32 Gets the combined reserved packet/protocol bits from all handlers, for reserving space in the parent connections packets
Public function void Triggered when a child HandlerComponent has been initialized
Public function EIncomingResult

Incoming ( FReceivedPacketView& PacketView
)

 Processes incoming packets at the PacketHandler level, before any UNetConnection processing takes place on the packet.
Protected function EIncomingResult Internal handling for Incoming/IncomingConnectionless
Public function EIncomingResult 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.
Public function void

IncomingHigh ( FBitReader& Reader
)

 Processes incoming packets at the UNetConnection level, after uncapping the packet into an FBitReader.
Public function void Initializes a reference to the NetConnection fault recovery interface (does not require Engine dependency)
Public function void

Initialize ( UE::Handler::Mode Mode,
uint32 InMaxPacketBits,
bool bConnectionlessOnly,
TSharedPtr< class IAnalyticsProvider > InProvider,
FDDoSDetection* InDDoS,
FName InDriverProfile
)

 Handles initialization of manager
Public function void Triggers initialization of HandlerComponents.
Public function void

InitializeDelegates ( FPacketHandlerLowLevelSendTraits InLowLevelSendDel,
FPacketHandlerNotifyAddHandler InAddHandlerDel
)

 Used for external initialization of delegates
Public function bool Whether or not the packet handler is fully initialized, post-handshake etc.
Public function void Notification that the NetDriver analytics provider has been updated (NOT called on first initialization) NOTE: Can also mean disabled, e.g. during hotfix
Public function const ProcessedPacket

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

 Processes outgoing packets at the PacketHandler level, after all UNetConnection processing.
Protected function const ProcessedPacket

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

 Internal handling for Outgoing/OutgoingConnectionless
Public function const ProcessedPacket

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

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

OutgoingHigh ( FBitWriter& Writer
)

 Processes outgoing packets at the UNetConnection level, after game data is written, and just before the packet is capped.
Public function void Queue's a packet to be sent through 'SendHandlerPacket'
Public function void Queue's a packet to be sent when the handler is ticked (as a raw packet, since it's already been processed)
Public function 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.
Public function 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)
Public function void

Tick ( float DeltaTime
)

  

Deprecated Functions

  Type Name Description
Public function const ProcessedPacket

Incoming ( uint8* Packet,
int32 CountBytes
)

 Incoming now uses FReceivedPacketView.
Protected function const ProcessedPacket

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

 Incoming_Internal now uses FReceivedPacketView
Public function const ProcessedPacket

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

 IncomingConnectionless now uses FReceivedPacketView.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page