1. Epic GamesDeveloper
  3. TraceLog

TraceLog

API > API/Runtime

   
Name TraceLog
Type Runtime
Location /Engine/Source/Runtime/TraceLog/
Module Build Rules TraceLog.Build.cs

Classes

Name Remarks
FChannel  
FImportantLogScope  

Structs

Name Remarks
EKnownEventUids  
EKnownEventUids  
EKnownEventUids  
FAuxHeader  
FAuxHeader  
FChannelInfo  
FEventHeader  
FEventHeader  
FEventHeader  
FEventHeader  
FEventHeaderSync  
FEventHeaderSync  
FEventInfo  
FImportantEventHeader  
FInitializeDesc  
FMessageEvent  
FNewEventEvent  
FNewEventEvent  
FSendFlags  
FStatistics  
FTidPacketBase  
TEventRef Reference to a definition event.
TTidPacket  
TTidPacketEncoded  

Typedefs

Name Type Remarks Include Path
AllocFunc void * Allocate memory callback Trace/Trace.h
ChannelIterCallback bool The callback provides information about a channel and a user provided pointer. Trace/Trace.h
ChannelIterFunc void The callback provides information about a channel and a user provided pointer. Trace/Trace.h
FChannelId uint32   Trace/Trace.h
FEventRef16 TEventRef< uint16 >   Trace/Trace.h
FEventRef32 TEventRef< uint32 >   Trace/Trace.h
FEventRef64 TEventRef< uint64 >   Trace/Trace.h
FEventRef8 TEventRef< uint8 >   Trace/Trace.h
FreeFunc void Free memory callback Trace/Trace.h
FTidPacket TTidPacket< 0 >   Trace/Detail/Transport.h
FTidPacketEncoded TTidPacketEncoded< 0 >   Trace/Detail/Transport.h
IoCloseFunc void User defined close callback. Trace/Trace.h
IoWriteFunc bool User defined write callback. Trace/Trace.h
OnConnectFunc void(void)   Trace/Trace.h
OnMessageFunc void(const FMessageEvent &)   Trace/Trace.h
OnScopeBeginFunc void(const ANSICHAR *)   Trace/Trace.h
OnScopeEndFunc void(void)   Trace/Trace.h
OnUpdateFunc void(void)   Trace/Trace.h

Enums

Public

Name Remarks
UE::Trace::AnsiString Field types.
UE::Trace::EMessageType Since we use this type in macros we need provide an empty definition when trace is not enabled.
UE::Trace::ETransport Since we use this type in macros we need provide an empty definition when trace is not enabled.
UE::Trace::ETransportTid Since we use this type in macros we need provide an empty definition when trace is not enabled.
UE::Trace::Protocol0::  
UE::Trace::Protocol0::EFieldType  
UE::Trace::Protocol0::EKnownEventUids  
UE::Trace::Protocol0::EProtocol  
UE::Trace::Protocol1::EEventFlags  
UE::Trace::Protocol1::EKnownEventUids  
UE::Trace::Protocol1::EProtocol  
UE::Trace::Protocol2::EProtocol  
UE::Trace::Protocol3::EProtocol  
UE::Trace::Protocol4::EProtocol  
UE::Trace::Protocol5::EProtocol  
UE::Trace::Protocol6::EEventFlags  
UE::Trace::Protocol6::EFieldFamily  
UE::Trace::Protocol6::EProtocol  
UE::Trace::Protocol7::EProtocol  
UE::Trace::WideString Since we use this type in macros we need provide an empty definition when trace is not enabled.

Functions

Public

Name Remarks Include Path Unreal Specifiers

UE_void UE::Trace::EnumerateChannels ( ChannelIterFunc IterFunc,
void* User
)

 Enumerates registered channels. Trace/Trace.h  

UE_void UE::Trace::EnumerateChannels ( ChannelIterCallback IterFunc,
void* User
)

 Enumerates registered channels. Trace/Trace.h  

UE_void UE::Trace::Exit ()

 Call when application is exiting. Trace/Trace.h  

UE_FChannel * UE::Trace::FindChannel ( const TCHAR* ChannelName
)

 Attempts to find the corresponding channel object given a channel name. Trace/Trace.h  

UE_FChannel * UE::Trace::FindChannel ( FChannelId ChannelId
)

 Attempts to find the corresponding channel object given a channel id. Trace/Trace.h  

UE_void UE::Trace::GetStatistics ( FStatistics& Out
)

 Fetches tracked telemetry from the library. Trace/Trace.h  

UE_void UE::Trace::Initialize ( const FInitializeDesc& Desc
)

 Initalize TraceLog library. Trace/Trace.h  

UE_bool UE::Trace::IsChannel ( const TCHAR* ChannelName
)

 Checks if a string is valid channel name. Trace/Trace.h  
Checks if TraceLog currently has an output. Trace/Trace.h  

UE_bool UE::Trace::IsTracingTo ( uint32(&) OutSessionGuid,
uint32(&) OutTraceGuid
)

 Checks if TraceLog currently has an output and return session and trace GUIDs of active trace stream. Trace/Trace.h  

TEventRef< IdType > UE::Trace::MakeEventRef ( IdType InId,
uint32 InTypeId
)

   Trace/Trace.h  

