1. Epic GamesDeveloper
  3. FTraceAuxiliary

FTraceAuxiliary

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/ProfilingDebugging

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/ProfilingDebugging/TraceAuxiliary.h
Include #include "ProfilingDebugging/TraceAuxiliary.h"

Syntax

class FTraceAuxiliary

Functions

  Type Name Description
Public function  

DECLARE_TS_MULTICAST_DELEGATE ( FOnConnection
)

 Callback type when a new connection is established.
Public function  

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.
Public function  

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

 Callback whenever a trace recording is stopped.
Public function  

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

 Callback whenever a trace is started
Public function Static void

DisableChannels ( const TCHAR* Channels
)

 Disable channels to stop recording traces with them.
Public function Static void

DisableChannels ( TConstArrayView< uint32 > ChannelIds
)

 Disable channels to mute events belonging to this category.
Public function Static void

EnableChannels ( TConstArrayView< uint32 > ChannelIds
)

 Enable channels to emit events belonging to this category.
Public function Static void Enable previously selected channels.
Public function Static void Enumerate the channel presets that are defined in BaseEngine.ini, under the [Trace.ChannelPresets] section.
Public function Static void Enumerate the channel presets that are defined in code.
Public function Static void Adds a comma separated list of currently active channels to the passed in StringBuilder
Public function Static EConnectionType Returns the current connection type.
Public function Static UE::Trace::FInitializeDesc const * Get the settings used to initialize TraceLog
Public function Static const TCHAR * Returns the destination string that is currently being traced to.
Public function Static FString Returns the destination string that is currently being traced to.
Public function Static ETraceSystemStatus Returns the current status of the trace system.
Public function Static void

Initialize ( const TCHAR* CommandLine
)

 Initialize Trace systems.
Public function Static void

InitializePresets ( const TCHAR* CommandLine
)

 Initialize channels that use the config driven presets.
Public function Static bool

IsConnected ( FGuid& OutSessionGuid,
FGuid& OutTraceGuid
)

 Returns whether the trace system is currently connected.
Public function Static bool Returns whether the trace system is currently connected to a trace sink (file or network)
Public function Static bool  
Public function Static void

Panic ()

 Used when process is panicking.
Public function Static bool

Pause ()

 Pause all tracing by disabling all active channels.
Public function Static bool

Resume ()

 Resume tracing by enabling all previously active channels.
Public function Static bool

SendSnapshot ( const TCHAR* Host,
uint32 Port
)

 Write tailing memory state to a trace server.
Public function Static void Shut down Trace systems.
Public function 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.
Public function Static bool

Stop ()

 Stop tracing.
Public function Static void Attempts to auto connect to an active trace server if an active session of Unreal Insights Session Browser is running.
Public function Static bool

WriteSnapshot ( const TCHAR* FilePath
)

 Write tailing memory state to a utrace file.

Classes

  Type Name Description
Public struct FChannelPreset    
Public struct FOptions    

Enums

  Type Name Description
Public enum EConnectionType    
Public enum EEnumerateResult    
Public enum ETraceSystemStatus This enum is serialized and sent via the trace service.  

Typedefs

Name Description
FLogCategoryAlias In no logging configurations all log categories are of type FNoLoggingCategory, which has no relation with FLogCategoryBase.
PresetCallback  

Constants

Name Description
OnConnection Delegate that triggers when a connection is established.
OnSnapshotSaved Delegate that triggers when a snapshot has been saved.
OnTraceStarted Delegate that triggers when a trace session is started.
OnTraceStopped Delegate that triggers when a trace has finished recording.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page