cAudio  2.3.0
3d Audio Engine
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
cAudio::cLogger Class Reference
Inheritance diagram for cAudio::cLogger:
Inheritance graph
[legend]
Collaboration diagram for cAudio::cLogger:
Collaboration graph
[legend]

Public Member Functions

virtual void logCritical (const char *sender, const char *msg,...)
 Used to log a critical error message to the logging system. More...
 
virtual void logError (const char *sender, const char *msg,...)
 Used to log an error message to the logging system. More...
 
virtual void logWarning (const char *sender, const char *msg,...)
 Used to log a warning to the logging system. More...
 
virtual void logInfo (const char *sender, const char *msg,...)
 Used to log an informational message to the logging system. More...
 
virtual void logDebug (const char *sender, const char *msg,...)
 Used to log a debug message to the logging system. More...
 
virtual const LogLevelgetLogLevel () const
 Returns the minimum log level that will be sent to the log receivers.
 
virtual void setLogLevel (const LogLevel &logLevel)
 Sets the minimum log level that the engine will send to log receivers. More...
 
virtual bool registerLogReceiver (ILogReceiver *receiver, const char *name)
 Register Log Receiver. More...
 
virtual void unRegisterLogReceiver (const char *name)
 Unregister a Log Receiver. More...
 
virtual bool isLogReceiverRegistered (const char *name)
 Returns whether an log receiver is currently registered. More...
 
virtual ILogReceivergetLogReceiver (const char *name)
 Returns a registered log receiver. More...
 

Protected Types

typedef cAudioMap< cAudioString, ILogReceiver * >::Type::iterator ReceiversIterator
 

Protected Member Functions

void broadcastMessage (LogLevel level, const char *sender, const char *msg, va_list args)
 

Protected Attributes

cAudioMutex Mutex
 
unsigned long StartTime
 
char TempTextBuf [2048]
 
LogLevel MinLogLevel
 
cAudioMap< cAudioString, ILogReceiver * >::Type Receivers
 

Detailed Description

Definition at line 15 of file cLogger.h.

Member Function Documentation

◆ getLogReceiver()

ILogReceiver * cAudio::cLogger::getLogReceiver ( const char *  name)
virtual

Returns a registered log receiver.

Parameters
nameName of the log receiver to return.
Returns
Pointer to the found log receiver or NULL if it could not be found.

Implements cAudio::ILogger.

Definition at line 127 of file cLogger.cpp.

◆ isLogReceiverRegistered()

bool cAudio::cLogger::isLogReceiverRegistered ( const char *  name)
virtual

Returns whether an log receiver is currently registered.

Parameters
nameName of the log receiver to check for.

Implements cAudio::ILogger.

Definition at line 117 of file cLogger.cpp.

◆ logCritical()

void cAudio::cLogger::logCritical ( const char *  sender,
const char *  msg,
  ... 
)
virtual

Used to log a critical error message to the logging system.

Parameters
senderName of the class/component sending the message.
msgThe message to send.

Implements cAudio::ILogger.

Definition at line 19 of file cLogger.cpp.

◆ logDebug()

void cAudio::cLogger::logDebug ( const char *  sender,
const char *  msg,
  ... 
)
virtual

Used to log a debug message to the logging system.

Parameters
senderName of the class/component sending the message.
msgThe message to send.

Implements cAudio::ILogger.

Definition at line 67 of file cLogger.cpp.

◆ logError()

void cAudio::cLogger::logError ( const char *  sender,
const char *  msg,
  ... 
)
virtual

Used to log an error message to the logging system.

Parameters
senderName of the class/component sending the message.
msgThe message to send.

Implements cAudio::ILogger.

Definition at line 31 of file cLogger.cpp.

◆ logInfo()

void cAudio::cLogger::logInfo ( const char *  sender,
const char *  msg,
  ... 
)
virtual

Used to log an informational message to the logging system.

Parameters
senderName of the class/component sending the message.
msgThe message to send.

Implements cAudio::ILogger.

Definition at line 55 of file cLogger.cpp.

◆ logWarning()

void cAudio::cLogger::logWarning ( const char *  sender,
const char *  msg,
  ... 
)
virtual

Used to log a warning to the logging system.

Parameters
senderName of the class/component sending the message.
msgThe message to send.

Implements cAudio::ILogger.

Definition at line 43 of file cLogger.cpp.

◆ registerLogReceiver()

bool cAudio::cLogger::registerLogReceiver ( ILogReceiver receiver,
const char *  name 
)
virtual

Register Log Receiver.

Note: Any class registered will become owned by the internal thread. If threading is enabled, you MUST make the receiver threadsafe if you plan to access it in your application while it is registered.

Parameters
receiverPointer to your implementation of ILogReceiver.
nameName of the log receiver.
Returns
True on success, False on failure.

Implements cAudio::ILogger.

Definition at line 96 of file cLogger.cpp.

Here is the caller graph for this function:

◆ setLogLevel()

void cAudio::cLogger::setLogLevel ( const LogLevel logLevel)
virtual

Sets the minimum log level that the engine will send to log receivers.

Primarily used to prevent too much verbose information from being sent to disk/console.

Parameters
logLevelLogLevel to set as the new minimum. Anything equal to or greater than this level will be logged.

Implements cAudio::ILogger.

Definition at line 79 of file cLogger.cpp.

◆ unRegisterLogReceiver()

void cAudio::cLogger::unRegisterLogReceiver ( const char *  name)
virtual

Unregister a Log Receiver.

Will NOT delete any user added receiver, you must do that yourself.

Parameters
nameName of the log receiver to remove.

Implements cAudio::ILogger.

Definition at line 105 of file cLogger.cpp.


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