ITraceControllerCommands Class Reference

#include <ITraceControllerCommands.h>

Inheritance diagram for ITraceControllerCommands:

Public Member Functions
virtual	~ITraceControllerCommands ()
virtual void	SetChannels (TConstArrayView< FStringView > ChannelsToEnable, TConstArrayView< FStringView > ChannelsToDisable)=0
virtual void	SetChannels (TConstArrayView< FString > ChannelsToEnable, TConstArrayView< FString > ChannelsToDisable)=0
virtual void	Send (FStringView Host, FStringView Channels, bool bExcludeTail=false)=0
virtual void	File (FStringView File, FStringView Channels, bool bExcludeTail=false, bool bTruncateFile=false)=0
virtual void	SnapshotSend (FStringView Host)=0
virtual void	SnapshotFile (FStringView File)=0
virtual void	Pause ()=0
virtual void	Resume ()=0
virtual void	Stop ()=0
virtual void	Bookmark (FStringView Label)=0
virtual void	Screenshot (FStringView Name, bool bShowUI)=0
virtual void	SetStatNamedEventsEnabled (bool bEnabled)=0

Detailed Description

Interface to send commands to a single remote trace service.

Constructor & Destructor Documentation

~ITraceControllerCommands()

virtual ITraceControllerCommands::~ITraceControllerCommands ( )

inlinevirtual

Member Function Documentation

Bookmark()

virtual void ITraceControllerCommands::Bookmark ( FStringView  Label )

pure virtual

Insert bookmark into the trace.

Parameters

Label

Label of bookmark

File()

virtual void ITraceControllerCommands::File ( FStringView  File, FStringView  Channels, bool  bExcludeTail = false, bool  bTruncateFile = false  )

pure virtual

Start a trace on selected instances to a file on the instance, using a set of channels.

Parameters

File	Path on the instance. ".utrace" will be appended
Channels	Comma separated list of channels to enable
bExcludeTail	If the tail (circular buffer of recent events) should be included
bTruncateFile	If the file should be truncated (if already exists)

Pause()

virtual void ITraceControllerCommands::Pause ( )

pure virtual

Pause tracing by muting all (non-readonly) channels.

Resume()

virtual void ITraceControllerCommands::Resume ( )

pure virtual

Resume tracing (from paused) by enabling the previously enabled channels.

Screenshot()

virtual void ITraceControllerCommands::Screenshot ( FStringView  Name, bool  bShowUI  )

pure virtual

Insert screenshot into the trace.

Parameters

Name	Name of the screenshot
bShowUI	If the UI should be visible in the image

Send()

virtual void ITraceControllerCommands::Send ( FStringView  Host, FStringView  Channels, bool  bExcludeTail = false  )

pure virtual

Start a trace on selected instances to the provided host, using a set of channels.

Parameters

Host	Host to send the trace to
Channels	Comma separated list of channels to enable
bExcludeTail	If the tail (circular buffer of recent events) should be included

SetChannels() [1/2]

virtual void ITraceControllerCommands::SetChannels ( TConstArrayView< FString >  ChannelsToEnable, TConstArrayView< FString >  ChannelsToDisable  )

pure virtual

Enables or disables channels by name

Parameters

ChannelsToEnable	List of channels to enable
ChannelsToDisable	List of channels to disable

SetChannels() [2/2]

virtual void ITraceControllerCommands::SetChannels ( TConstArrayView< FStringView >  ChannelsToEnable, TConstArrayView< FStringView >  ChannelsToDisable  )

pure virtual

Enables or disables channels by name

Parameters

ChannelsToEnable	List of channels to enable
ChannelsToDisable	List of channels to disable

SetStatNamedEventsEnabled()

virtual void ITraceControllerCommands::SetStatNamedEventsEnabled ( bool  bEnabled )

pure virtual

Set the StatNamedEvents flag.

Parameters

bEnabled

The value to assign to the StatNamedEvents flag.

SnapshotFile()

virtual void ITraceControllerCommands::SnapshotFile ( FStringView  File )

pure virtual

On selected instances, make a snapshot of the tail (circular buffer of recent events) and save to a file.

Parameters

File	Path on the instance. ".utrace" will be appended

SnapshotSend()

virtual void ITraceControllerCommands::SnapshotSend ( FStringView  Host )

pure virtual

On selected instances, make a snapshot of the tail (circular buffer of recent events) and send to the provided host.

Parameters

Host	Host to send the trace to

Stop()

virtual void ITraceControllerCommands::Stop ( )

pure virtual

Stop active trace.

---

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

• Engine/Source/Runtime/SessionServices/Public/ITraceControllerCommands.h