Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FOutputDevice Class Referenceabstract

#include <OutputDevice.h>

+ Inheritance diagram for FOutputDevice:

Public Member Functions

 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 SerializeRecord (const UE::FLogRecord &Record)
 
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
 
virtual bool CanBeUsedOnAnyThread () const
 
virtual bool CanBeUsedOnMultipleThreads () const
 
virtual bool CanBeUsedOnPanicThread () 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)
 

Protected Attributes

bool bSuppressEventTag
 
bool bAutoEmitLineTerminator
 

Private Member Functions

void VARARGS LogfImpl (const TCHAR *Fmt,...)
 
void VARARGS LogfImpl (ELogVerbosity::Type Verbosity, const TCHAR *Fmt,...)
 
void VARARGS CategorizedLogfImpl (const FName &Category, ELogVerbosity::Type Verbosity, const TCHAR *Fmt,...)
 

Detailed Description

Definition at line 129 of file OutputDevice.h.

Constructor & Destructor Documentation

◆ FOutputDevice() [1/3]

FOutputDevice::FOutputDevice ( )
inline

Definition at line 132 of file OutputDevice.h.

◆ FOutputDevice() [2/3]

FOutputDevice::FOutputDevice ( FOutputDevice && )
default

◆ FOutputDevice() [3/3]

FOutputDevice::FOutputDevice ( const FOutputDevice & )
default

◆ ~FOutputDevice()

virtual FOutputDevice::~FOutputDevice ( )
virtualdefault

Member Function Documentation

◆ CanBeUsedOnAnyThread()

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

Reimplemented in FOutputDeviceAnsiError, FOutputDeviceDebug, FOutputDeviceFile, and FOutputDeviceMemory.

Definition at line 196 of file OutputDevice.h.

◆ CanBeUsedOnMultipleThreads()

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

Reimplemented in FAutomationTestFramework::FAutomationTestOutputDevice, FAutomationTestFramework::FAutomationTestMessageFilter, and FOutputDeviceDebug.

Definition at line 204 of file OutputDevice.h.

◆ CanBeUsedOnPanicThread()

virtual bool FOutputDevice::CanBeUsedOnPanicThread ( ) const
inlinevirtual
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 in FOutputDeviceDebug, FOutputDeviceError, FOutputDeviceFile, and FOutputDeviceMemory.

Definition at line 213 of file OutputDevice.h.

◆ CategorizedLogf()

template<typename FmtType , typename... Types>
FORCEINLINE void FOutputDevice::CategorizedLogf ( const FName & Category,
ELogVerbosity::Type Verbosity,
const FmtType & Fmt,
Types... Args )
inline

Definition at line 259 of file OutputDevice.h.

◆ CategorizedLogfImpl()

void VARARGS FOutputDevice::CategorizedLogfImpl ( const FName & Category,
ELogVerbosity::Type Verbosity,
const TCHAR * Fmt,
... )
private

◆ Dump()

virtual void FOutputDevice::Dump ( class FArchive & Ar)
inlinevirtual

Dumps the contents of this output device's buffer to an archive (supported by output device that have a memory buffer)

Parameters
ArArchive to dump the buffer to

Reimplemented in FOutputDeviceMemory.

Definition at line 181 of file OutputDevice.h.

◆ Flush()

virtual void FOutputDevice::Flush ( void )
inlinevirtual

◆ GetAutoEmitLineTerminator()

FORCEINLINE bool FOutputDevice::GetAutoEmitLineTerminator ( ) const
inline

Definition at line 175 of file OutputDevice.h.

◆ GetSuppressEventTag()

FORCEINLINE bool FOutputDevice::GetSuppressEventTag ( ) const
inline

Definition at line 170 of file OutputDevice.h.

◆ IsMemoryOnly()

virtual bool FOutputDevice::IsMemoryOnly ( ) const
inlinevirtual
Returns
whether this output device is a memory-only device

Reimplemented in FOutputDeviceMemory.

Definition at line 188 of file OutputDevice.h.