UE_void UE::Trace::Panic()

 Notifies TraceLog about a critical failure. Disables all tracing by muting all channels. Trace/Trace.h  

Type UE::Trace::Private::AtomicAddAcquire ( Type volatile* Target,
Type Value
)

   Trace/Detail/Atomic.h  

Type UE::Trace::Private::AtomicAddRelaxed ( Type volatile* Target,
Type Value
)

   Trace/Detail/Atomic.h  

Type UE::Trace::Private::AtomicAddRelease ( Type volatile* Target,
Type Value
)

   Trace/Detail/Atomic.h  

bool UE::Trace::Private::AtomicCompareExchangeAcquire ( Type volatile* Target,
Type New,
Type Expected
)

   Trace/Detail/Atomic.h  

bool UE::Trace::Private::AtomicCompareExchangeRelaxed ( Type volatile* Target,
Type New,
Type Expected
)

   Trace/Detail/Atomic.h  

bool UE::Trace::Private::AtomicCompareExchangeRelease ( Type volatile* Target,
Type New,
Type Expected
)

   Trace/Detail/Atomic.h  

Type UE::Trace::Private::AtomicExchangeAcquire ( Type volatile* Target,
Type Value
)

   Trace/Detail/Atomic.h  

Type UE::Trace::Private::AtomicExchangeRelease ( Type volatile* Target,
Type Value
)

   Trace/Detail/Atomic.h  

Type UE::Trace::Private::AtomicLoadAcquire ( Type volatile* Source
)

   Trace/Detail/Atomic.h  

Type UE::Trace::Private::AtomicLoadRelaxed ( Type volatile* Source
)

   Trace/Detail/Atomic.h  

void UE::Trace::Private::AtomicStoreRelaxed ( Type volatile* Target,
Type Value
)

   Trace/Detail/Atomic.h  

void UE::Trace::Private::AtomicStoreRelease ( Type volatile* Target,
Type Value
)

   Trace/Detail/Atomic.h  

Type UE::Trace::Private::AtomicSubAcquire ( Type volatile* Target,
Type Value
)

   Trace/Detail/Atomic.h  

Type UE::Trace::Private::AtomicSubRelaxed ( Type volatile* Target,
Type Value
)

   Trace/Detail/Atomic.h  

Type UE::Trace::Private::AtomicSubRelease ( Type volatile* Target,
Type Value
)

   Trace/Detail/Atomic.h  

void UE::Trace::Private::PlatformYield()

   Trace/Detail/Atomic.h  

UE_bool UE::Trace::RelayTo ( UPTRINT InHandle,
IoWriteFunc WriteFunc,
IoCloseFunc CloseFunc,
uint16 Flags
)

 Setup TraceLog to output to user defined callback, to take effect next update. Trace/Trace.h  

UE_bool UE::Trace::SendSnapshotTo ( const TCHAR* Host,
uint32 Port
)

 Immediately write contents of tail buffers and important events to a remote host. Trace/Trace.h  

UE_bool UE::Trace::SendTo ( const TCHAR* Host,
uint32 Port,
uint16 Flags
)

 Setup TraceLog to output to remote host using a socket connection, to take effect next update. Trace/Trace.h  

UE_void UE::Trace::SetMemoryHooks ( AllocFunc Alloc,
FreeFunc Free
)

 Set optional allocation and free methods to use. Trace/Trace.h  

UE_void UE::Trace::SetMessageCallback ( OnMessageFunc* MessageFunc
)

 Set optional callback to use for critical messages. See OnMessageFunc for details. Trace/Trace.h  

UE_void UE::Trace::SetUpdateCallback ( OnUpdateFunc* UpdateFunc
)

 Set optional on update callbacks. If set issued after every update and once after initalization. Trace/Trace.h  

UE_void UE::Trace::Shutdown()

 Shuts down the library completely and frees resources. After this tracing will not be possible. Trace/Trace.h  

UE_void UE::Trace::StartWorkerThread()

 Manually start worker thread if library is initalized without worker thread. Trace/Trace.h  

UE_bool UE::Trace::Stop()

 Stops current output if any is active.This will fail there is no active output or if there is already a queued output to be started. Trace/Trace.h  

UE_void UE::Trace::ThreadGroupBegin ( const TCHAR* Name
)

 Define a group of threads with similar use. Trace/Trace.h  

UE_void UE::Trace::ThreadGroupEnd()

 End a group of threads with similar use. See /ref ThreadGroupBegin. Trace/Trace.h  

UE_void UE::Trace::ThreadRegister ( const TCHAR* Name,
uint32 SystemId,
int32 SortHint
)

 Register a new thread in Trace. This is a requirement before tracing anything from the thrad. Trace/Trace.h  

UE_bool UE::Trace::ToggleChannel ( const TCHAR* ChannelName,
bool bEnabled
)

 Toggles channel to control output of events. Trace/Trace.h  

UE_void UE::Trace::Update ()

 Manually update TraceLog if no worker thread is running. Trace/Trace.h  

UE_bool UE::Trace::WriteSnapshotTo ( const TCHAR* Path
)

 Immediately write contents of tail buffers and important events to a new or existing file. Trace/Trace.h  

UE_bool UE::Trace::WriteTo ( const TCHAR* Path,
uint16 Flags
)

 Setup TraceLog to output to a new or existing file, to take effect next update. Trace/Trace.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page