coil::log_stream< _CharT, _Traits > Class Template Reference

#include <Logger.h>

Inheritance diagram for coil::log_stream< _CharT, _Traits >:

Public Types
typedef _CharT	char_type
typedef _Traits	traits_type
typedef std::basic_ostream < char_type, traits_type >	ostream_type
typedef std::basic_streambuf < char_type, traits_type >	streambuf_type
typedef coil::Mutex	Mutex
typedef coil::Guard< Mutex >	Guard
Public Member Functions
	log_stream (streambuf_type *sb, int levelmin, int levelmax, int level)
	Constructor.
virtual void	header (int level)
	Message header appender function.
bool	setLevel (int level)
	Set the log level.
int	getLevel () const
	Get the log level.
void	enableLock ()
void	disableLock ()
ostream_type &	level (int level)
	Acquire log stream.
bool	isValid (int level) const
	Log level effective check.
void	lock ()
	Acquire log lock Acquire log lock when the lock mode is set.
void	unlock ()
	Release the log lock Release the log lock when the lock mode is set.
Static Public Attributes
static bool	m_lockEnable = true
	Lock enable mode.
static Mutex	m_mutex
	Mutual exclusion object.
Protected Member Functions
	~log_stream ()
	Destructor.
	log_stream ()
	Default constructor.
	log_stream (const log_stream &x)
	Copy Constructor.
log_stream &	operator= (const log_stream &x)
	Assignment operator.

Detailed Description

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
class coil::log_stream< _CharT, _Traits >

log_stream template class

Member Typedef Documentation

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

typedef _CharT coil::log_stream< _CharT, _Traits >::char_type

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

typedef coil::Guard<Mutex> coil::log_stream< _CharT, _Traits >::Guard

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

typedef coil::Mutex coil::log_stream< _CharT, _Traits >::Mutex

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

typedef std::basic_ostream<char_type, traits_type> coil::log_stream< _CharT, _Traits >::ostream_type

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

typedef std::basic_streambuf<char_type, traits_type> coil::log_stream< _CharT, _Traits >::streambuf_type

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

typedef _Traits coil::log_stream< _CharT, _Traits >::traits_type

Constructor & Destructor Documentation

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

coil::log_stream< _CharT, _Traits >::log_stream	(	streambuf_type *	sb,
		int	levelmin,
		int	levelmax,
		int	level
	)			`[inline]`

Constructor.

Constructor

Parameters:

	streambuf	basic_streambuf type object
	levelmin	minimum value for log level
	levelmax	maximum value for log level
	level	default log level

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

coil::log_stream< _CharT, _Traits >::~log_stream ( ) [inline, protected]

Destructor.

Destructor

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

coil::log_stream< _CharT, _Traits >::log_stream ( ) [protected]

Default constructor.

Default constructor

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

coil::log_stream< _CharT, _Traits >::log_stream ( const log_stream< _CharT, _Traits > & x ) [protected]

Copy Constructor.

Copy Constructor

Parameters:

x

log_stream object

Member Function Documentation

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

void coil::log_stream< _CharT, _Traits >::disableLock ( ) [inline]

Disable the lock mode.

References coil::log_stream< _CharT, _Traits >::m_lockEnable.

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

void coil::log_stream< _CharT, _Traits >::enableLock ( ) [inline]

Enable the lock mode.

References coil::log_stream< _CharT, _Traits >::m_lockEnable.

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

int coil::log_stream< _CharT, _Traits >::getLevel ( ) const [inline]

Get the log level.

Returns:: Log level

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

virtual void coil::log_stream< _CharT, _Traits >::header ( int level ) [inline, virtual]

Message header appender function.

Subclasses of this class should override this operation, and this function should be defined to append some header to the log messages.

Reimplemented in RTC::Logger.

Referenced by coil::log_stream< _CharT, _Traits >::level().

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

bool coil::log_stream< _CharT, _Traits >::isValid ( int level ) const [inline]

Log level effective check.

Check it whether an appointed log level is an effective range and return effective or invalidity.

Parameters:

level

Log level

Returns:: true: Valid, false: Invalid

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

ostream_type& coil::log_stream< _CharT, _Traits >::level ( int level ) [inline]

Acquire log stream.

Investigate the specified log level and get its log stream. If the specified log level is under the set log level, this class will be returned. If the specified log level exceeds the set log level, a dummy log class will be returned.

Parameters:

level

The specified log level

Returns:: Target log stream

References coil::log_stream< _CharT, _Traits >::header().

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

void coil::log_stream< _CharT, _Traits >::lock ( ) [inline]

Acquire log lock Acquire log lock when the lock mode is set.

References coil::Mutex::lock(), coil::log_stream< _CharT, _Traits >::m_lockEnable, and coil::log_stream< _CharT, _Traits >::m_mutex.

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

log_stream& coil::log_stream< _CharT, _Traits >::operator= ( const log_stream< _CharT, _Traits > & x ) [protected]

Assignment operator.

Copy a log_stream object.

Parameters:

x

log_stream object.

Returns:: Assignment result.

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

bool coil::log_stream< _CharT, _Traits >::setLevel ( int level ) [inline]

Set the log level.

Parameters:

level

Log level

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

void coil::log_stream< _CharT, _Traits >::unlock ( ) [inline]

Release the log lock Release the log lock when the lock mode is set.

References coil::log_stream< _CharT, _Traits >::m_lockEnable, coil::log_stream< _CharT, _Traits >::m_mutex, and coil::Mutex::unlock().

Member Data Documentation

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

bool coil::log_stream< _CharT, _Traits >::m_lockEnable = true [inline, static]

Lock enable mode.

Referenced by coil::log_stream< _CharT, _Traits >::disableLock(), coil::log_stream< _CharT, _Traits >::enableLock(), coil::log_stream< _CharT, _Traits >::lock(), and coil::log_stream< _CharT, _Traits >::unlock().

template<typename _CharT , typename _Traits = std::char_traits<_CharT>>

coil::Mutex coil::log_stream< _CharT, _Traits >::m_mutex [inline, static]

Mutual exclusion object.

Referenced by coil::log_stream< _CharT, _Traits >::lock(), and coil::log_stream< _CharT, _Traits >::unlock().

coil::log_stream< _CharT, _Traits > Class Template Reference

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

template<typename _CharT, typename _Traits = std::char_traits<_CharT>> class coil::log_stream< _CharT, _Traits >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
class coil::log_stream< _CharT, _Traits >