ITraceController.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Map.h"
#include "Containers/UnrealString.h"
#include "Delegates/Delegate.h"
#include "ITraceControllerCommands.h"
#include "Misc/DateTime.h"
#include "Misc/Guid.h"
#include "Algo/Find.h"
 
struct FTraceStatus
{
    enum class EUpdateType : uint8
    {
        Status          = 1 << 0,
        Settings        = 1 << 1,
        ChannelsDesc    = 1 << 2,
        ChannelsStatus  = 1 << 3,
        All             = Status|Settings|ChannelsDesc|ChannelsStatus
    };
 
    enum class ETraceSystemStatus : uint8
    {
        NotAvailable,
        Available,
        TracingToServer,
        TracingToFile,
        TracingToCustomRelay,
 
        NumValues,
    };
 
    struct FChannelPreset
    {
        FChannelPreset(const FString& InName, const FString& InChannels, bool bInIsReadOnly)
            : Name(InName)
            , ChannelList(InChannels)
            , bIsReadOnly(bInIsReadOnly)
        {
        }
 
        FString Name;
        FString ChannelList;
        bool bIsReadOnly;
    };
    
    struct FSettings
    {
        bool bUseWorkerThread;
        bool bUseImportantCache;
        uint32 TailSizeBytes;
        TArray<FChannelPreset> ChannelPresets;
    };
 
    struct FChannel
    {
        FString Name;
        FString Description;
        uint32 Id;
        bool bEnabled;
        bool bReadOnly;
    };
 
    struct FStats
    {
        uint64 BytesSent;
        uint64 BytesTraced;
        uint64 MemoryUsed;
        uint32 CacheAllocated;
        uint32 CacheUsed;
        uint32 CacheWaste;
    };
    
    FGuid SessionId;
    FGuid InstanceId;
    bool bIsTracing = false;
    bool bIsPaused = false;
    bool bAreStatNamedEventsEnabled = false;
    FString Endpoint;
    FGuid SessionGuid;
    FGuid TraceGuid;
    FSettings Settings;
    TMap<uint32, FChannel> Channels;
    FStats Stats;
    FDateTime StatusTimestamp;
    ETraceSystemStatus TraceSystemStatus;
 
    bool HasChannel(FStringView ChannelName) const
    {
        for (const auto& ChannelPair : Channels)
        {
            FStringView Name (ChannelPair.Value.Name);
            if (Name.Compare(ChannelName, ESearchCase::IgnoreCase) == 0)
            {
                return true;
            }
        }
        return false;
    }
};
 
ENUM_CLASS_FLAGS(FTraceStatus::EUpdateType);
 
 
class ITraceController
{
public:
    
    virtual ~ITraceController() = default;
 
    virtual void SendDiscoveryRequest(const FGuid& SessionId, const FGuid& InstanceId) const = 0;
 
    virtual void SendDiscoveryRequest() = 0;
 
    virtual void SendStatusUpdateRequest() = 0;
 
    virtual void SendChannelUpdateRequest() = 0;
 
    virtual void SendSettingsUpdateRequest() = 0;
 
    DECLARE_EVENT_ThreeParams(ITraceController, FStatusRecievedEvent, const FTraceStatus&, FTraceStatus::EUpdateType, ITraceControllerCommands&);
 
    virtual FStatusRecievedEvent& OnStatusReceived() = 0;
 
    virtual bool HasAvailableInstance(const FGuid& InstanceId) = 0;
 
    typedef TFunction<void(const FTraceStatus&, ITraceControllerCommands&)> FCallback;
 
    virtual void WithInstance(FGuid InstanceId, FCallback Func) = 0;
 
    SESSIONSERVICES_API static TSharedPtr<ITraceController> Create(TSharedPtr<class IMessageBus>& MessageBus);
};