TraceControlMessages.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Misc/Guid.h"
#include "Containers/BitArray.h"
#include "TraceControlMessages.generated.h"
 
/* Trace messages
 *****************************************************************************/
 
USTRUCT()
struct FTraceControlStatusPing
{
    GENERATED_USTRUCT_BODY()
};
 
USTRUCT()
struct FTraceControlStatus
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY(EditAnywhere, Category="Message")
    FString Endpoint;
    
    UPROPERTY(EditAnywhere, Category="Message")
    FGuid SessionGuid;
    
    UPROPERTY(EditAnywhere, Category="Message")
    FGuid TraceGuid;
 
    UPROPERTY(EditAnywhere, Category="Message")
    uint64 BytesSent = 0;
 
    UPROPERTY(EditAnywhere, Category="Message")
    uint64 BytesTraced = 0;
 
    UPROPERTY(EditAnywhere, Category="Message")
    uint64 MemoryUsed = 0;
 
    UPROPERTY(EditAnywhere, Category="Message")
    uint32 CacheAllocated = 0; 
 
    UPROPERTY(EditAnywhere, Category="Message")
    uint32 CacheUsed = 0;
 
    UPROPERTY(EditAnywhere, Category="Message")
    uint32 CacheWaste = 0;
 
    UPROPERTY(EditAnywhere, Category = "Message")
    bool bAreStatNamedEventsEnabled = false;
 
    UPROPERTY(EditAnywhere, Category = "Message")
    bool bIsPaused = false;
 
    UPROPERTY(EditAnywhere, Category = "Message")
    bool bIsTracing = false;
 
    UPROPERTY(EditAnywhere, Category = "Message")
    FDateTime StatusTimestamp;
 
    UPROPERTY(EditAnywhere, Category = "Message")
    uint8 TraceSystemStatus = 0;
};
 
USTRUCT()
struct FTraceControlSettingsPing
{
    GENERATED_USTRUCT_BODY()
};
 
USTRUCT()
struct FTraceChannelPreset
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY(EditAnywhere, Category = "Message")
    FString Name;
 
    UPROPERTY(EditAnywhere, Category = "Message")
    FString ChannelList;
 
    UPROPERTY(EditAnywhere, Category = "Message")
    bool bIsReadOnly = false;
};
 
USTRUCT()
struct FTraceControlSettings
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY(EditAnywhere, Category="Message")
    bool bUseWorkerThread = false;
    
    UPROPERTY(EditAnywhere, Category="Message")
    bool bUseImportantCache = false;
 
    UPROPERTY(EditAnywhere, Category="Message")
    uint32 TailSizeBytes = 0;
 
    UPROPERTY(EditAnywhere, Category = "Message")
    TArray<FTraceChannelPreset> ChannelPresets;
};
 
USTRUCT()
struct FTraceControlChannelsPing
{
    GENERATED_USTRUCT_BODY()
    
    UPROPERTY(EditAnywhere, Category="Message")
    uint32 KnownChannelCount = 0;
};
 
USTRUCT()
struct FTraceControlChannelsDesc
{
    GENERATED_USTRUCT_BODY()
    
    UPROPERTY(EditAnywhere, Category="Message")
    TArray<FString> Channels;
 
    UPROPERTY(EditAnywhere, Category="Message")
    TArray<uint32> Ids;
    
    UPROPERTY(EditAnywhere, Category="Message")
    TArray<FString> Descriptions;
    
    UPROPERTY(EditAnywhere, Category="Message")
    TArray<uint32> ReadOnlyIds;
};
 
USTRUCT()
struct FTraceControlChannelsStatus
{
    GENERATED_USTRUCT_BODY()
    
    UPROPERTY(EditAnywhere, Category="Message")
    TArray<uint32> EnabledIds;
};
 
 
USTRUCT()
struct FTraceControlChannelsSet
{
    GENERATED_USTRUCT_BODY()
    
    UPROPERTY(EditAnywhere, Category="Message")
    TArray<uint32> ChannelIdsToEnable;
    
    UPROPERTY(EditAnywhere, Category="Message")
    TArray<uint32> ChannelIdsToDisable;
};
 
USTRUCT()
struct FTraceControlChannelsSetError
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY(EditAnywhere, Category="Message")
    TMap<uint32, FString> Errors;
};
 
USTRUCT()
struct FTraceControlDiscoveryPing
{
    GENERATED_USTRUCT_BODY()
    
    UPROPERTY(EditAnywhere, Category="Message")
    FGuid SessionId;
    
    UPROPERTY(EditAnywhere, Category="Message")
    FGuid InstanceId;
};
 
USTRUCT()
struct FTraceControlDiscovery : public FTraceControlStatus
{
    GENERATED_USTRUCT_BODY()
    
    UPROPERTY(EditAnywhere, Category="Message")
    FGuid SessionId;
    
    UPROPERTY(EditAnywhere, Category="Message")
    FGuid InstanceId;
};
 
USTRUCT()
struct FTraceControlStop
{
    GENERATED_USTRUCT_BODY()
};
 
USTRUCT()
struct FTraceControlStartCommon
{
    GENERATED_USTRUCT_BODY()
    
    UPROPERTY(EditAnywhere, Category="Message")
    FString Channels;
 
    UPROPERTY(EditAnywhere, Category="Message")
    bool bExcludeTail = false;
};
 
USTRUCT()
struct FTraceControlSend : public FTraceControlStartCommon
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY(EditAnywhere, Category="Message")
    FString Host;
};
 
USTRUCT()
struct FTraceControlFile : public FTraceControlStartCommon
{
    GENERATED_USTRUCT_BODY()
    
    UPROPERTY(EditAnywhere, Category="Message")
    FString File;
    
    UPROPERTY(EditAnywhere, Category="Message")
    bool bTruncateFile = false;
};
 
USTRUCT()
struct FTraceControlPause
{
    GENERATED_USTRUCT_BODY()
};
 
USTRUCT()
struct FTraceControlResume
{
    GENERATED_USTRUCT_BODY()
};
 
USTRUCT()
struct FTraceControlSnapshotSend
{
    GENERATED_USTRUCT_BODY()
    
    UPROPERTY(EditAnywhere, Category="Message")
    FString Host;
};
 
USTRUCT()
struct FTraceControlSnapshotFile
{
    GENERATED_USTRUCT_BODY()
    
    UPROPERTY(EditAnywhere, Category="Message")
    FString File;
};
 
USTRUCT()
struct FTraceControlBookmark
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY(EditAnywhere, Category="Message")
    FString Label;
};
 
USTRUCT()
struct FTraceControlScreenshot
{
    GENERATED_USTRUCT_BODY()
    
    UPROPERTY(EditAnywhere, Category="Message")
    FString Name;
    
    UPROPERTY(EditAnywhere, Category="Message")
    bool bShowUI = true;
};
 
USTRUCT()
struct FTraceControlSetStatNamedEvents
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY(EditAnywhere, Category = "Message")
    bool bEnabled = false;
};