UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
DataChannel.h File Reference

Go to the source code of this file.

Classes

class  FNetControlMessage< MessageType >
 
class  FNetControlMessageInfo
 
class  UE::Net::TNetControlMessageImpl< Index, ParamTypes >
 

Namespaces

namespace  UE
 
namespace  UE::Net
 

Macros

#define DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, ...)
 
#define DEFINE_CONTROL_CHANNEL_MESSAGE_ZEROPARAM(Name, Index)   DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index)
 
#define DEFINE_CONTROL_CHANNEL_MESSAGE_ONEPARAM(Name, Index, TypeA)   DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, TypeA)
 
#define DEFINE_CONTROL_CHANNEL_MESSAGE_TWOPARAM(Name, Index, TypeA, TypeB)   DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, TypeA, TypeB)
 
#define DEFINE_CONTROL_CHANNEL_MESSAGE_THREEPARAM(Name, Index, TypeA, TypeB, TypeC)   DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, TypeA, TypeB, TypeC)
 
#define DEFINE_CONTROL_CHANNEL_MESSAGE_FOURPARAM(Name, Index, TypeA, TypeB, TypeC, TypeD)   DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, TypeA, TypeB, TypeC, TypeD)
 
#define DEFINE_CONTROL_CHANNEL_MESSAGE_FIVEPARAM(Name, Index, TypeA, TypeB, TypeC, TypeD, TypeE)   DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, TypeA, TypeB, TypeC, TypeD, TypeE)
 
#define DEFINE_CONTROL_CHANNEL_MESSAGE_SIXPARAM(Name, Index, TypeA, TypeB, TypeC, TypeD, TypeE, TypeF)   DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, TypeA, TypeB, TypeC, TypeD, TypeE, TypeF)
 
#define DEFINE_CONTROL_CHANNEL_MESSAGE_SEVENPARAM(Name, Index, TypeA, TypeB, TypeC, TypeD, TypeE, TypeF, TypeG)   DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, TypeA, TypeB, TypeC, TypeD, TypeE, TypeF, TypeG)
 
#define DEFINE_CONTROL_CHANNEL_MESSAGE_EIGHTPARAM(Name, Index, TypeA, TypeB, TypeC, TypeD, TypeE, TypeF, TypeG, TypeH)   DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, TypeA, TypeB, TypeC, TypeD, TypeE, TypeF, TypeG, TypeH)
 
#define IMPLEMENT_CONTROL_CHANNEL_MESSAGE(Name)   static uint8 Dummy##_FNetControlMessage_##Name = FNetControlMessage<NMT_##Name>::Initialize(TEXT(#Name));
 

Functions

 DEFINE_CONTROL_CHANNEL_MESSAGE (Hello, 0, uint8, uint32, FString, EEngineNetworkRuntimeFeatures)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (Welcome, 1, FString, FString, FString)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (Upgrade, 2, uint32, EEngineNetworkRuntimeFeatures)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (Challenge, 3, FString)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (Netspeed, 4, int32)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (Login, 5, FString, FString, FUniqueNetIdRepl, FString)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (Failure, 6, FString)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (Join, 9)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (JoinSplit, 10, FString, FUniqueNetIdRepl)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (Skip, 12, FGuid)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (Abort, 13, FGuid)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (PCSwap, 15, int32)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (ActorChannelFailure, 16, int32)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (DebugText, 17, FString)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (NetGUIDAssign, 18, FNetworkGUID, FString)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (SecurityViolation, 19, FString)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (GameSpecific, 20, uint8, FString)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (EncryptionAck, 21)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (DestructionInfo, 22)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (CloseReason, 23, FString)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (NetPing, 24, ENetPingControlMessage, FString)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (BeaconWelcome, 25)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (BeaconJoin, 26, FString, FUniqueNetIdRepl)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (BeaconAssignGUID, 27, UE::Net::FNetIDVariant)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (BeaconNetGUIDAck, 28, FString)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (IrisProtocolMismatch, 29, uint64)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (IrisNetRefHandleError, 30, UE::Net::ENetRefHandleError, uint64, TArray< uint64 >)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (JoinNoPawn, 31)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (JoinNoPawnSplit, 32, FString, FUniqueNetIdRepl)
 
 DEFINE_CONTROL_CHANNEL_MESSAGE (CloseChildConnection, 34, int32)
 

Macro Definition Documentation

◆ DEFINE_CONTROL_CHANNEL_MESSAGE

#define DEFINE_CONTROL_CHANNEL_MESSAGE (   Name,
  Index,
  ... 
)
Value:
enum { NMT_##Name = Index }; \
template<> class FNetControlMessage<Index> : public UE::Net::TNetControlMessageImpl<Index, ##__VA_ARGS__> \
{ \
};
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
Definition DataChannel.h:42
Definition DataChannel.h:107
U16 Index
Definition radfft.cpp:71

◆ DEFINE_CONTROL_CHANNEL_MESSAGE_EIGHTPARAM

#define DEFINE_CONTROL_CHANNEL_MESSAGE_EIGHTPARAM (   Name,
  Index,
  TypeA,
  TypeB,
  TypeC,
  TypeD,
  TypeE,
  TypeF,
  TypeG,
  TypeH 
)    DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, TypeA, TypeB, TypeC, TypeD, TypeE, TypeF, TypeG, TypeH)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE_FIVEPARAM

