ncine::ILogger Class Reference

The interface class for loggers. More...

#include <ILogger.h>

Inheritance diagram for ncine::ILogger:

Public Types
enum class	LogLevel {   UNKNOWN = -1 , OFF = 0 , VERBOSE , DEBUG ,   INFO , WARN , ERROR , FATAL }
	Log levels, from less to more severe.

Public Member Functions
virtual unsigned int	write (LogLevel level, const char *fmt,...)=0
	Logs a message with a specified level of severity.
virtual unsigned int	consumeQueue ()=0
	Consumes the queue of entries from all threads (called by the main thread only)
virtual const char *	logString () const =0
	Returns the log string with all the recorded log entries.
virtual void	clearLogString ()=0
	Clears the entries from the log string.
virtual unsigned int	logStringLength () const =0
	Returns the length of the log string.
virtual unsigned int	logStringCapacity () const =0
	Returns the capacity of the log string.

Detailed Description

The interface class for loggers.

Member Function Documentation

clearLogString()

virtual void ncine::ILogger::clearLogString ( )

pure virtual

Clears the entries from the log string.

Implemented in ncine::NullLogger.

consumeQueue()

virtual unsigned int ncine::ILogger::consumeQueue ( )

pure virtual

Consumes the queue of entries from all threads (called by the main thread only)

Returns

The number of queued entries

Implemented in ncine::NullLogger.

logString()

virtual const char * ncine::ILogger::logString ( ) const

pure virtual

Returns the log string with all the recorded log entries.

Implemented in ncine::NullLogger.

logStringCapacity()

virtual unsigned int ncine::ILogger::logStringCapacity ( ) const

pure virtual

Returns the capacity of the log string.

Implemented in ncine::NullLogger.

logStringLength()

virtual unsigned int ncine::ILogger::logStringLength ( ) const

pure virtual

Returns the length of the log string.

Implemented in ncine::NullLogger.

write()

virtual unsigned int ncine::ILogger::write ( LogLevel  level, const char *  fmt,   ...  )

pure virtual

Logs a message with a specified level of severity.

Implemented in ncine::NullLogger.

---

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

• include/ncine/ILogger.h