FTraceWriter

API > API/Developer > API/Developer/TraceAnalysis

   
Name FTraceWriter
Type class
Header File /Engine/Source/Developer/TraceAnalysis/Public/Trace/TraceWriter.h
Include Path #include "Trace/TraceWriter.h"

Syntax

class FTraceWriter

Constructors

Name Remarks Include Path Unreal Specifiers
  Trace/TraceWriter.h  
  Trace/TraceWriter.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FTraceWriter()

   Trace/TraceWriter.h  

Structs

Name Remarks
FTraceGuid  

Constants

Name Type Remarks Include Path
EncodingOverhead uint32   Trace/TraceWriter.h
FlushPacketThreshold uint32   Trace/TraceWriter.h
MaxDecodedBufferSize uint32   Trace/TraceWriter.h
MaxEncodedBufferSize uint32   Trace/TraceWriter.h
MaxPacketBufferSize uint32   Trace/TraceWriter.h
MaxPacketHeaderSize uint32   Trace/TraceWriter.h
MinEncodedBufferSize uint32   Trace/TraceWriter.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bUseCustomClock bool   Trace/TraceWriter.h  
CompletedEventsDataSize uint32   Trace/TraceWriter.h  
CurrentThreadId uint32   Trace/TraceWriter.h  
CycleFrequency uint64   Trace/TraceWriter.h  
Errors TArray< FString >   Trace/TraceWriter.h  
EventBuffer uint8 *   Trace/TraceWriter.h  
EventBufferDataSize uint32   Trace/TraceWriter.h  
EventBufferSize uint32   Trace/TraceWriter.h  
EventInfos TArray< FTraceWriterEventInfo * >   Trace/TraceWriter.h  
LastError FString   Trace/TraceWriter.h  
NewTraceEventId uint32   Trace/TraceWriter.h  
NextSerial uint32   Trace/TraceWriter.h  
PacketBuffer uint8 *   Trace/TraceWriter.h  
PendingEvent FTraceWriterEventBuilder *   Trace/TraceWriter.h  
PendingEventDeclaration FTraceWriterEventDeclarationBuilder *   Trace/TraceWriter.h  
SessionGuid FTraceGuid   Trace/TraceWriter.h  
StartCycle uint64   Trace/TraceWriter.h  
StartTimeSinceEpoch double   Trace/TraceWriter.h  
Stream IOutDataStream &   Trace/TraceWriter.h  
ThreadGroupBeginEventId uint32   Trace/TraceWriter.h  
ThreadGroupEndEventId uint32   Trace/TraceWriter.h  
ThreadInfoEventId uint32   Trace/TraceWriter.h  
Threads TArray< FTraceWriterThreadInfo >   Trace/TraceWriter.h  
ThreadTimingEventId uint32   Trace/TraceWriter.h  
TimeGetter TFunction< uint64()>   Trace/TraceWriter.h  
TraceGuid FTraceGuid   Trace/TraceWriter.h  
UnknownEventId uint32   Trace/TraceWriter.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Begin ( ETraceWriterBeginOptions Options
)

 Begins the trace stream. Trace/TraceWriter.h  

void ClearErrors()

 Clears the stack of error messages, if any. Trace/TraceWriter.h  

void DeclareDefaultEvents()

 Declares the default trace events.Declares: $Trace.* events Trace/TraceWriter.h  
Declares the Diagnostics.Session2 event. Trace/TraceWriter.h  

FTraceWriterEventDeclarationBuilder & DeclareEvent ( FAnsiStringView LoggerName,
FAnsiStringView Name,
ETraceWriterEventFlags Flags
)

 Declares a new trace event. Trace/TraceWriter.h  

void End()

 Ends the trace stream.Calls Close() for the stream. Trace/TraceWriter.h  

const FTraceWriterEventInfo * FindEvent ( FAnsiStringView LoggerName,
FAnsiStringView EventName
) const

 Gets the info for an event identified by logger and event names. Trace/TraceWriter.h  

uint32 GetCurrentThread()

 Gets the current thread id. Trace/TraceWriter.h  

const FTraceWriterEventInfo * GetEventInfo ( uint32 EventId
) const

 Gets the info for an event identified by Id. Trace/TraceWriter.h  

const FString & GetLastError ()

 Returns the last error message from the stack. Trace/TraceWriter.h  

uint64 GetStartTime()

 Gets the start session time, in [ticks]. Trace/TraceWriter.h  

double GetStartTimeSinceEpoch()

 Gets the start session time since the Unix Epoch (January 1st of 1970), in [seconds]. Trace/TraceWriter.h  

const FTraceWriterThreadInfo * GetThreadInfo ( uint32 ThreadId
)

 Gets the info for a registered thread identified by Id. Trace/TraceWriter.h  

uint64 GetTime()

 Gets the current session time, in [ticks]. Trace/TraceWriter.h  

uint64 GetTimeFrequency()

 Returns the frequency of the session time, specified as number of [ticks] per second. Trace/TraceWriter.h  

