UE::Net::IrisDebugHelper Namespace Reference

Namespaces
namespace	IrisDebugHelperInternal

Classes
struct	FNetReplicatedObjectDebugInfo

Functions
bool	BreakOnObjectName (UObject *Object)
bool	FilterDebuggedObject (UObject *Object)
bool	BreakOnNetRefHandle (FNetRefHandle NetRefHandle)
bool	BreakOnRPCName (FName RPCName)
bool	BreakOnInternalNetRefIndex (UE::Net::Private::FInternalNetRefIndex InternalIndex)
UE::Net::Private::FInternalNetRefIndex	GetDebugInternalNetRefIndex ()
FNetRefHandle	GetDebugNetRefHandle ()
void	SetIrisDebugObjectName (const ANSICHAR *NameBuffer)
void	SetIrisDebugNetRefHandle (uint64 NetRefHandleId)
void	SetIrisDebugRPCName (const ANSICHAR *NameBuffer)
void	SetIrisDebugInternalNetRefIndex (UE::Net::Private::FInternalNetRefIndex InternalIndex)
void	SetIrisDebugInternalNetRefIndexViaNetHandle (FNetRefHandle RefHandle)
void	SetIrisDebugInternalNetRefIndexViaObject (UObject *Instance)
UReplicationSystem *	GetReplicationSystemForDebug (uint32 Id)
uint64	Init ()
void	NetObjectStateToString (FStringBuilderBase &StringBuilder, FNetRefHandle RefHandle)
void	DebugOutputNetObjectState (uint64 NetRefHandleId, uint32 ReplicationSystemId)
const TCHAR *	DebugNetObjectStateToString (uint32 NetRefHandleId, uint32 ReplicationSystemId)
FNetReplicatedObjectDebugInfo	DebugNetObject (UObject *Instance)
FNetReplicatedObjectDebugInfo	DebugNetObjectById (UObject *Instance, uint32 ReplicationSystemId)
FNetReplicatedObjectDebugInfo	DebugNetRefHandle (FNetRefHandle Handle)
FNetReplicatedObjectDebugInfo	DebugNetRefHandleById (uint64 NetRefHandleId, uint32 ReplicationSystemId)
FNetReplicatedObjectDebugInfo	DebugInternalNetRefIndex (uint32 InternalIndex, uint32 ReplicationSystemId)
void	NetObjectProtocolReferencesToString (FStringBuilderBase &StringBuilder, FReplicationProtocolIdentifier ProtocolId, uint32 ReplicationSystemId)
void	DebugOutputNetObjectProtocolReferences (FReplicationProtocolIdentifier ProtocolId, uint32 ReplicationSystemId)
const TCHAR *	DebugNetObjectProtocolReferencesToString (FReplicationProtocolIdentifier ProtocolId, uint32 ReplicationSystemId)
IRISCORE_API UE::Net::Private::FInternalNetRefIndex	GetDebugNetInternalIndex ()

Function Documentation

BreakOnInternalNetRefIndex()

IRISCORE_API bool UE::Net::IrisDebugHelper::BreakOnInternalNetRefIndex

(

UE::Net::Private::FInternalNetRefIndex

InternalIndex

)

Trigger a breakpoint and return true if the index is the current debug index

BreakOnNetRefHandle()

IRISCORE_API bool UE::Net::IrisDebugHelper::BreakOnNetRefHandle

(

FNetRefHandle

NetRefHandle

)

Trigger a breakpoint and return true if the NetRefHandle is the current debug NetRefHandle

BreakOnObjectName()

IRISCORE_API bool UE::Net::IrisDebugHelper::BreakOnObjectName

(

UObject *

Object

)

Trigger a breakpoint and return true if the object contains the current debug name

BreakOnRPCName()

IRISCORE_API bool UE::Net::IrisDebugHelper::BreakOnRPCName

(

FName

RPCName

)

Trigger a breakpoint and return true if the name contains the debug RPC string

DebugInternalNetRefIndex()

IRISCORE_API FNetReplicatedObjectDebugInfo UE::Net::IrisDebugHelper::DebugInternalNetRefIndex	(	UE::Net::Private::FInternalNetRefIndex	InternalIndex,
		uint32	ReplicationSystemId
	)

Look up replicated handle specified by an internal index and replicationsystem id and return debug information

DebugNetObject()

IRISCORE_API FNetReplicatedObjectDebugInfo UE::Net::IrisDebugHelper::DebugNetObject

(

UObject *

Instance

)

Look up replicated handle from Instance pointer and return debug information. This variant searches all active replication systems and returns information for the first one replicating the Instance.

DebugNetObjectById()

IRISCORE_API FNetReplicatedObjectDebugInfo UE::Net::IrisDebugHelper::DebugNetObjectById	(	UObject *	Instance,
		uint32	ReplicationSystemId
	)

Look up replicated handle from Instance pointer and return debug information. This variant only searches the ReplicationSystem with the specified id.

DebugNetObjectProtocolReferencesToString()

IRISCORE_API const TCHAR * UE::Net::IrisDebugHelper::DebugNetObjectProtocolReferencesToString	(	FReplicationProtocolIdentifier	ProtocolId,
		uint32	ReplicationSystemId
	)

