Manage application event logging. More...

#include <LogMgr.h>

Inheritance diagram for utl::LogMgr:

Public Member Functions
virtual void	clear ()
	See Object::clear(). More...

bool	isOwner () const
	Get the owner flag. More...

void	setOwner (bool owner)
	Set the owner flag. More...

void	addStream (Stream *stream, uint_t category, uint_t level)
	Add a stream that will receive logging output. More...

void	put (const String &str, uint_t category=0, uint_t level=uint_t_max)
	Log an application event. More...

void	putLine (const String &str, uint_t category=0, uint_t level=uint_t_max)
	A front-end for put() which logs a newline after the given string. More...

void	setLevel (uint_t category, uint_t level)
	Set the default level for a category. More...

Public Member Functions inherited from utl::Object
void	clear ()
	Revert to initial state. More...

virtual int	compare (const Object &rhs) const
	Compare with another object. More...

virtual void	copy (const Object &rhs)
	Copy another instance. More...

virtual void	vclone (const Object &rhs)
	Make an exact copy of another instance. More...

virtual void	steal (Object &rhs)
	"Steal" the internal representation from another instance. More...

virtual void	dump (Stream &os, uint_t level=uint_t_max) const
	Dump a human-readable representation of self to the given output stream. More...

void	dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
	Front-end for dump() that prints the object's class name. More...

virtual const Object &	getKey () const
	Get the key for this object. More...

bool	hasKey () const
	Determine whether or not the object has a key. More...

virtual const Object &	getProxiedObject () const
	Get the proxied object (= self if none). More...

virtual Object &	getProxiedObject ()
	Get the proxied object (= self if none). More...

virtual size_t	hash (size_t size) const
	Get the hash code for the object. More...

bool	_isA (const RunTimeClass *runTimeClass) const
	Determine whether self's class is a descendent of the given class. More...

virtual String	toString () const
	Return a string representation of self. More...

	operator String () const
	Conversion to String. More...

size_t	allocatedSize () const
	Get the total allocated size of this object. More...

virtual size_t	innerAllocatedSize () const
	Get the "inner" allocated size. More...

virtual void	addOwnedIt (const class FwdIt *it) const
	Notify self that it owns the given iterator. More...

virtual void	removeOwnedIt (const class FwdIt *it) const
	Notify self that the given owned iterator has been destroyed. More...

bool	operator< (const Object &rhs) const
	Less-than operator. More...

bool	operator<= (const Object &rhs) const
	Less-than-or-equal-to operator. More...

bool	operator> (const Object &rhs) const
	Greater-than operator. More...

bool	operator>= (const Object &rhs) const
	Greater-than-or-equal-to operator. More...

bool	operator== (const Object &rhs) const
	Equal-to operator. More...

bool	operator!= (const Object &rhs) const
	Unequal-to operator. More...

void	serializeIn (Stream &is, uint_t mode=ser_default)
	Serialize from an input stream. More...

void	serializeOut (Stream &os, uint_t mode=ser_default) const
	Serialize to an output stream. More...

virtual void	serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize to or from a stream. More...

void	serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
	Serialize a boxed object to an output stream. More...

Additional Inherited Members
Static Public Member Functions inherited from utl::Object
static Object *	serializeInNullable (Stream &is, uint_t mode=ser_default)
	Serialize a nullptr-able object from an input stream. More...

static void	serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default)
	Serialize a nullptr-able object to an output stream. More...

static void	serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a nullptr-able object to or from a stream. More...

static Object *	serializeInBoxed (Stream &is, uint_t mode=ser_default)
	Serialize a boxed object from an input stream. More...

static void	serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a boxed object to or from a stream. More...

Protected Member Functions inherited from utl::FlagsMI
	FlagsMI ()
	Constructor. More...

virtual	~FlagsMI ()
	Destructor. More...

void	copyFlags (const FlagsMI &rhs)
	Copy the given flags. More...

void	copyFlags (const FlagsMI &rhs, uint_t lsb, uint_t msb)
	Copy (some of) the given flags. More...

void	copyFlags (uint64_t flags, uint_t lsb, uint_t msb)
	Copy (some of) the given flags. More...

bool	getFlag (uint_t flagNum) const
	Get a user-defined flag. More...

void	setFlag (uint_t flagNum, bool val)
	Set a user-defined flag. More...

uint64_t	getFlagsNumber (uint64_t mask, uint64_t shift=0)
	Get a multi-bit value in the flags data (which is stored as one 64-bit integer). More...

void	setFlagsNumber (uint64_t mask, uint64_t shift, uint64_t num)
	Set a multi-bit value in the flags data (which is stored as one 64-bit integer). More...

uint64_t	getFlags () const
	Get the flags. More...

void	setFlags (uint64_t flags)
	Set the flags. More...

Detailed Description

Manage application event logging.

Each stream added (via addStream()) has these attributes:

category : Categorizes the logging output. For example, suppose you have several subsystems in your application, and you want to send logging output from each subsystem to different streams. To do this, you would define a category for each software subsystem, and associate different streams with each subsystem category.

level : Specifies the relative importance of logging output. Higher values mean greater importance, lower values mean lesser importance. LogMgr allows you to easily ensure that each stream will only receive logging output of a certain level of importance.

Author: Adam McKee

Definition at line 40 of file LogMgr.h.

Member Function Documentation

◆ clear()

virtual void utl::LogMgr::clear ( )

virtual

See Object::clear().

◆ isOwner()

bool utl::LogMgr::isOwner ( ) const

inline

Get the owner flag.

Definition at line 50 of file LogMgr.h.

◆ setOwner()

void utl::LogMgr::setOwner ( bool owner )

inline

Set the owner flag.

Definition at line 57 of file LogMgr.h.

References utl::uint_t_max.

◆ addStream()

void utl::LogMgr::addStream	(	Stream *	stream,
		uint_t	category,
		uint_t	level
	)

Add a stream that will receive logging output.

Parameters

stream	logging output destination
category	the stream will only receive logging output for its own category
level	the stream will only receive logging output for its own level or greater

◆ put()

void utl::LogMgr::put	(	const String &	str,
		uint_t	category = `0`,
		uint_t	level = `uint_t_max`
	)

Log an application event.

The log entry will be written to all streams that have the same category, and whose level is <= the given level.

Parameters

str	output string
category	(optional : 0) logging category
level	(optional : uint_t_max) logging level

◆ putLine()

void utl::LogMgr::putLine	(	const String &	str,
		uint_t	category = `0`,
		uint_t	level = `uint_t_max`
	)

inline

A front-end for put() which logs a newline after the given string.

Parameters

str	output string
category	(optional : 0) logging category
level	(optional) logging level

Definition at line 88 of file LogMgr.h.

References utl::deInit(), utl::init(), and utl::logMgr.

◆ setLevel()

void utl::LogMgr::setLevel	(	uint_t	category,
		uint_t	level
	)

Set the default level for a category.

Parameters

category	log category
level	default level for the category

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

LogMgr.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clear()

◆ isOwner()

◆ setOwner()

◆ addStream()

◆ put()

◆ putLine()

◆ setLevel()