#define DEFINE_CONTROL_CHANNEL_MESSAGE_FIVEPARAM (   Name,
  Index,
  TypeA,
  TypeB,
  TypeC,
  TypeD,
  TypeE 
)    DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, TypeA, TypeB, TypeC, TypeD, TypeE)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE_FOURPARAM

#define DEFINE_CONTROL_CHANNEL_MESSAGE_FOURPARAM (   Name,
  Index,
  TypeA,
  TypeB,
  TypeC,
  TypeD 
)    DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, TypeA, TypeB, TypeC, TypeD)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE_ONEPARAM

#define DEFINE_CONTROL_CHANNEL_MESSAGE_ONEPARAM (   Name,
  Index,
  TypeA 
)    DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, TypeA)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE_SEVENPARAM

#define DEFINE_CONTROL_CHANNEL_MESSAGE_SEVENPARAM (   Name,
  Index,
  TypeA,
  TypeB,
  TypeC,
  TypeD,
  TypeE,
  TypeF,
  TypeG 
)    DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, TypeA, TypeB, TypeC, TypeD, TypeE, TypeF, TypeG)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE_SIXPARAM

#define DEFINE_CONTROL_CHANNEL_MESSAGE_SIXPARAM (   Name,
  Index,
  TypeA,
  TypeB,
  TypeC,
  TypeD,
  TypeE,
  TypeF 
)    DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, TypeA, TypeB, TypeC, TypeD, TypeE, TypeF)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE_THREEPARAM

#define DEFINE_CONTROL_CHANNEL_MESSAGE_THREEPARAM (   Name,
  Index,
  TypeA,
  TypeB,
  TypeC 
)    DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, TypeA, TypeB, TypeC)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE_TWOPARAM

#define DEFINE_CONTROL_CHANNEL_MESSAGE_TWOPARAM (   Name,
  Index,
  TypeA,
  TypeB 
)    DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index, TypeA, TypeB)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE_ZEROPARAM

#define DEFINE_CONTROL_CHANNEL_MESSAGE_ZEROPARAM (   Name,
  Index 
)    DEFINE_CONTROL_CHANNEL_MESSAGE(Name, Index)

◆ IMPLEMENT_CONTROL_CHANNEL_MESSAGE

#define IMPLEMENT_CONTROL_CHANNEL_MESSAGE (   Name)    static uint8 Dummy##_FNetControlMessage_##Name = FNetControlMessage<NMT_##Name>::Initialize(TEXT(#Name));

Function Documentation

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [1/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( Abort  ,
13  ,
FGuid   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [2/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( ActorChannelFailure  ,
16  ,
int32   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [3/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( BeaconAssignGUID  ,
27  ,
UE::Net::FNetIDVariant   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [4/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( BeaconJoin  ,
26  ,
FString  ,
FUniqueNetIdRepl   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [5/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( BeaconNetGUIDAck  ,
28  ,
FString   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [6/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( BeaconWelcome  ,
25   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [7/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( Challenge  ,
,
FString   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [8/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( CloseChildConnection  ,
34  ,
int32   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [9/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( CloseReason  ,
23  ,
FString   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [10/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( DebugText  ,
17  ,
FString   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [11/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( DestructionInfo  ,
22   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [12/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( EncryptionAck  ,
21   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [13/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( Failure  ,
,
FString   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [14/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( GameSpecific  ,
20  ,
uint8  ,
FString   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [15/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( Hello  ,
,
uint8  ,
uint32  ,
FString  ,
EEngineNetworkRuntimeFeatures   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [16/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( IrisNetRefHandleError  ,
30  ,
UE::Net::ENetRefHandleError  ,
uint64  ,
TArray< uint64  
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [17/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( IrisProtocolMismatch  ,
29  ,
uint64   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [18/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( Join  ,
 
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [19/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( JoinNoPawn  ,
31   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [20/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( JoinNoPawnSplit  ,
32  ,
FString  ,
FUniqueNetIdRepl   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [21/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( JoinSplit  ,
10  ,
FString  ,
FUniqueNetIdRepl   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [22/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( Login  ,
,
FString  ,
FString  ,
FUniqueNetIdRepl  ,
FString   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [23/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( NetGUIDAssign  ,
18  ,
FNetworkGUID  ,
FString   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [24/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( NetPing  ,
24  ,
ENetPingControlMessage  ,
FString   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [25/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( Netspeed  ,
,
int32   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [26/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( PCSwap  ,
15  ,
int32   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [27/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( SecurityViolation  ,
19  ,
FString   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [28/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( Skip  ,
12  ,
FGuid   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [29/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( Upgrade  ,
,
uint32  ,
EEngineNetworkRuntimeFeatures   
)

◆ DEFINE_CONTROL_CHANNEL_MESSAGE() [30/30]

DEFINE_CONTROL_CHANNEL_MESSAGE ( Welcome  ,
,
FString  ,
FString  ,
FString   
)