1. Epic GamesDeveloper
  3. UMinimalClient

UMinimalClient

Base class for implementing a barebones/stripped-down game client, capable of connecting to a regular game server, but stripped/locked-down so that the absolute minimum of client/server netcode functionality is executed, for connecting the client.

Unreal Engine C++ API Reference > Plugins > NetcodeUnitTest

Inheritance Hierarchy

References

   
Module NetcodeUnitTest
Header /Engine/Plugins/NetcodeUnitTest/NetcodeUnitTest/Source/NetcodeUnitTest/Classes/MinimalClient.h
Include #include "MinimalClient.h"

Syntax

UCLASS ()  
class UMinimalClient :  
    public UObject,  
    public FNetworkNotify,  
    public FProtMinClientParms ,  
    public FProtMinClientHooks ,  
    public FUnitLogRedirect

Remarks

Base class for implementing a barebones/stripped-down game client, capable of connecting to a regular game server, but stripped/locked-down so that the absolute minimum of client/server netcode functionality is executed, for connecting the client.

Variables

  Type Name Description
Protected variable bool bConnected Runtime variables Whether or not the minimal client is connected
Protected variable bool bSentBunch Whether or not a bunch was successfully sent
Protected variable TArray< int32 > PendingNetActorChans If notifying of net actor creation, this keeps track of new actor channel indexes pending notification
Protected variable UProperty TObjectPtr< UNetConnection > UnitConn Stores a reference to the server connection
Protected variable UProperty TObjectPtr< UNetDriver > UnitNetDriver Stores a reference to the created unit test net driver, for execution and later cleanup
Protected variable UProperty TObjectPtr< UWorld > UnitWorld Stores a reference to the created empty world, for execution and later cleanup

Constructors

  Type Name Description
Public function  

UMinimalClient ( const FObjectInitializer& ObjectInitializer
)

 UMinimalClient

Functions

  Type Name Description
Public function void

Cleanup ()

 Disconnects and cleans up the minimal client.
Public function bool Connects the minimal client to a server, with Parms specifying the server details and minimal client configuration, and passing back the low level netcode events specified by Hooks.
Protected function bool Creates the minimal client state, and connects to the server
Public function FOutBunch *

CreateChannelBunch ( EChannelType ChType,
int32 ChIndex
)

 Creates a bunch for the specified channel, with the ability to create the channel as well WARNING: Can return nullptr! (e.g. if the control channel is saturated)
Public function FOutBunch *

CreateChannelBunchByName ( const FName& ChName,
int32 ChIndex
)

 Creates a bunch for the specified channel, with the ability to create the channel as well WARNING: Can return nullptr! (e.g. if the control channel is saturated)
Protected function void Creates a net driver for the minimal client
Public function void

DiscardChannelBunch ( FOutBunch* Bunch
)

 Discards a created bunch, without sending it - don't use this for sent packets
Protected function void Disconnects the minimal client - including destructing the net driver and such (tears down the whole connection) NOTE: Based upon the HandleDisconnect function, except removing parts that are undesired (e.g. which trigger level switch)
Public function UNetConnection *

GetConn ()

 Retrieve the value of UnitConn
Public function EMinClientFlags Retrieve the value of MinClientFlags
Public function UWorld * Retrieve the value of UnitWorld
Protected function void

InternalNotifyNetworkFailure ( UWorld* InWorld,
UNetDriver* InNetDriver,
ENetworkFailure::Type FailureType,
const FString& ErrorString
)

  
Public function bool Whether or not the minimal client is connected to the server
Public function Const bool Whether or not the minimal client requires ticking.
Protected function Virtual void

NotifyAcceptedConnection ( UNetConnection* Connection
)

  
Protected function Virtual bool

NotifyAcceptingChannel ( UChannel* Channel
)

  
Protected function Virtual EAcceptConnection::Type FNetworkNotify.
Protected function Virtual void

NotifyControlMessage ( UNetConnection* Connection,
uint8 MessageType,
FInBunch& Bunch
)

  
Protected function void

NotifyReceivedRawPacket ( void* Data,
int32 Count,
bool& bBlockReceive
)

 See FOnReceivedRawPacket
Protected function void

NotifyReceiveRPC ( AActor* Actor,
UFunction* Function,
void* Parameters,
bool& bBlockRPC
)

 See FOnProcessNetEvent
Protected function void

NotifySendRPC ( AActor* Actor,
UFunction* Function,
void* Parameters,
FOutParmRec* OutParms,
FFrame* Stack,
UObject* SubObject,
bool& bBlockSendRPC
)

 See FOnSendRPC
Protected function void

NotifySocketSend ( void* Data,
int32 Count,
bool& bBlockSend
)

 See FOnLowLevelSend
Public function bool

PostSendRPC ( FString RPCName,
UObject* Target
)

 Internal function, for handling the aftermath of a checked RPC call
Public function void Internal function, for preparing for a checked RPC call
Public function void

ResetConnTimeout ( float Duration
)

 Resets the net connection timeout
Public function bool

SendControlBunch ( FOutBunch* ControlChanBunch
)

 Sends a bunch over the control channel
Protected function void Sends the packet for triggering the initial join (usually is delayed, by the PacketHandler)
Public function bool

SendRawBunch ( FOutBunch& Bunch,
bool bAllowPartial
)

 Sends a raw packet bunch, directly to the NetConnection, with the option of automatically splitting into partial bunches.
Public function bool

SendRPCChecked ( UObject* Target,
FFuncReflection& FuncRefl
)

 As above, except optimized for use with reflection
Public function bool

SendRPCChecked ( UObject* Target,
const TCHAR* FunctionName,
void* Parms,
int16 ParmsSize,
int16 ParmsSizeCorrection
)

 Sends the specified RPC for the specified actor, and verifies that the RPC was sent (triggering RPCFailureDel if not)
Public function void

UnitTick ( float DeltaTime
)

 Ticks the minimal client, through the owner unit tests UnitTick function
Protected function Virtual void

WriteControlLogin ( FOutBunch* ControlChanBunch
)

 Writes the NMT_Login message, as a part of SendInitialJoin (separated to make it overridable)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page