UE::Net::TNetResult< ResultEnum > Struct Template Reference

#include <NetResult.h>

Inheritance diagram for UE::Net::TNetResult< ResultEnum >:

Public Types
using	UnderlyingResultType = __underlying_type(ResultEnum)

Public Member Functions
	TNetResult (ResultEnum InResult=ResultEnum::Unknown)
	TNetResult (ResultEnum InResult, const FString &InErrorContext)
FString	ToString (ENetResultString ConversionType=ENetResultString::WithoutChain) const
bool	WasSuccessful () const
ResultEnum	GetResult () const
const FString &	GetErrorContext () const
bool	HasChainResult (const TNetResult &A) const
bool	operator== (ResultEnum A) const
bool	operator!= (ResultEnum A) const
Public Member Functions inherited from UE::Net::FNetResult
	FNetResult (const FNetResult &)=default
FNetResult &	operator= (const FNetResult &)=default
	FNetResult (FNetResult &&)=default
FNetResult &	operator= (FNetResult &&)=default
	~FNetResult ()=default
bool	operator== (const FNetResult &A) const
bool	operator!= (const FNetResult &A) const
NETCORE_API FString	DynamicToString (ENetResultString ConversionType=ENetResultString::WithoutChain) const
void	AddChainResult (FNetResult &&InResult)
template<typename T , typename = typename TEnableIf<TIsEnum<T>::Value>::Type>
void	AddChainResult (TNetResult< T > &&InResult)
template<typename ResultEnum , typename = typename TEnableIf<TIsEnum<ResultEnum>::Value>::Type>
bool	HasChainResult (ResultEnum A) const

Detailed Description

template<typename ResultEnum>
struct UE::Net::TNetResult< ResultEnum >

Generic result struct for Network Results (e.g. Close and failures) - partially adapted from FOnlineError/FResult. ResultEnum must have LexToString implemented, and DECLARE_NETRESULT_ENUM(ResultEnum) must be declared for each enum type.

NOTE: Support for using results to modify control flow, depends on how they are implemented in the netcode.

Member Typedef Documentation

UnderlyingResultType

template<typename ResultEnum >

using UE::Net::TNetResult< ResultEnum >::UnderlyingResultType = __underlying_type(ResultEnum)

Constructor & Destructor Documentation

TNetResult() [1/2]

template<typename ResultEnum >

UE::Net::TNetResult< ResultEnum >::TNetResult ( ResultEnum  InResult = ResultEnum::Unknown )

inline

Default constructor

Parameters

InResult

The type of result

TNetResult() [2/2]

template<typename ResultEnum >

UE::Net::TNetResult< ResultEnum >::TNetResult ( ResultEnum  InResult, const FString &  InErrorContext  )

inline

Main constructor, specifying full result (usually error)

Parameters

InResult	The type of result
InErrorContext	Additional context associated with error results (to be interpreted by code)

Member Function Documentation

GetErrorContext()

template<typename ResultEnum >

const FString & UE::Net::TNetResult< ResultEnum >::GetErrorContext ( ) const

inline

GetResult()

template<typename ResultEnum >

ResultEnum UE::Net::TNetResult< ResultEnum >::GetResult ( ) const

inline

HasChainResult()

template<typename ResultEnum >

bool UE::Net::TNetResult< ResultEnum >::HasChainResult ( const TNetResult< ResultEnum > &  A ) const

inline

Determines whether the specified result is contained within this result chain NOTE: Also checks against the error code

Parameters

A	The result to search for

Returns

Whether or not the result exists in the chain

operator!=()

template<typename ResultEnum >

bool UE::Net::TNetResult< ResultEnum >::operator!= ( ResultEnum  A ) const

inline

operator==()

template<typename ResultEnum >

bool UE::Net::TNetResult< ResultEnum >::operator== ( ResultEnum  A ) const

inline

Operators

ToString()

template<typename ResultEnum >

FString UE::Net::TNetResult< ResultEnum >::ToString ( ENetResultString  ConversionType = ENetResultString::WithoutChain ) const

inline

Convert result to human readable string (ExportText style)

Parameters

ConversionType

The type of string conversion to perform (e.g. whether or not to include the whole chain of results)

Returns

Returns the result converted to a string

WasSuccessful()

template<typename ResultEnum >

bool UE::Net::TNetResult< ResultEnum >::WasSuccessful ( ) const

inline

Accessors

---

The documentation for this struct was generated from the following file:

• Engine/Source/Runtime/Net/Core/Public/Net/Core/Connection/NetResult.h