Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FOutputDeviceDebug Class Reference

#include <OutputDeviceDebug.h>

+ Inheritance diagram for FOutputDeviceDebug:
+ Collaboration diagram for FOutputDeviceDebug:

Public Member Functions

virtual void Serialize (const TCHAR *Data, ELogVerbosity::Type Verbosity, const FName &Category, double Time) override
 
virtual void Serialize (const TCHAR *Data, ELogVerbosity::Type Verbosity, const FName &Category) override
 
virtual void SerializeRecord (const UE::FLogRecord &Record) override
 
virtual bool CanBeUsedOnAnyThread () const override
 
virtual bool CanBeUsedOnMultipleThreads () const override
 
virtual bool CanBeUsedOnPanicThread () const override
 
- Public Member Functions inherited from FOutputDevice
 FOutputDevice ()
 
 FOutputDevice (FOutputDevice &&)=default
 
 FOutputDevice (const FOutputDevice &)=default
 
FOutputDeviceoperator= (FOutputDevice &&)=default
 
FOutputDeviceoperator= (const FOutputDevice &)=default
 
virtual ~FOutputDevice ()=default
 
virtual void Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category)=0
 
virtual void Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category, const double Time)
 
virtual void Flush ()
 
virtual void TearDown ()
 
void SetSuppressEventTag (bool bInSuppressEventTag)
 
FORCEINLINE bool GetSuppressEventTag () const
 
void SetAutoEmitLineTerminator (bool bInAutoEmitLineTerminator)
 
FORCEINLINE bool GetAutoEmitLineTerminator () const
 
virtual void Dump (class FArchive &Ar)
 
virtual bool IsMemoryOnly () const
 
void Log (const TCHAR *S)
 
void Log (ELogVerbosity::Type Verbosity, const TCHAR *S)
 
void Log (const FName &Category, ELogVerbosity::Type Verbosity, const TCHAR *Str)
 
void Log (const FString &S)
 
void Log (const FText &S)
 
void Log (ELogVerbosity::Type Verbosity, const FString &S)
 
void Log (const FName &Category, ELogVerbosity::Type Verbosity, const FString &S)
 
template<typename FmtType >
void Logf (const FmtType &Fmt)
 
template<typename FmtType , typename... Types>
FORCEINLINE void Logf (const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
FORCEINLINE void Logf (ELogVerbosity::Type Verbosity, const FmtType &Fmt, Types... Args)
 
template<typename FmtType , typename... Types>
FORCEINLINE void CategorizedLogf (const FName &Category, ELogVerbosity::Type Verbosity, const FmtType &Fmt, Types... Args)
 

Private Member Functions

void ConditionalTickAsync (double Time)
 
void TickAsync ()
 

Private Attributes

std::atomic< doubleLastTickTime = 0.0
 
std::atomic< boolbSerializeAsJson = false
 

Additional Inherited Members

- Protected Attributes inherited from FOutputDevice
bool bSuppressEventTag
 
bool bAutoEmitLineTerminator
 

Detailed Description

Definition at line 12 of file OutputDeviceDebug.h.

Member Function Documentation

◆ CanBeUsedOnAnyThread()

virtual bool FOutputDeviceDebug::CanBeUsedOnAnyThread ( ) const
inlineoverridevirtual
Returns
whether this output device can be used on any thread.

Reimplemented from FOutputDevice.

Definition at line 27 of file OutputDeviceDebug.h.

◆ CanBeUsedOnMultipleThreads()

virtual bool FOutputDeviceDebug::CanBeUsedOnMultipleThreads ( ) const
overridevirtual
Returns
whether this output device can be used from multiple threads simultaneously without any locking

Reimplemented from FOutputDevice.

◆ CanBeUsedOnPanicThread()

virtual bool FOutputDeviceDebug::CanBeUsedOnPanicThread ( ) const
inlineoverridevirtual
Returns
whether this output device can be used after a panic (crash or fatal error) has been flagged.
Note
The return value is cached by AddOutputDevice because calling this during a panic may fail.

Reimplemented from FOutputDevice.

Definition at line 34 of file OutputDeviceDebug.h.

◆ ConditionalTickAsync()

void FOutputDeviceDebug::ConditionalTickAsync ( double Time)
private

◆ Serialize() [1/2]

virtual void FOutputDeviceDebug::Serialize ( const TCHAR * Data,
ELogVerbosity::Type Verbosity,
const FName & Category )
overridevirtual

◆ Serialize() [2/2]

virtual void FOutputDeviceDebug::Serialize ( const TCHAR * Data,
ELogVerbosity::Type Verbosity,
const FName & Category,
double Time )
overridevirtual

Serializes the passed in data unless the current event is suppressed.

Parameters
DataText to log
EventEvent name used for suppression purposes

◆ SerializeRecord()

virtual void FOutputDeviceDebug::SerializeRecord ( const UE::FLogRecord & Record)
overridevirtual

Reimplemented from FOutputDevice.

◆ TickAsync()

void FOutputDeviceDebug::TickAsync ( )
private

Member Data Documentation

◆ bSerializeAsJson

std::atomic<bool> FOutputDeviceDebug::bSerializeAsJson = false
private

Definition at line 44 of file OutputDeviceDebug.h.

◆ LastTickTime

std::atomic<double> FOutputDeviceDebug::LastTickTime = 0.0
private

Definition at line 43 of file OutputDeviceDebug.h.


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