HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
UT_UniversalLogFileLikeSink Class Referenceabstract

#include <UT_UniversalLogFileLikeSink.h>

+ Inheritance diagram for UT_UniversalLogFileLikeSink:

Public Types

using LogEntryFormatCallback = UT_Function< void(const UT_UniversalLogEntry &, UT_StringHolder &message)>
 
- Public Types inherited from UT_UniversalLogSink
using LogEntryFilterCallback = UT_Function< bool(const UT_UniversalLogEntry &)>
 

Public Member Functions

 UT_UniversalLogFileLikeSink (const UT_UniversalLogFileLikeSink &)=delete
 
 UT_UniversalLogFileLikeSink ()
 
void setFormatEntryCallback (const LogEntryFormatCallback &callback)
 
void setMinSeverity (UT_ErrorSeverity severity)
 
int minSeverity () const
 
- Public Member Functions inherited from UT_UniversalLogSink
 UT_UniversalLogSink ()
 
virtual ~UT_UniversalLogSink ()
 
void connect (const UT_StringHolder &source_name)
 
void disconnect (const UT_StringHolder &source_name)
 
void disconnectAll ()
 
void getConnectedSourceNames (UT_StringArray &source_names)
 
void setFilterEntryCallback (const LogEntryFilterCallback &callback)
 
void log (const UT_UniversalLogEntry &entry)
 Record a message from a log source. More...
 

Static Public Member Functions

static UT_StringHolder severityToString (UT_ErrorSeverity sev)
 

Protected Member Functions

void doLog (const UT_UniversalLogEntry &entry) override
 
virtual void formatLogEntry (const UT_UniversalLogEntry &entry, UT_StringHolder &msg) const =0
 
virtual void writeString (UT_ErrorSeverity severity, const UT_StringHolder &msg) const =0
 

Detailed Description

Definition at line 24 of file UT_UniversalLogFileLikeSink.h.

Member Typedef Documentation

using UT_UniversalLogFileLikeSink::LogEntryFormatCallback = UT_Function<void( const UT_UniversalLogEntry&, UT_StringHolder& message)>

Definition at line 29 of file UT_UniversalLogFileLikeSink.h.

Constructor & Destructor Documentation

UT_UniversalLogFileLikeSink::UT_UniversalLogFileLikeSink ( const UT_UniversalLogFileLikeSink &  )
delete
UT_UniversalLogFileLikeSink::UT_UniversalLogFileLikeSink ( )
inline

Definition at line 32 of file UT_UniversalLogFileLikeSink.h.

Member Function Documentation

void UT_UniversalLogFileLikeSink::doLog ( const UT_UniversalLogEntry &  entry)
overrideprotectedvirtual

Implements UT_UniversalLogSink.

virtual void UT_UniversalLogFileLikeSink::formatLogEntry ( const UT_UniversalLogEntry &  entry,
UT_StringHolder &  msg 
) const
protectedpure virtual

Implemented in UT_UniversalLogConsoleSink, and UT_UniversalLogFileSink.

int UT_UniversalLogFileLikeSink::minSeverity ( ) const
inline

Definition at line 42 of file UT_UniversalLogFileLikeSink.h.

void UT_UniversalLogFileLikeSink::setFormatEntryCallback ( const LogEntryFormatCallback &  callback)
inline

Definition at line 37 of file UT_UniversalLogFileLikeSink.h.

void UT_UniversalLogFileLikeSink::setMinSeverity ( UT_ErrorSeverity  severity)
inline

Definition at line 40 of file UT_UniversalLogFileLikeSink.h.

static UT_StringHolder UT_UniversalLogFileLikeSink::severityToString ( UT_ErrorSeverity  sev)
static
virtual void UT_UniversalLogFileLikeSink::writeString ( UT_ErrorSeverity  severity,
const UT_StringHolder &  msg 
) const
protectedpure virtual

Implemented in UT_UniversalLogConsoleSink, UT_UniversalLogFileSink, and UT_UniversalLogSystemSink.

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