IrisDebugging.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "HAL/Platform.h"
#include "Iris/ReplicationSystem/NetRefHandle.h"
#include "Net/Core/NetHandle/NetHandle.h"
 
class UReplicationSystem;
namespace UE::Net
{
    struct FReplicationProtocol;
    struct FReplicationInstanceProtocol;
 
    typedef uint32 FReplicationProtocolIdentifier;
}
 
namespace UE::Net::Private
{
    typedef uint32 FInternalNetRefIndex;
}
 
#if !UE_BUILD_SHIPPING
 
namespace UE::Net::IrisDebugHelper
{
 
IRISCORE_API uint64 Init();
 
IRISCORE_API bool BreakOnObjectName(UObject* Object);
 
IRISCORE_API bool BreakOnNetRefHandle(FNetRefHandle NetRefHandle);
 
IRISCORE_API bool BreakOnRPCName(FName RPCName);
 
IRISCORE_API bool BreakOnInternalNetRefIndex(UE::Net::Private::FInternalNetRefIndex InternalIndex);
 
IRISCORE_API bool FilterDebuggedObject(UObject* Object);
 
IRISCORE_API UE::Net::Private::FInternalNetRefIndex GetDebugNetInternalIndex();
 
IRISCORE_API FNetRefHandle GetDebugNetRefHandle();
 
void NetObjectStateToString(FStringBuilderBase& StringBuilder, FNetRefHandle RefHandle);
 
void NetObjectProtocolReferencesToString(FStringBuilderBase& StringBuilder, FReplicationProtocolIdentifier ProtocolId, uint32 ReplicationSystemId);
 
// Helper functions for debugging state data exposed as extern "C" that are callable from immediate and watch window in the debugger
 
extern "C" IRISCORE_API UReplicationSystem* GetReplicationSystemForDebug(uint32 Id);
 
extern "C" IRISCORE_API void DebugOutputNetObjectState(uint64 NetRefHandleId, uint32 ReplicationSystemId);
 
 //$IRIS TODO: Make console command to log these for object X or class X
extern "C" IRISCORE_API const TCHAR* DebugNetObjectStateToString(uint32 NetRefHandleId, uint32 ReplicationSystemId);
 
extern "C" IRISCORE_API void DebugOutputNetObjectProtocolReferences(FReplicationProtocolIdentifier ProtocolId, uint32 ReplicationSystemId);
 
struct FNetReplicatedObjectDebugInfo
{
    const FNetRefHandle* RefHandle;
    UE::Net::Private::FInternalNetRefIndex InternalNetRefIndex;
    const UReplicationSystem* ReplicationSystem;
    const FReplicationProtocol* Protocol;
    const FReplicationInstanceProtocol* InstanceProtocol;
    const UObject* Object;
};
 
extern "C" IRISCORE_API FNetReplicatedObjectDebugInfo DebugNetObject(UObject* Instance);
 
extern "C" IRISCORE_API FNetReplicatedObjectDebugInfo DebugNetObjectById(UObject* Instance, uint32 ReplicationSystemId);
 
extern "C" IRISCORE_API FNetReplicatedObjectDebugInfo DebugNetRefHandle(FNetRefHandle Handle);
 
extern "C" IRISCORE_API FNetReplicatedObjectDebugInfo DebugNetRefHandleById(uint64 NetRefHandleId, uint32 ReplicationSystemId);
 
extern "C" IRISCORE_API FNetReplicatedObjectDebugInfo DebugInternalNetRefIndex(UE::Net::Private::FInternalNetRefIndex InternalIndex, uint32 ReplicationSystemId);
 
extern "C" IRISCORE_API const TCHAR* DebugNetObjectProtocolReferencesToString(FReplicationProtocolIdentifier ProtocolId, uint32 ReplicationSystemId);
 
extern "C" IRISCORE_API void SetIrisDebugObjectName(const ANSICHAR* NameBuffer);
 
extern "C" IRISCORE_API void SetIrisDebugNetRefHandle(uint64 NetHandleId);
 
extern "C" IRISCORE_API void SetIrisDebugInternalNetRefIndex(UE::Net::Private::FInternalNetRefIndex InternalIndex);
 
extern "C" IRISCORE_API void SetIrisDebugInternalNetRefIndexViaNetHandle(FNetRefHandle RefHandle);
 
extern "C" IRISCORE_API void SetIrisDebugInternalNetRefIndexViaObject(UObject* Instance);
 
extern "C" IRISCORE_API void SetIrisDebugRPCName(const ANSICHAR* NameBuffer);
 
}; // end of UE::Net::IrisDebugHelper
 
#endif