UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Friends | List of all members
UE::Net::FConnectionHandle Class Reference

#include <ConnectionHandle.h>

Public Member Functions

 FConnectionHandle ()=default
 
 FConnectionHandle (uint32 InParentConnectionId)
 
 FConnectionHandle (uint32 InParentConnectionId, uint32 InChildConnectionId)
 
bool operator== (const FConnectionHandle &Other) const
 
bool IsValid () const
 
bool IsParentConnection () const
 
bool IsChildConnection () const
 
uint32 GetParentConnectionId () const
 
uint32 GetChildConnectionId () const
 

Friends

uint32 GetTypeHash (const FConnectionHandle &Handle)
 

Detailed Description

The handle is unique per netdriver. The child connection ID is not unique with respect to other handles with a different parent connection ID. Child connection are not assigned proper connection IDs as we will never replicate to them. Only parent connections will be replicated to. When there is need to deal with child connections in replication scenarios the ConnectionHandle can aid with that.

Constructor & Destructor Documentation

◆ FConnectionHandle() [1/3]

UE::Net::FConnectionHandle::FConnectionHandle ( )
inlinedefault

Initializes an invalid handle.

◆ FConnectionHandle() [2/3]

UE::Net::FConnectionHandle::FConnectionHandle ( uint32  InParentConnectionId)
inlineexplicit

◆ FConnectionHandle() [3/3]

UE::Net::FConnectionHandle::FConnectionHandle ( uint32  InParentConnectionId,
uint32  InChildConnectionId 
)
inline

Member Function Documentation

◆ GetChildConnectionId()

uint32 UE::Net::FConnectionHandle::GetChildConnectionId ( ) const
inline

Returns a non-zero ID for a valid child connection handle, zero for parent connections and invalid handles.

◆ GetParentConnectionId()

uint32 UE::Net::FConnectionHandle::GetParentConnectionId ( ) const
inline

Returns the parent connection id for all types of valid handles.

◆ IsChildConnection()

bool UE::Net::FConnectionHandle::IsChildConnection ( ) const
inline

Returns true if the handle is valid and represents a child connection.

◆ IsParentConnection()

bool UE::Net::FConnectionHandle::IsParentConnection ( ) const
inline

Returns true if the handle is valid and represents a parent connection.

◆ IsValid()

bool UE::Net::FConnectionHandle::IsValid ( ) const
inline

Returns true if this is a valid handle.

◆ operator==()

bool UE::Net::FConnectionHandle::operator== ( const FConnectionHandle &  Other) const
inline

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FConnectionHandle &  Handle)
friend
The documentation for this class was generated from the following file: