1. Epic GamesDeveloper
  3. FTraceAuxiliary

FTraceAuxiliary

API > API/Runtime > API/Runtime/Core

   
Name FTraceAuxiliary
Type class
Header File /Engine/Source/Runtime/Core/Public/ProfilingDebugging/TraceAuxiliary.h
Include Path #include "ProfilingDebugging/TraceAuxiliary.h"

Syntax

class FTraceAuxiliary

Structs

Name Remarks
FChannelPreset  
FOptions  

Enums

Public

Name Remarks
EConnectionType  
EEnumerateResult  
ETraceSystemStatus This enum is serialized and sent via the trace service.

Typedefs

Name Type Remarks Include Path
FLogCategoryAlias FLogCategoryBase In no logging configurations all log categories are of type FNoLoggingCategory, which has no relation with FLogCategoryBase. ProfilingDebugging/TraceAuxiliary.h
PresetCallback TFunctionRef< EEnumerateResult(const FChannelPreset &Preset)>   ProfilingDebugging/TraceAuxiliary.h

Constants

Name Type Remarks Include Path
OnConnection FOnConnection Delegate that triggers when a connection is established. ProfilingDebugging/TraceAuxiliary.h
OnSnapshotSaved FOnSnapshotSaved Delegate that triggers when a snapshot has been saved. ProfilingDebugging/TraceAuxiliary.h
OnTraceStarted FOnTraceStarted Delegate that triggers when a trace session is started. ProfilingDebugging/TraceAuxiliary.h
OnTraceStopped FOnTraceStopped Delegate that triggers when a trace has finished recording. ProfilingDebugging/TraceAuxiliary.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

DECLARE_TS_MULTICAST_DELEGATE ( FOnConnection
)

 Callback type when a new connection is established. ProfilingDebugging/TraceAuxiliary.h  

DECLARE_TS_MULTICAST_DELEGATE_TwoParams ( FOnSnapshotSaved,
FTraceAuxiliary::EConnectionType TraceType,
const FString& TraceDestination
)

 Callback whenever a trace snapshot is saved. Path is the file system path of the snapshot file. ProfilingDebugging/TraceAuxiliary.h  

DECLARE_TS_MULTICAST_DELEGATE_TwoParams ( FOnTraceStopped,
FTraceAuxiliary::EConnectionType TraceType,
const FString& TraceDestination
)

 Callback whenever a trace recording is stopped. ProfilingDebugging/TraceAuxiliary.h  

DECLARE_TS_MULTICAST_DELEGATE_TwoParams ( FOnTraceStarted,
FTraceAuxiliary::EConnectionType TraceType,
const FString& TraceDestination
)

 Callback whenever a trace is started ProfilingDebugging/TraceAuxiliary.h  

Static

Name Remarks Include Path Unreal Specifiers

static void DisableChannels ( TConstArrayView< uint32 > ChannelIds,
TMap< uint32, FString >* OutErrors
)

 Disable channels to mute events belonging to this category. ProfilingDebugging/TraceAuxiliary.h  

static void DisableChannels ( const TCHAR* Channels
)

 Disable channels to stop recording traces with them. ProfilingDebugging/TraceAuxiliary.h  

static void EnableChannels ( TConstArrayView< uint32 > ChannelIds,
TMap< uint32, FString >* OutErrors
)

 Enable channels to emit events belonging to this category. ProfilingDebugging/TraceAuxiliary.h  

static void EnableChannels ( const TCHAR* Channels
)

 Enable channels to emit events from this category. ProfilingDebugging/TraceAuxiliary.h  

static void EnableCommandlineChannels ()

 Enable previously selected channels. ProfilingDebugging/TraceAuxiliary.h  

static void EnumerateChannelPresetsFromSettings ( PresetCallback Callback
)

 Enumerate the channel presets that are defined in BaseEngine.ini, under the [Trace.ChannelPresets] section. ProfilingDebugging/TraceAuxiliary.h  

static void EnumerateFixedChannelPresets ( PresetCallback Callback
)

 Enumerate the channel presets that are defined in code. ProfilingDebugging/TraceAuxiliary.h  

static void GetActiveChannelsString ( FStringBuilderBase& String
)

 Adds a comma separated list of currently active channels to the passed in StringBuilder ProfilingDebugging/TraceAuxiliary.h  

static EConnectionType GetConnectionType()

 Returns the current connection type. ProfilingDebugging/TraceAuxiliary.h  

static UE::Trace::FInitializeDesc const * GetInitializeDesc()

 Get the settings used to initialize TraceLog ProfilingDebugging/TraceAuxiliary.h  
Returns the destination string that is currently being traced to. ProfilingDebugging/TraceAuxiliary.h  

static ETraceSystemStatus GetTraceSystemStatus()

 Returns the current status of the trace system. ProfilingDebugging/TraceAuxiliary.h  

static void Initialize ( const TCHAR* CommandLine
)

 Initialize Trace systems. ProfilingDebugging/TraceAuxiliary.h  

static void InitializePresets ( const TCHAR* CommandLine
)

 Initialize channels that use the config driven presets. ProfilingDebugging/TraceAuxiliary.h  

static bool IsConnected ( FGuid& OutSessionGuid,
FGuid& OutTraceGuid
)

 Returns whether the trace system is currently connected. ProfilingDebugging/TraceAuxiliary.h  

static bool IsConnected ()

 Returns whether the trace system is currently connected to a trace sink (network, file or custom relay). ProfilingDebugging/TraceAuxiliary.h  

static bool IsPaused()

   ProfilingDebugging/TraceAuxiliary.h  

static void Panic ()

 Used when process is panicking. ProfilingDebugging/TraceAuxiliary.h  

static bool Pause()

 Pause all tracing by disabling all active channels. ProfilingDebugging/TraceAuxiliary.h  

static bool Relay ( UPTRINT Handle,
UE::Trace::IoWriteFunc WriteFunc,
UE::Trace::IoCloseFunc CloseFunc,
const TCHAR* Channels,
const FOptions* Options
)

 Start tracing to a custom target by providing a handle and a write and close function. ProfilingDebugging/TraceAuxiliary.h  

static bool Resume()

 Resume tracing by enabling all previously active channels. ProfilingDebugging/TraceAuxiliary.h  

static bool SendSnapshot ( const TCHAR* Host,
uint32 Port
)

 Write tailing memory state to a trace server. ProfilingDebugging/TraceAuxiliary.h  

static void Shutdown()

 Shut down Trace systems. ProfilingDebugging/TraceAuxiliary.h  

static bool Start ( EConnectionType Type,
const TCHAR* Target,
const TCHAR* Channels,
FOptions* Options,
const FLogCategoryAlias& LogCategory
)

 Start tracing to a target (network connection or file) with an active set of channels. ProfilingDebugging/TraceAuxiliary.h  

static bool Stop()

 Stop tracing. ProfilingDebugging/TraceAuxiliary.h  

static void TryAutoConnect()

 Attempts to auto connect to an active trace server if an active session of Unreal Insights Session Browser is running. ProfilingDebugging/TraceAuxiliary.h  

static bool WriteSnapshot ( const TCHAR* FilePath
)

 Write tailing memory state to a utrace file. ProfilingDebugging/TraceAuxiliary.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page