cAudio  2.3.0
3d Audio Engine
Public Member Functions | List of all members
cAudio::ILogger Class Referenceabstract

Interface for all logging operations in cAudio. More...

#include <ILogger.h>

Inheritance diagram for cAudio::ILogger:
Inheritance graph
[legend]

Public Member Functions

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

Detailed Description

Interface for all logging operations in cAudio.

Definition at line 13 of file ILogger.h.

Member Function Documentation

◆ getLogReceiver()

virtual ILogReceiver* cAudio::ILogger::getLogReceiver ( const char *  name)
pure 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.

Implemented in cAudio::cLogger.

◆ isLogReceiverRegistered()

virtual bool cAudio::ILogger::isLogReceiverRegistered ( const char *  name)
pure virtual

Returns whether an log receiver is currently registered.

Parameters
nameName of the log receiver to check for.

Implemented in cAudio::cLogger.

◆ logCritical()

virtual void cAudio::ILogger::logCritical ( const char *  sender,
const char *  msg,
  ... 
)
pure 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.

Implemented in cAudio::cLogger.

Here is the caller graph for this function:

◆ logDebug()

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

Used to log a debug message to the logging system.

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

Implemented in cAudio::cLogger.

Here is the caller graph for this function:

◆ logError()

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

Used to log an error message to the logging system.

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

Implemented in cAudio::cLogger.

Here is the caller graph for this function:

◆ logInfo()

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

Used to log an informational message to the logging system.

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

Implemented in cAudio::cLogger.

Here is the caller graph for this function:

◆ logWarning()

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

Used to log a warning to the logging system.

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

Implemented in cAudio::cLogger.

Here is the caller graph for this function:

◆ registerLogReceiver()

virtual bool cAudio::ILogger::registerLogReceiver ( ILogReceiver receiver,
const char *  name 
)
pure 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.

Implemented in cAudio::cLogger.

◆ setLogLevel()

virtual void cAudio::ILogger::setLogLevel ( const LogLevel logLevel)
pure 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.

Implemented in cAudio::cLogger.

◆ unRegisterLogReceiver()

virtual void cAudio::ILogger::unRegisterLogReceiver ( const char *  name)
pure 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.

Implemented in cAudio::cLogger.


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