bio::log::Engine Class Reference

#include <Engine.h>

Public Member Functions
	Engine ()
virtual	~Engine ()
Level	FilterGet (Filter filter) const
bool	FilterPass (Filter filter, Level level) const
bool	FilterSet (Filter filter, Level level)
bool	FilterSet (Name filter, Name level)
void	Log (Filter filter, Level level, const char *format, va_list args)
void	Log (Filter filter, Level level, const char *format,...)
virtual void	Output (const std::string &logString)=0

Protected Attributes
std::ostringstream	m_logMessage

Detailed Description

log::Engines are responsible for printing logs. Create your own Engine, if you have your own output schema you'd like to use (e.g. to the screen of a gui instead of to a file or standard out).

Definition at line 37 of file Engine.h.

Constructor & Destructor Documentation

Engine()

bio::log::Engine::Engine

(

)

Definition at line 37 of file Engine.cpp.

{
    //Set all filters to only log if level is >= Info
    m_levelFilter.assign(
        FilterPerspective::Instance().GetNumUsedIds(),
        level::Info());
}

References bio::log::level::Info().

~Engine()

bio::log::Engine::~Engine ( )

virtual

Definition at line 45 of file Engine.cpp.

{
 
}

Member Function Documentation

FilterGet()

Level bio::log::Engine::FilterGet

(

Filter

filter

)

const

Parameters

filter

Returns

Current level for the given filter.

Definition at line 135 of file Engine.cpp.

{
    return m_levelFilter[filter];
}

FilterPass()

bool bio::log::Engine::FilterPass	(	Filter	filter,
		Level	level
	)		const

Parameters

filter
level

Returns

true if level is enabled for the filter, false if disabled; false if filter is ALL or out of range; false if level is out of range.

Definition at line 108 of file Engine.cpp.

{
    return level >= m_levelFilter[filter];
}

Referenced by Log(), and bio::log::Writer::Log().

FilterSet() [1/2]

bool bio::log::Engine::FilterSet	(	Filter	filter,
		Level	level
	)

Change filter level for the filter

Parameters

filter	what to affect; use ALL to set the level of all filters.
level	value to set for the given filter (Log() calls must be >= to this to be seen).

Returns

true on success, false otherwise.

Definition at line 116 of file Engine.cpp.

{
    m_levelFilter[filter] = level;
    return true; //SUCCESS
}

Referenced by FilterSet().

FilterSet() [2/2]

bool bio::log::Engine::FilterSet	(	Name	filter,
		Name	level
	)

Change filter level for the filter

Parameters

filter	what to affect; use ALL to set the level of all filters.
level	value to set for the given filter (Log() calls must be >= to this to be seen).

Returns

true on success, false otherwise.

Definition at line 125 of file Engine.cpp.

{
    return FilterSet(
        FilterPerspective::Instance().GetIdFromName(filter),
        LevelPerspective::Instance().GetIdFromName(level));
}

References FilterSet().

Log() [1/2]

void bio::log::Engine::Log	(	Filter	filter,
		Level	level,
		const char *	format,
		va_list	args
	)

Generates a log string and calls Output (caller is responsible for using filters).

Parameters

filter
level
format
args

Definition at line 50 of file Engine.cpp.

{
    BIO_SANITIZE_AT_SAFETY_LEVEL_2(FilterPass(
        filter,
        level
    ), ,
        return);
 
    char str[BIO_LOG_PRINTF_MAX_LINE_SIZE + 1];
 
    vsnprintf(
        str,
        sizeof(str),
        format,
        args
    );
    va_end(args);
    str[BIO_LOG_PRINTF_MAX_LINE_SIZE] = '\0';
 
    m_logMessage.clear();
    m_logMessage.str(""); //TODO: is seekp good enough? what is faster?
 
    m_logMessage << physical::GetCurrentTimestamp() << " " << FilterPerspective::Instance().GetNameFromId(filter) << " " << LevelPerspective::Instance().GetNameFromId(level) << ": " << str << "\n";
    Output(m_logMessage.str());
}

References BIO_LOG_PRINTF_MAX_LINE_SIZE, BIO_SANITIZE_AT_SAFETY_LEVEL_2, FilterPass(), bio::physical::GetCurrentTimestamp(), m_logMessage, and Output().

Referenced by bio::log::Writer::ExternalLog(), Log(), and bio::log::Writer::Log().

Log() [2/2]

void bio::log::Engine::Log	(	Filter	filter,
		Level	level,
		const char *	format,
			...
	)

Create a log string that will be Output(). *this can be invoked directly or via Writer::ExternalLog Both calls will have the same effect.

Parameters

filter
level
format
...

Definition at line 81 of file Engine.cpp.

{
    if (FilterPass(
        filter,
        level
    ))
    {
        return; //filter off, don't log
    }
 
    va_list args;
    va_start(args,
        format);
    Log(
        filter,
        level,
        format,
        args
    );
    va_end(args);
}

References FilterPass(), and Log().

Output()

virtual void bio::log::Engine::Output ( const std::string &  logString )

pure virtual

Required override for outputting logs. logString will include a newline (
) character.

Parameters

logString

fully prepared text to be logged.

Referenced by Log().

Member Data Documentation

m_logMessage

std::ostringstream bio::log::Engine::m_logMessage

protected

This should not need to be accessed from children, as it is passed to Output but is here for convenience. TODO: see if there is a faster data type for logging.

Definition at line 131 of file Engine.h.

Referenced by Log().

---

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

• /home/eons/git/biology/lib_bio/inc/bio/log/Engine.h
• /home/eons/git/biology/lib_bio/src/log/Engine.cpp