UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FEncryptionComponent Class Referenceabstract

#include <EncryptionComponent.h>

+ Inheritance diagram for FEncryptionComponent:

Public Member Functions

 FEncryptionComponent (FName InName)
 
virtual void EnableEncryption ()=0
 
virtual void DisableEncryption ()=0
 
virtual bool IsEncryptionEnabled () const =0
 
virtual void SetEncryptionKey (TArrayView< const uint8 > Key)
 
virtual void SetEncryptionData (const FEncryptionData &EncryptionData)=0
 
- Public Member Functions inherited from HandlerComponent
PACKETHANDLER_API HandlerComponent ()
 
PACKETHANDLER_API HandlerComponent (FName InName)
 
virtual PACKETHANDLER_API ~HandlerComponent ()
 
virtual PACKETHANDLER_API bool IsActive () const
 
virtual bool IsValid () const =0
 
PACKETHANDLER_API bool IsInitialized () const
 
bool RequiresHandshake () const
 
bool RequiresReliability () const
 
virtual void Incoming (FBitReader &Packet)
 
virtual void Incoming (FIncomingPacketRef PacketRef)
 
virtual void Outgoing (FBitWriter &Packet, FOutPacketTraits &Traits)
 
virtual void IncomingConnectionless (FIncomingPacketRef PacketRef)
 
virtual void OutgoingConnectionless (const TSharedPtr< const FInternetAddr > &Address, FBitWriter &Packet, FOutPacketTraits &Traits)
 
virtual bool CanReadUnaligned () const
 
virtual void Initialize ()=0
 
virtual void InitFaultRecovery (UE::Net::FNetConnectionFaultRecoveryBase *InFaultRecovery)
 
virtual void NotifyHandshakeBegin ()
 
virtual void Tick (float DeltaTime)
 
virtual PACKETHANDLER_API void SetActive (bool Active)
 
virtual int32 GetReservedPacketBits () const =0
 
FName GetName () const
 
virtual void NotifyAnalyticsProvider ()
 
virtual PACKETHANDLER_API void CountBytes (FArchive &Ar) const
 

Additional Inherited Members

- Public Attributes inherited from HandlerComponent
PacketHandler * Handler
 
- Protected Member Functions inherited from HandlerComponent
PACKETHANDLER_API void SetState (UE::Handler::Component::State State)
 
PACKETHANDLER_API void Initialized ()
 
- Protected Attributes inherited from HandlerComponent
UE::Handler::Component::State State
 
uint32 MaxOutgoingBits
 
bool bRequiresHandshake
 
bool bRequiresReliability
 

Detailed Description

IEncryptionComponentInterface

Constructor & Destructor Documentation

◆ FEncryptionComponent()

FEncryptionComponent::FEncryptionComponent ( FName  InName)
inlineexplicit

Constructor that forwards the name to the base HandlerComponent.

Member Function Documentation

◆ DisableEncryption()

virtual void FEncryptionComponent::DisableEncryption ( )
pure virtual

Disable encryption. Future packets that are processed by this component will not be encrypted.

◆ EnableEncryption()

virtual void FEncryptionComponent::EnableEncryption ( )
pure virtual

Enable encryption. Future packets that are processed by this component will be encrypted. By default, encryption is disabled.

◆ IsEncryptionEnabled()

virtual bool FEncryptionComponent::IsEncryptionEnabled ( ) const
pure virtual

Returns true if encryption is currently enabled.

◆ SetEncryptionData()

virtual void FEncryptionComponent::SetEncryptionData ( const FEncryptionData &  EncryptionData)
pure virtual

Sets the encryption data to be used by this component. This should be called before EnableEncryption.

◆ SetEncryptionKey()

virtual void FEncryptionComponent::SetEncryptionKey ( TArrayView< const uint8 >  Key)
inlinevirtual

Sets the encryption key to be used by this component. The key must be the correct size for the encryption algorithm that the component implements. This should be called before EnableEncryption.

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