double GetTimeSinceEpoch()

 Gets the current session time since the Unix Epoch (January 1st of 1970), in [seconds]. Trace/TraceWriter.h  
Returns the version of the trace protocol used by this trace writer. Trace/TraceWriter.h  

UE::Trace::ETransport GetTransportProtocolVersion()

 Returns the version of the transport protocol used by this trace writer. Trace/TraceWriter.h  

bool IsSafeModeEnabled()

 Returns wherever safe mode is enabled or not. Trace/TraceWriter.h  

void RegisterCustomThread ( uint32 ThreadId,
FAnsiStringView ThreadName,
uint32 SystemId,
int32 SortHint,
bool bShouldWriteThreadInfo
)

 Registers a trace thread with a known id. Trace/TraceWriter.h  

uint32 RegisterThread ( FAnsiStringView ThreadName,
uint32 SystemId,
int32 SortHint,
bool bShouldWriteThreadInfo
)

 Registers a new trace thread. Trace/TraceWriter.h  

void SetCurrentThread ( uint32 ThreadId
)

 Sets the current thread id. Trace/TraceWriter.h  

void SetCurrentThreadEvents()

 Sets the current thread to be the "Events" thread. Trace/TraceWriter.h  

void SetCurrentThreadImportants()

 Sets the current thread to be the "Importants" thread. Trace/TraceWriter.h  

void SetCustomClock ( uint64 InTimeFrequency,
TFunction< uint64()> InTimeGetter,
uint64 InStartTime,
double InStartTimeSinceEpoch
)

 Sets the custom clock for the session time. Trace/TraceWriter.h  

void WriteEnterScopeEvent()

 Writes the EnterScope event, on the current thread. Trace/TraceWriter.h  

FTraceWriterEventBuilder & WriteEvent ( uint32 EventId
)

 Writes the specified event, on the current thread. Trace/TraceWriter.h  

void WriteLeaveScopeEvent()

 Writes the LeaveScope event, on the current thread. Trace/TraceWriter.h  
Writes the $Trace.NewTrace event. Trace/TraceWriter.h  

void WriteStampedEnterScopeEvent ( uint64 Timestamp
)

 Writes the EnterScope_TB event, on the current thread, using the specified timestamp. Trace/TraceWriter.h  

void WriteStampedLeaveScopeEvent ( uint64 Timestamp
)

 Writes the LeaveScope_TB event, on the current thread, using the specified timestamp. Trace/TraceWriter.h  

void WriteThreadGroupBeginEvent ( FAnsiStringView GroupName
)

 Writes a $Trace.ThreadGroupBegin event. Trace/TraceWriter.h  
Writes a $Trace.ThreadGroupEnd event. Trace/TraceWriter.h  

void WriteThreadInfo ( uint32 ThreadId
)

 Writes the $Trace.ThreadInfo event for a registered thread, identified by id. Trace/TraceWriter.h  

void WriteThreadInfo ( uint32 ThreadId,
FAnsiStringView ThreadName,
uint32 SystemId,
int32 SortHint
)

 Writes the $Trace.ThreadInfo event. Trace/TraceWriter.h  

void WriteThreadTimingEvent ( uint64 BaseTimestamp
)

 Writes a $Trace.ThreadTiming event for the current thread. Trace/TraceWriter.h  

Static

Name Remarks Include Path Unreal Specifiers

static ETraceWriterEventFlags ConvertEventFlags ( UE::Trace::IAnalyzer::EEventFlags Flags
)

   Trace/TraceWriter.h  

static ETraceWriterFieldType ConvertFieldType ( const UE::Trace::IAnalyzer::FEventFieldInfo& FieldInfo
)

   Trace/TraceWriter.h  

static void GenerateGuid ( FTraceGuid* OutGuid
)

   Trace/TraceWriter.h  

static uint16 GetByteSizeForFieldType ( ETraceWriterFieldType Type
)

   Trace/TraceWriter.h  

static uint8 GetProtocolEventFlags ( ETraceWriterEventFlags Flags
)

   Trace/TraceWriter.h  

static uint8 GetProtocolFieldFamily ( ETraceWriterFieldType Type
)

   Trace/TraceWriter.h  

static uint8 GetProtocolFieldType ( ETraceWriterFieldType Type
)

   Trace/TraceWriter.h  

static bool IsArrayFieldType ( ETraceWriterFieldType Type
)

   Trace/TraceWriter.h  

static bool IsDefinitionIdFieldType ( ETraceWriterFieldType Type
)

   Trace/TraceWriter.h  

static bool IsReferenceFieldType ( ETraceWriterFieldType Type
)

   Trace/TraceWriter.h  

static bool IsSignedFieldType ( ETraceWriterFieldType Type
)

   Trace/TraceWriter.h  

Operators

Name Remarks Include Path Unreal Specifiers

FTraceWriter & operator= ( const FTraceWriter&
)

   Trace/TraceWriter.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page