cAudio::ILogger Class Reference

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

#include <ILogger.h>

Inheritance diagram for cAudio::ILogger:

[legend]

List of all members.

Public Member Functions
virtual void	logCritical (const char *sender, const char *msg,...)=0
	Used to log a critical error message to the logging system.
virtual void	logError (const char *sender, const char *msg,...)=0
	Used to log an error message to the logging system.
virtual void	logWarning (const char *sender, const char *msg,...)=0
	Used to log a warning to the logging system.
virtual void	logInfo (const char *sender, const char *msg,...)=0
	Used to log an informational message to the logging system.
virtual void	logDebug (const char *sender, const char *msg,...)=0
	Used to log a debug message to the logging system.
virtual const LogLevel &	getLogLevel () 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.
virtual bool	registerLogReceiver (ILogReceiver *receiver, const char *name)=0
	Register Log Receiver.
virtual void	unRegisterLogReceiver (const char *name)=0
	Unregister a Log Receiver.
virtual bool	isLogReceiverRegistered (const char *name)=0
	Returns whether an log receiver is currently registered.
virtual ILogReceiver *	getLogReceiver (const char *name)=0
	Returns a registered log receiver.

---

Detailed Description

Interface for all logging operations in cAudio.

Definition at line 14 of file ILogger.h.

---

Member Function Documentation

virtual ILogReceiver* cAudio::ILogger::getLogReceiver

(

const char *

name

)

[pure virtual]

Returns a registered log receiver.

Parameters:

name,:

Name 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.

virtual bool cAudio::ILogger::isLogReceiverRegistered

(

const char *

name

)

[pure virtual]

Returns whether an log receiver is currently registered.

Parameters:

name,:

Name of the log receiver to check for.

Implemented in cAudio::cLogger.

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:

	sender,:	Name of the class/component sending the message.
	msg,:	The message to send.

Implemented in cAudio::cLogger.

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

Used to log a debug message to the logging system.

Parameters:

	sender,:	Name of the class/component sending the message.
	msg,:	The message to send.

Implemented in cAudio::cLogger.

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

Used to log an error message to the logging system.

Parameters:

	sender,:	Name of the class/component sending the message.
	msg,:	The message to send.

Implemented in cAudio::cLogger.

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

Used to log an informational message to the logging system.

Parameters:

	sender,:	Name of the class/component sending the message.
	msg,:	The message to send.

Implemented in cAudio::cLogger.

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

Used to log a warning to the logging system.

Parameters:

	sender,:	Name of the class/component sending the message.
	msg,:	The message to send.

Implemented in cAudio::cLogger.

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:

	receiver,:	Pointer to your implementation of ILogReceiver.
	name,:	Name of the log receiver.

Returns:

True on success, False on failure.

Implemented in cAudio::cLogger.

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:

logLevel,:

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

Implemented in cAudio::cLogger.

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:

name,:

Name of the log receiver to remove.

Implemented in cAudio::cLogger.

---

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

• C:/Users/Wildicv/Desktop/cAudio/cAudio/Trunk/include/ILogger.h