UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
FTraceStatus Struct Reference

#include <ITraceController.h>

Classes

struct  FChannel
 
struct  FChannelPreset
 
struct  FSettings
 
struct  FStats
 

Public Types

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
}
 

Public Member Functions

bool HasChannel (FStringView ChannelName) const
 

Public Attributes

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
 

Detailed Description

Describes the state of a single remote instance with Trace.

Member Enumeration Documentation

◆ ETraceSystemStatus

enum class FTraceStatus::ETraceSystemStatus : uint8
strong
Enumerator
NotAvailable 
Available 
TracingToServer 
TracingToFile 
TracingToCustomRelay 
NumValues 

◆ EUpdateType

enum class FTraceStatus::EUpdateType : uint8
strong

Update types

Enumerator
Status 
Settings 
ChannelsDesc 
ChannelsStatus 
All 

Member Function Documentation

◆ HasChannel()

bool FTraceStatus::HasChannel ( FStringView  ChannelName) const
inline

Member Data Documentation

◆ bAreStatNamedEventsEnabled

bool FTraceStatus::bAreStatNamedEventsEnabled = false

If stats are emitted as named events

◆ bIsPaused

bool FTraceStatus::bIsPaused = false

If tracing is paused

◆ bIsTracing

bool FTraceStatus::bIsTracing = false

If tracing is active

◆ Channels

TMap<uint32, FChannel> FTraceStatus::Channels

State of channels

◆ Endpoint

FString FTraceStatus::Endpoint

Endpoint of active trace

◆ InstanceId

FGuid FTraceStatus::InstanceId

Instance id of the process we're controlling

◆ SessionGuid

FGuid FTraceStatus::SessionGuid

Session identifier for the trace.

◆ SessionId

FGuid FTraceStatus::SessionId

Session id of the process we're controlling

◆ Settings

FSettings FTraceStatus::Settings

Settings

◆ Stats

FStats FTraceStatus::Stats

Stats

◆ StatusTimestamp

FDateTime FTraceStatus::StatusTimestamp

Timestamp when the state of the trace was captured

◆ TraceGuid

FGuid FTraceStatus::TraceGuid

Unique identifier for the trace

◆ TraceSystemStatus

ETraceSystemStatus FTraceStatus::TraceSystemStatus

The status of the trace system.

The documentation for this struct was generated from the following file: