MessageTracer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/Guid.h"
#include "Containers/Queue.h"
#include "IMessageContext.h"
#include "IMessageTracer.h"
#include "Containers/Ticker.h"
 
class IMessageInterceptor;
class IMessageReceiver;
class IMessageSubscription;
class IMessageTracerBreakpoint;
 
class FMessageTracer
    : public IMessageTracer
{
public:
 
    FMessageTracer();
 
    virtual ~FMessageTracer();
 
public:
 
    void TraceAddedInterceptor(const TSharedRef<IMessageInterceptor, ESPMode::ThreadSafe>& Interceptor, const FTopLevelAssetPath& MessageType);
 
    void TraceAddedRecipient(const FMessageAddress& Address, const TSharedRef<IMessageReceiver, ESPMode::ThreadSafe>& Recipient);
 
    void TraceAddedSubscription(const TSharedRef<IMessageSubscription, ESPMode::ThreadSafe>& Subscription);
 
    void TraceDispatchedMessage(const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context, const TSharedRef<IMessageReceiver, ESPMode::ThreadSafe>& Recipient, bool Async);
 
    void TraceHandledMessage(const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context, const TSharedRef<IMessageReceiver, ESPMode::ThreadSafe>& Recipient);
 
    void TraceInterceptedMessage(const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context, const TSharedRef<IMessageInterceptor, ESPMode::ThreadSafe>& Interceptor);
 
    void TraceRemovedInterceptor(const TSharedRef<IMessageInterceptor, ESPMode::ThreadSafe>& Interceptor, const FTopLevelAssetPath& MessageType);
 
    void TraceRemovedRecipient(const FMessageAddress& Address);
 
    void TraceRemovedSubscription(const TSharedRef<IMessageSubscription, ESPMode::ThreadSafe>& Subscription, const FTopLevelAssetPath& MessageType);
 
    void TraceRoutedMessage(const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context);
 
    void TraceSentMessage(const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context);
 
public:
 
    //~ IMessageTracer interface
 
    virtual void Break() override;
    virtual void Continue() override;
    virtual int32 GetEndpoints(TArray<TSharedPtr<FMessageTracerEndpointInfo>>& OutEndpoints) const override;
    virtual int32 GetMessages(TArray<TSharedPtr<FMessageTracerMessageInfo>>& OutMessages) const override;
    virtual int32 GetMessageTypes(TArray<TSharedPtr<FMessageTracerTypeInfo>>& OutTypes) const override;
    virtual bool HasMessages() const override;
    virtual bool IsBreaking() const override;
    virtual bool IsRunning() const override;
 
    DECLARE_DERIVED_EVENT(FMessageTracer, IMessageTracer::FOnMessageAdded, FOnMessageAdded)
    virtual FOnMessageAdded& OnMessageAdded() override
    {
        return MessagesAddedDelegate;
    }
 
    DECLARE_DERIVED_EVENT(FMessageTracer, IMessageTracer::FOnMessagesReset, FOnMessagesReset)
    virtual FOnMessagesReset& OnMessagesReset() override
    {
        return MessagesResetDelegate;
    }
 
    DECLARE_DERIVED_EVENT(FMessageTracer, IMessageTracer::FOnTypeAdded, FOnTypeAdded)
    virtual FOnTypeAdded& OnTypeAdded() override
    {
        return TypeAddedDelegate;
    }
 
    virtual void Reset() override;
    virtual void Step() override;
    virtual void Stop();
    virtual bool Tick(float DeltaTime) override;
 
protected:
 
    void ResetMessages();
 
    bool ShouldBreak(const TSharedRef<IMessageContext, ESPMode::ThreadSafe>& Context) const;
 
private:
 
    TMap<FMessageAddress, TSharedPtr<FMessageTracerEndpointInfo>> AddressesToEndpointInfos;
 
    bool Breaking;
 
    TArray<TSharedPtr<IMessageTracerBreakpoint, ESPMode::ThreadSafe>> Breakpoints;
 
    FEvent* ContinueEvent;
 
    TMap<FGuid, TSharedPtr<FMessageTracerInterceptorInfo>> Interceptors;
 
    TMap<FGuid, TSharedPtr<FMessageTracerEndpointInfo>> RecipientsToEndpointInfos;
 
    TMap<TSharedPtr<IMessageContext, ESPMode::ThreadSafe>, TSharedPtr<FMessageTracerMessageInfo>> MessageInfos;
 
    TMap<FTopLevelAssetPath, TSharedPtr<FMessageTracerTypeInfo>> MessageTypes;
 
    bool ResetPending;
 
    bool Running;
 
    FTSTicker::FDelegateHandle TickDelegateHandle;
 
    TQueue<TFunction<void()>, EQueueMode::Mpsc> Traces;
 
private:
 
    FOnMessageAdded MessagesAddedDelegate;
 
    FOnMessagesReset MessagesResetDelegate;
 
    FOnTypeAdded TypeAddedDelegate;
};