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

Light Theme

Dark Theme

HandlerComponent

This class appends or modifies incoming and outgoing packets on a connection

Windows

MacOS

Linux

Inheritance Hierarchy

HandlerComponent

FEncryptionComponent

	FAESGCMHandlerComponent
	FAESHandlerComponent
	FDTLSHandlerComponent

OodleNetworkHandlerComponent

ReliabilityHandlerComponent

StatelessConnectHandlerComponent

References

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

Syntax

class HandlerComponent

Remarks

This class appends or modifies incoming and outgoing packets on a connection

Variables

	Name	Description
bool	bRequiresHandshake	Whether this handler has to perform a network handshake during initialization (requires waiting on other HandlerComponent's)
bool	bRequiresReliability	Whether this handler depends upon the ReliabilityHandlerComponent being enabled
PacketHandler &...	Handler	The manager of the handler, set in initialization
uint32	MaxOutgoingBits	Maximum number of Outgoing packet bits supported (automatically calculated to factor in other HandlerComponent reserved bits)
Handler::Compon...	State	The state of this handler

Constructors

	Name	Description
	HandlerComponent()	Base constructor HandlerComponent
	HandlerComponent ( FName InName )	Constructor that accepts a name

Name

Description

HandlerComponent()

Base constructor

HandlerComponent

(
FName InName
)

Constructor that accepts a name

Destructors

	Name	Description
	~HandlerComponent()	Base destructor

Functions

	Name	Description
bool	CanReadUnaligned()	Whether or not the Incoming/IncomingConnectionless implementations, support reading Packets that aren't aligned at bit position 0 (i.e. whether or not this handler supports bit-level, rather than byte-level, reads)
void	CountBytes ( FArchive& Ar )
FName	GetName()	Returns the name of this component.
int32	GetReservedPacketBits()	Returns the amount of reserved packet/protocol bits expected from this component.
void	Incoming ( FBitReader& Packet )	Handles incoming packets
void	IncomingConnectionless ( FIncomingPacketRef PacketRef )	Handles incoming packets not associated with a UNetConnection
void	Initialize()	Initialization functionality should be placed here
void	Initialized()	Should be called when the handler is fully initialized on both remote and local
bool	IsActive()	Returns whether this handler is currently active
bool	IsInitialized()	Returns whether this handler is initialized
bool	IsValid()	Return whether this handler is valid
void	NotifyAnalyticsProvider()	Notification that the analytics provider has been updated
void	NotifyHandshakeBegin()	Notification to this component that it is ready to begin handshaking
void	Outgoing ( FBitWriter& Packet, FOutPacketTraits& Traits )	Handles any outgoing packets
void	OutgoingConnectionless ( const TSharedPtr< const FInternetAd..., FBitWriter& Packet, FOutPacketTraits& Traits )	Handles any outgoing packets not associated with a UNetConnection
bool	RequiresHandshake()	Returns whether this handler perform a network handshake during initialization
bool	RequiresReliability()	Returns whether this handler perform a network handshake during initialization
void	SetActive ( bool Active )	Sets whether this handler is currently active
void	SetState ( Handler::Component::State State )	Sets the state of the handler
void	Tick ( float DeltaTime )	Tick functionality should be placed here

Deprecated Functions

		Name	Description
	void	IncomingConnectionless ( const TSharedPtr< const FInternetAd..., FBitReader& Packet )	Remove this function (no longer pure virtual, same with OutgoingConnectionless), or use the version which takes 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