◆ Log() [1/7]

void FOutputDevice::Log ( const FName & Category,
ELogVerbosity::Type Verbosity,
const FString & S )

◆ Log() [2/7]

void FOutputDevice::Log ( const FName & Category,
ELogVerbosity::Type Verbosity,
const TCHAR * Str )

◆ Log() [3/7]

void FOutputDevice::Log ( const FString & S)

◆ Log() [4/7]

void FOutputDevice::Log ( const FText & S)

◆ Log() [5/7]

void FOutputDevice::Log ( const TCHAR * S)

◆ Log() [6/7]

void FOutputDevice::Log ( ELogVerbosity::Type Verbosity,
const FString & S )

◆ Log() [7/7]

void FOutputDevice::Log ( ELogVerbosity::Type Verbosity,
const TCHAR * S )

◆ Logf() [1/3]

template<typename FmtType >
void FOutputDevice::Logf ( const FmtType & Fmt)
inline

Definition at line 234 of file OutputDevice.h.

◆ Logf() [2/3]

template<typename FmtType , typename... Types>
FORCEINLINE void FOutputDevice::Logf ( const FmtType & Fmt,
Types... Args )
inline

Definition at line 241 of file OutputDevice.h.

◆ Logf() [3/3]

template<typename FmtType , typename... Types>
FORCEINLINE void FOutputDevice::Logf ( ELogVerbosity::Type Verbosity,
const FmtType & Fmt,
Types... Args )
inline

Definition at line 250 of file OutputDevice.h.

◆ LogfImpl() [1/2]

void VARARGS FOutputDevice::LogfImpl ( const TCHAR * Fmt,
... )
private

◆ LogfImpl() [2/2]

void VARARGS FOutputDevice::LogfImpl ( ELogVerbosity::Type Verbosity,
const TCHAR * Fmt,
... )
private

◆ operator=() [1/2]

FOutputDevice & FOutputDevice::operator= ( const FOutputDevice & )
default

◆ operator=() [2/2]

FOutputDevice & FOutputDevice::operator= ( FOutputDevice && )
default

◆ Serialize() [1/2]

virtual void FOutputDevice::Serialize ( const TCHAR * V,
ELogVerbosity::Type Verbosity,
const FName & Category )
pure virtual
+ Here is the caller graph for this function:

◆ Serialize() [2/2]

virtual void FOutputDevice::Serialize ( const TCHAR * V,
ELogVerbosity::Type Verbosity,
const FName & Category,
const double Time )
inlinevirtual

Definition at line 146 of file OutputDevice.h.

+ Here is the call graph for this function:

◆ SerializeRecord()

virtual void FOutputDevice::SerializeRecord ( const UE::FLogRecord & Record)
virtual

◆ SetAutoEmitLineTerminator()

void FOutputDevice::SetAutoEmitLineTerminator ( bool bInAutoEmitLineTerminator)
inline

Definition at line 171 of file OutputDevice.h.

◆ SetSuppressEventTag()

void FOutputDevice::SetSuppressEventTag ( bool bInSuppressEventTag)
inline

Definition at line 166 of file OutputDevice.h.

◆ TearDown()

virtual void FOutputDevice::TearDown ( void )
inlinevirtual

Closes output device and cleans up. This can't happen in the destructor as we might have to call "delete" which cannot be done for static/ global objects.

Reimplemented in FOutputDeviceRedirector, FOutputDeviceFile, FOutputDeviceMemory, and FWindowsEventLogOutputDevice.

Definition at line 162 of file OutputDevice.h.

Member Data Documentation

◆ bAutoEmitLineTerminator

bool FOutputDevice::bAutoEmitLineTerminator
protected

Whether to output a line-terminator after each log call...

Definition at line 271 of file OutputDevice.h.

◆ bSuppressEventTag

bool FOutputDevice::bSuppressEventTag
protected

Whether to output the 'Log: ' type front...

Definition at line 269 of file OutputDevice.h.


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