Navigation
API > API/Runtime > API/Runtime/NetCore
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.
| Name | FConnectionHandle |
| Type | class |
| Header File | /Engine/Source/Runtime/Net/Core/Public/Net/Core/Connection/ConnectionHandle.h |
| Include Path | #include "Net/Core/Connection/ConnectionHandle.h" |
Syntax
class FConnectionHandle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Initializes an invalid handle. | Net/Core/Connection/ConnectionHandle.h | ||
FConnectionHandle
(
uint32 InParentConnectionId |
Net/Core/Connection/ConnectionHandle.h | ||
FConnectionHandle
(
uint32 InParentConnectionId, |
Net/Core/Connection/ConnectionHandle.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ChildConnectionId | uint32 | For a valid handle a ChildConnectionId of zero indicates it's the parent connection itself. | Net/Core/Connection/ConnectionHandle.h | |
| ParentConnectionId | uint32 | Net/Core/Connection/ConnectionHandle.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint32 GetChildConnectionId() |
Returns a non-zero ID for a valid child connection handle, zero for parent connections and invalid handles. | Net/Core/Connection/ConnectionHandle.h | |
uint32 GetParentConnectionId() |
Returns the parent connection id for all types of valid handles. | Net/Core/Connection/ConnectionHandle.h | |
bool IsChildConnection() |
Returns true if the handle is valid and represents a child connection. | Net/Core/Connection/ConnectionHandle.h | |
bool IsParentConnection() |
Returns true if the handle is valid and represents a parent connection. | Net/Core/Connection/ConnectionHandle.h | |
bool IsValid() |
Returns true if this is a valid handle. | Net/Core/Connection/ConnectionHandle.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator==
(
const FConnectionHandle& Other |
Net/Core/Connection/ConnectionHandle.h |