Variant of DebugOutputNetObjectProtocolReferences that can be used from breakpoints or in watch window to find all handles references registered for a protocol and output to DebugOutput in debugger NOTE: Use only for debugging as this variant uses a static buffer which is not thread safe

DebugNetObjectStateToString()

IRISCORE_API const TCHAR * UE::Net::IrisDebugHelper::DebugNetObjectStateToString	(	uint32	NetRefHandleId,
		uint32	ReplicationSystemId
	)

Variant of NetObjectStateToString that can be used from breakpoints and in watch window to print the current state of a NetRefHandle. NOTE: Use only for debugging as this variant uses a static buffer which is not thread safe.

DebugNetRefHandle()

IRISCORE_API FNetReplicatedObjectDebugInfo UE::Net::IrisDebugHelper::DebugNetRefHandle

(

FNetRefHandle

Handle

)

Look up replicated handle and return debug information

DebugNetRefHandleById()

IRISCORE_API FNetReplicatedObjectDebugInfo UE::Net::IrisDebugHelper::DebugNetRefHandleById	(	uint64	NetRefHandleId,
		uint32	ReplicationSystemId
	)

Look up replicated handle specified by handle id and replicationsystem id and return debug information

DebugOutputNetObjectProtocolReferences()

IRISCORE_API void UE::Net::IrisDebugHelper::DebugOutputNetObjectProtocolReferences	(	FReplicationProtocolIdentifier	ProtocolId,
		uint32	ReplicationSystemId
	)

Find all handles references registered for a protocol and output to DebugOutput in debugger

DebugOutputNetObjectState()

IRISCORE_API void UE::Net::IrisDebugHelper::DebugOutputNetObjectState	(	uint64	NetRefHandleId,
		uint32	ReplicationSystemId
	)

DebugOutputObject state for Handle specified by NetRefHandleId and ReplicationSystemId.

FilterDebuggedObject()

IRISCORE_API bool UE::Net::IrisDebugHelper::FilterDebuggedObject

(

UObject *

Object

)

Returns true if the object name contains the current debug name, will return true if no debug name is set

GetDebugInternalNetRefIndex()

UE::Net::Private::FInternalNetRefIndex UE::Net::IrisDebugHelper::GetDebugInternalNetRefIndex

(

)

GetDebugNetInternalIndex()

IRISCORE_API UE::Net::Private::FInternalNetRefIndex UE::Net::IrisDebugHelper::GetDebugNetInternalIndex

(

)

Returns the internal index set via SetIrisDebugInternalIndex

GetDebugNetRefHandle()

IRISCORE_API FNetRefHandle UE::Net::IrisDebugHelper::GetDebugNetRefHandle

(

)

Returns the NetRefHandle set via SetIrisDebugNetRefHandle

GetReplicationSystemForDebug()

IRISCORE_API UReplicationSystem * UE::Net::IrisDebugHelper::GetReplicationSystemForDebug

(

uint32

Id

)

Get the ReplicationSystem with the Id

Init()

IRISCORE_API uint64 UE::Net::IrisDebugHelper::Init

(

)

Dummy methods binding pointers to external methods to avoid them from being stripped by compiler

NetObjectProtocolReferencesToString()

void UE::Net::IrisDebugHelper::NetObjectProtocolReferencesToString	(	FStringBuilderBase &	StringBuilder,
		FReplicationProtocolIdentifier	ProtocolId,
		uint32	ReplicationSystemId
	)

Find all handles references registered for a protocol and output to StringBuilder

NetObjectStateToString()

void UE::Net::IrisDebugHelper::NetObjectStateToString	(	FStringBuilderBase &	StringBuilder,
		FNetRefHandle	RefHandle
	)

Output state data to StringBuilder for the specified Handle

SetIrisDebugInternalNetRefIndex()

IRISCORE_API void UE::Net::IrisDebugHelper::SetIrisDebugInternalNetRefIndex

(

UE::Net::Private::FInternalNetRefIndex

InternalIndex

)

Set the InternalIndex to break on

SetIrisDebugInternalNetRefIndexViaNetHandle()

IRISCORE_API void UE::Net::IrisDebugHelper::SetIrisDebugInternalNetRefIndexViaNetHandle

(

FNetRefHandle

RefHandle

)

Set the InternalIndex to break on via it's NetHandle

SetIrisDebugInternalNetRefIndexViaObject()

IRISCORE_API void UE::Net::IrisDebugHelper::SetIrisDebugInternalNetRefIndexViaObject

(

UObject *

Instance

)

Set the InternalIndex to break on via an object pointer

SetIrisDebugNetRefHandle()

IRISCORE_API void UE::Net::IrisDebugHelper::SetIrisDebugNetRefHandle

(

uint64

NetHandleId

)

Set the NetHandle to break on

SetIrisDebugObjectName()

IRISCORE_API void UE::Net::IrisDebugHelper::SetIrisDebugObjectName

(

const ANSICHAR *

NameBuffer

)

Set the Object Name to break on

SetIrisDebugRPCName()

IRISCORE_API void UE::Net::IrisDebugHelper::SetIrisDebugRPCName

(

const ANSICHAR *

NameBuffer

)

Set the RPC Name to break on