IMessageTracer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Containers/Array.h"
#include "Containers/Map.h"
#include "Delegates/Delegate.h"
#include "Templates/SharedPointer.h"
 
#include "IMessageContext.h"
 
struct FMessageTracerEndpointInfo;
struct FMessageTracerMessageInfo;
struct FMessageTracerTypeInfo;
 
 
enum class EMessageTracerBreakpointState
{
    Disabled,
 
    Enabled,
 
    EnabledIn,
 
    EnabledOut,
};
 
 
enum class EMessageTracerDispatchTypes
{
    Direct,
 
    Pending,
 
    TaskGraph
};
 
 
struct FMessageTracerBreakpoint
{
    FMessageAddress BreakOnRecipient;
 
    FMessageAddress BreakOnSender;
 
    int64 HitCount;
 
    EMessageTracerBreakpointState State;
};
 
 
struct FMessageTracerDispatchState
{
    double DispatchLatency;
 
    EMessageTracerDispatchTypes DispatchType;
 
    TSharedPtr<FMessageTracerEndpointInfo> EndpointInfo;
 
    ENamedThreads::Type RecipientThread;
 
    double TimeDispatched;
 
    double TimeHandled;
};
 
 
struct FMessageTracerAddressInfo
{
    FMessageAddress Address;
 
    double TimeRegistered;
 
    double TimeUnregistered;
};
 
 
struct FMessageTracerEndpointInfo
{
    TMap<FMessageAddress, TSharedPtr<FMessageTracerAddressInfo>> AddressInfos;
 
    FName Name;
 
    TArray<TSharedPtr<FMessageTracerMessageInfo>> ReceivedMessages;
 
    bool Remote;
 
    TArray<TSharedPtr<FMessageTracerMessageInfo>> SentMessages;
};
 
 
struct FMessageTracerInterceptorInfo
{
    FName Name;
 
    TArray<TSharedPtr<FMessageTracerMessageInfo>> InterceptedMessages;
 
    double TimeRegistered;
 
    double TimeUnregistered;
};
 
 
struct FMessageTracerMessageInfo
{
    TSharedPtr<IMessageContext, ESPMode::ThreadSafe> Context;
 
    TMap<TSharedPtr<FMessageTracerEndpointInfo>, TSharedPtr<FMessageTracerDispatchState>> DispatchStates;
 
    bool Intercepted;
 
    TSharedPtr<FMessageTracerEndpointInfo> SenderInfo;
 
    double TimeRouted;
 
    double TimeSent;
 
    TSharedPtr<FMessageTracerTypeInfo> TypeInfo;
};
 
 
struct FMessageTracerTypeInfo
{
    TArray<TSharedPtr<FMessageTracerMessageInfo>> Messages;
 
    UE_DEPRECATED(5.1, "Types names are now represented by path names. Please use TypePathName.")
    FName TypeName;
 
    FTopLevelAssetPath TypePathName;
};
 
 
class IMessageTracer
{
public:
 
    virtual void Break() = 0;
 
    virtual void Continue() = 0;
 
    virtual bool IsBreaking() const = 0;
 
    virtual bool IsRunning() const = 0;
 
    virtual void Reset() = 0;
 
    virtual void Step() = 0;
 
    virtual void Stop() = 0;
 
    virtual bool Tick(float DeltaTime) = 0;
 
public:
 
    virtual int32 GetEndpoints(TArray<TSharedPtr<FMessageTracerEndpointInfo>>& OutEndpoints) const = 0;
 
    virtual int32 GetMessages(TArray<TSharedPtr<FMessageTracerMessageInfo>>& OutMessages) const = 0;
 
    virtual int32 GetMessageTypes(TArray<TSharedPtr<FMessageTracerTypeInfo>>& OutTypes) const = 0;
 
    virtual bool HasMessages() const = 0;
 
public:
 
    typedef TSharedRef<FMessageTracerMessageInfo> FMessageTracerMessageInfoRef;
    typedef TSharedRef<FMessageTracerTypeInfo> FMessageTracerTypeInfoRef;
 
    DECLARE_EVENT_OneParam(IMessageTracer, FOnMessageAdded, FMessageTracerMessageInfoRef)
    virtual FOnMessageAdded& OnMessageAdded() = 0;
 
    DECLARE_EVENT(IMessageTracer, FOnMessagesReset)
    virtual FOnMessagesReset& OnMessagesReset() = 0;
 
    DECLARE_EVENT_OneParam(IMessageTracer, FOnTypeAdded, FMessageTracerTypeInfoRef)
    virtual FOnTypeAdded& OnTypeAdded() = 0;
 
protected:
 
    virtual ~IMessageTracer() { }
};