TraceAuxiliary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/StringFwd.h"
#include "CoreGlobals.h"
#include "Delegates/Delegate.h"
#include "HAL/Platform.h"
#include "HAL/PlatformCrt.h"
#include "Logging/LogCategory.h"
#include "Logging/LogMacros.h"
#include "Misc/Build.h"
#include "Misc/CoreMiscDefines.h"
 
#if !defined(UE_TRACE_SERVER_CONTROLS_ENABLED)
#   define UE_TRACE_SERVER_CONTROLS_ENABLED (PLATFORM_DESKTOP && !UE_BUILD_SHIPPING && !IS_PROGRAM)
#endif
 
class FTraceAuxiliary
{
public:
    enum class ETraceSystemStatus : uint8
    {
        NotAvailable, // Disabled at compile time.
        Available,
        TracingToServer,
        TracingToFile,
        TracingToCustomRelay,
 
        NumValues, // This must be the last value.
    };
 
    enum class EEnumerateResult : uint8
    {
        Continue,
        Stop,
    };
 
    struct FChannelPreset
    {
        FChannelPreset(const TCHAR* InName,const TCHAR* InChannels, bool bInIsReadOnly)
            : Name(InName)
            , ChannelList(InChannels)
            , bIsReadOnly(bInIsReadOnly)
        {
        }
 
        const TCHAR* Name;
        const TCHAR* ChannelList;
 
        bool bIsReadOnly = false;
    };
 
    typedef TFunctionRef<EEnumerateResult(const FChannelPreset& Preset)> PresetCallback;
 
    // In no logging configurations all log categories are of type FNoLoggingCategory, which has no relation with
    // FLogCategoryBase. In order to not need to conditionally set the argument alias the type here.
#if NO_LOGGING
    typedef FNoLoggingCategory FLogCategoryAlias;
#else
    typedef FLogCategoryBase FLogCategoryAlias;
#endif
 
    enum class EConnectionType : uint8
    {
        Network,
        File,
        Relay,
        None,
    };
 
    DECLARE_TS_MULTICAST_DELEGATE(FOnConnection);
 
    DECLARE_TS_MULTICAST_DELEGATE_TwoParams(FOnTraceStarted, FTraceAuxiliary::EConnectionType TraceType, const FString& TraceDestination);
 
    DECLARE_TS_MULTICAST_DELEGATE_TwoParams(FOnTraceStopped, FTraceAuxiliary::EConnectionType TraceType, const FString& TraceDestination);
 
    DECLARE_TS_MULTICAST_DELEGATE_TwoParams(FOnSnapshotSaved, FTraceAuxiliary::EConnectionType TraceType, const FString& TraceDestination);
 
    struct FOptions
    {
        UE_DEPRECATED(5.7, "Use -notracethread command line instead")
        bool bNoWorkerThread = false;
        bool bTruncateFile = false;
        bool bExcludeTail = false;
    };
 
    static CORE_API bool Start(EConnectionType Type, const TCHAR* Target, const TCHAR* Channels = TEXT("default"), FOptions* Options = nullptr, const FLogCategoryAlias& LogCategory = LogCore);
 
    static CORE_API bool Relay(UPTRINT Handle, UE::Trace::IoWriteFunc WriteFunc, UE::Trace::IoCloseFunc CloseFunc, const TCHAR* Channels = TEXT("default"), const FOptions* Options = nullptr);
 
    static CORE_API bool Stop();
 
    static CORE_API bool Pause();
 
    static CORE_API bool IsPaused();
 
    static CORE_API bool Resume();
 
    static CORE_API bool WriteSnapshot(const TCHAR* FilePath);
 
    static CORE_API bool SendSnapshot(const TCHAR* Host = nullptr, uint32 Port = 0);
 
    static CORE_API void Initialize(const TCHAR* CommandLine);
 
    static CORE_API void InitializePresets(const TCHAR* CommandLine);
 
    static CORE_API void Shutdown();
 
    static CORE_API void TryAutoConnect();
 
    static CORE_API void EnableCommandlineChannels();
 
    static CORE_API void EnableChannels(TConstArrayView<uint32> ChannelIds, TMap<uint32, FString>* OutErrors = nullptr);
 
    static CORE_API void DisableChannels(TConstArrayView<uint32> ChannelIds, TMap<uint32, FString>* OutErrors = nullptr);
 
    static CORE_API void EnableChannels(const TCHAR* Channels);
 
    static CORE_API void DisableChannels(const TCHAR* Channels = nullptr);
 
    static CORE_API FString GetTraceDestinationString();
 
    static CORE_API bool IsConnected();
 
    static CORE_API bool IsConnected(FGuid& OutSessionGuid, FGuid& OutTraceGuid);
 
    static CORE_API EConnectionType GetConnectionType();
 
    static CORE_API void GetActiveChannelsString(FStringBuilderBase& String);
 
    static CORE_API void Panic();
 
    static CORE_API struct UE::Trace::FInitializeDesc const* GetInitializeDesc();
 
    static CORE_API void EnumerateFixedChannelPresets(PresetCallback Callback);
 
    static CORE_API void EnumerateChannelPresetsFromSettings(PresetCallback Callback);
 
    static CORE_API FOnConnection OnConnection;
 
    static CORE_API FOnTraceStarted OnTraceStarted;
 
    static CORE_API FOnTraceStopped OnTraceStopped;
 
    static CORE_API FOnSnapshotSaved OnSnapshotSaved;
 
    static CORE_API ETraceSystemStatus GetTraceSystemStatus();
};
 
#if UE_TRACE_SERVER_CONTROLS_ENABLED
 
class FTraceServerControls
{
public:
    static CORE_API bool Start();
 
    static CORE_API bool Stop();
};
 
#endif // UE_TRACE_SERVER_CONTROLS_ENABLED