UE::Net::FNetResultManager Class Reference

#include <NetResultManager.h>

Public Types
using	FUnhandledResultFunc = TUniqueFunction< EHandleNetResult(FNetResult &&InResult)>

Public Member Functions
	FNetResultManager ()=default
	FNetResultManager (FNetResultManager &)=delete
FNetResultManager &	operator= (const FNetResultManager &)=delete
	FNetResultManager (FNetResultManager &&)=delete
FNetResultManager &	operator= (FNetResultManager &&)=delete
NETCORE_API void	AddResultHandler (TUniquePtr< FNetResultHandler > &&InResultHandler, EAddResultHandlerPos Position=EAddResultHandlerPos::Last)
NETCORE_API void	AddResultHandlerPtr (FNetResultHandler *InResultHandler, EAddResultHandlerPos Position=EAddResultHandlerPos::Last)
NETCORE_API EHandleNetResult	HandleNetResult (FNetResult &&InResult)
NETCORE_API void	SetUnhandledResultCallback (FUnhandledResultFunc InCallback)

Detailed Description

Net Result Manager

Handles arbitrary net results, which may attempt recovery from errors instead of e.g. immediately closing the NetConnection

Member Typedef Documentation

FUnhandledResultFunc

using UE::Net::FNetResultManager::FUnhandledResultFunc = TUniqueFunction<EHandleNetResult(FNetResult&& InResult)>

Callback for handling results which no FNetResultHandler took ownership of

Parameters

InResult

Specifies the result

Constructor & Destructor Documentation

FNetResultManager() [1/3]

UE::Net::FNetResultManager::FNetResultManager ( )

default

FNetResultManager() [2/3]

UE::Net::FNetResultManager::FNetResultManager ( FNetResultManager &  )

delete

FNetResultManager() [3/3]

UE::Net::FNetResultManager::FNetResultManager ( FNetResultManager &&  )

delete

Member Function Documentation

AddResultHandler()

void UE::Net::FNetResultManager::AddResultHandler	(	TUniquePtr< FNetResultHandler > &&	InResultHandler,
		EAddResultHandlerPos	Position = EAddResultHandlerPos::Last
	)

Adds a new result handler to the result manager (owned by the result manager)

Parameters

InResultHandler	The new result handler to be added
Position	The position/precedence in the result handler list, to place the new handler

FNetResultManager

AddResultHandlerPtr()

void UE::Net::FNetResultManager::AddResultHandlerPtr	(	FNetResultHandler *	InResultHandler,
		EAddResultHandlerPos	Position = EAddResultHandlerPos::Last
	)

Adds a new result handler pointer to the result manager (not owned by the result manager)

Parameters

InResultHandler	The new result handler to be added
Position	The position/precedence in the result handler list, to place the new handler

HandleNetResult()

EHandleNetResult UE::Net::FNetResultManager::HandleNetResult

(

FNetResult &&

InResult

)

Takes a net result and passes it around to the result handlers and callbacks until it is handled, or returns 'EHandleNetResult::NotHandled'.

NOTE: InResult is moved when result is Closed/Handled, and not moved when result is NotHandled.

Parameters

InResult

Specifies the result

Returns

Whether or not the result has handled or resulted in a close, or went unhandled

operator=() [1/2]

FNetResultManager & UE::Net::FNetResultManager::operator= ( const FNetResultManager &  )

delete

operator=() [2/2]

FNetResultManager & UE::Net::FNetResultManager::operator= ( FNetResultManager &&  )

delete

SetUnhandledResultCallback()

void UE::Net::FNetResultManager::SetUnhandledResultCallback

(

FUnhandledResultFunc

InCallback

)

Sets a callback for handling net results which no result handlers have dealt with

Parameters

InCallback

The callback to use for unhandled results

---

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

• Engine/Source/Runtime/Net/Core/Public/Net/Core/Connection/NetResultManager.h
• Engine/Source/Runtime/Net/Core/Private/Net/Core/Connection/NetResultManager.cpp