Prints events to Win32 console. More...

#include <win32consoleappender.h>

Inheritance diagram for log4cplus::Win32ConsoleAppender:

Collaboration diagram for log4cplus::Win32ConsoleAppender:

Public Member Functions
	Win32ConsoleAppender (bool allocConsole=true, bool logToStdErr=false, unsigned int textColor=0)

	Win32ConsoleAppender (helpers::Properties const &properties)

virtual	~Win32ConsoleAppender ()

virtual void	close ()
	Release any resources allocated within the appender such as file handles, network connections, etc. More...

Public Member Functions inherited from log4cplus::Appender
	Appender ()

	Appender (const log4cplus::helpers::Properties &properties)

virtual	~Appender ()

void	destructorImpl ()
	This function is for derived appenders to call from their destructors. More...

bool	isClosed () const
	Check if this appender is in closed state. More...

void	syncDoAppend (const log4cplus::spi::InternalLoggingEvent &event)
	This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific {} method. More...

void	asyncDoAppend (const log4cplus::spi::InternalLoggingEvent &event)
	This method performs book keeping related to asynchronous logging and executes `syncDoAppend()` to do the actual logging. More...

void	doAppend (const log4cplus::spi::InternalLoggingEvent &event)
	This function checks `async` flag. More...

virtual log4cplus::tstring	getName ()
	Get the name of this appender. More...

virtual void	setName (const log4cplus::tstring &name)
	Set the name of this appender. More...

virtual void	setErrorHandler (std::unique_ptr< ErrorHandler > eh)
	Set the ErrorHandler for this Appender. More...

virtual ErrorHandler *	getErrorHandler ()
	Return the currently set ErrorHandler for this Appender. More...

virtual void	setLayout (std::unique_ptr< Layout > layout)
	Set the layout for this appender. More...

virtual Layout *	getLayout ()
	Returns the layout of this appender. More...

void	setFilter (log4cplus::spi::FilterPtr f)
	Set the filter chain on this Appender. More...

log4cplus::spi::FilterPtr	getFilter () const
	Get the filter chain on this Appender. More...

void	addFilter (log4cplus::spi::FilterPtr f)
	Add filter at the end of the filters chain. More...

void	addFilter (std::function< spi::FilterResult(const log4cplus::spi::InternalLoggingEvent &)>)
	Add filter at the end of the filters chain. More...

LogLevel	getThreshold () const
	Returns this appenders threshold LogLevel. More...

void	setThreshold (LogLevel th)
	Set the threshold LogLevel. More...

bool	isAsSevereAsThreshold (LogLevel ll) const
	Check whether the message LogLevel is below the appender's threshold. More...

void	waitToFinishAsyncLogging ()
	This method waits for all events that are being asynchronously logged to finish. More...

Public Member Functions inherited from log4cplus::helpers::SharedObject
void	addReference () const LOG4CPLUS_NOEXCEPT

void	removeReference () const

Protected Member Functions
virtual void	append (spi::InternalLoggingEvent const &)
	Subclasses of `Appender` should implement this method to perform actual logging. More...

void	write_handle (void , tchar const , std::size_t)

void	write_console (void , tchar const , std::size_t)

Protected Member Functions inherited from log4cplus::Appender
tstring &	formatEvent (const log4cplus::spi::InternalLoggingEvent &event) const

Protected Member Functions inherited from log4cplus::helpers::SharedObject
	SharedObject ()

	SharedObject (const SharedObject &)

	SharedObject (SharedObject &&)

virtual	~SharedObject ()

SharedObject &	operator= (const SharedObject &) LOG4CPLUS_NOEXCEPT

SharedObject &	operator= (SharedObject &&) LOG4CPLUS_NOEXCEPT

Protected Attributes
bool	alloc_console

bool	log_to_std_err

unsigned int	text_color

Protected Attributes inherited from log4cplus::Appender
std::unique_ptr< Layout >	layout
	The layout variable does not need to be set if the appender implementation has its own layout. More...

log4cplus::tstring	name
	Appenders are named. More...

LogLevel	threshold
	There is no LogLevel threshold filtering by default. More...

log4cplus::spi::FilterPtr	filter
	The first filter in the filter chain. More...

std::unique_ptr< ErrorHandler >	errorHandler
	It is assumed and enforced that errorHandler is never null. More...

std::unique_ptr< helpers::LockFile >	lockFile
	Optional system wide synchronization lock. More...

bool	useLockFile
	Use lock file for inter-process synchronization of access to log file. More...

bool	async
	Asynchronous append. More...

std::atomic< std::size_t >	in_flight

std::mutex	in_flight_mutex

std::condition_variable	in_flight_condition

bool	closed
	Is this appender closed? More...

Additional Inherited Members
Public Attributes inherited from log4cplus::helpers::SharedObject
thread::Mutex	access_mutex

Detailed Description

Prints events to Win32 console.

Properties

AllocConsole

This boolean property specifies whether or not this appender will try to allocate new console using the AllocConsole() Win32 function.

logToStdErr

When it is set true, the output will be into STD_ERROR_HANDLE instead of STD_OUTPUT_HANDLE.

TextColor

See MSDN documentation for Character Attributes.

Definition at line 63 of file win32consoleappender.h.

Constructor & Destructor Documentation

◆ Win32ConsoleAppender() [1/2]

log4cplus::Win32ConsoleAppender::Win32ConsoleAppender	(	bool	allocConsole = `true`,
		bool	logToStdErr = `false`,
		unsigned int	textColor = `0`
	)

explicit

◆ Win32ConsoleAppender() [2/2]

log4cplus::Win32ConsoleAppender::Win32ConsoleAppender ( helpers::Properties const & properties )

◆ ~Win32ConsoleAppender()

virtual log4cplus::Win32ConsoleAppender::~Win32ConsoleAppender ( )

virtual

Member Function Documentation

◆ append()

virtual void log4cplus::Win32ConsoleAppender::append ( spi::InternalLoggingEvent const & event )

protectedvirtual

Subclasses of Appender should implement this method to perform actual logging.

See also: doAppend method.

Implements log4cplus::Appender.

◆ close()

virtual void log4cplus::Win32ConsoleAppender::close ( )

virtual

Release any resources allocated within the appender such as file handles, network connections, etc.

It is a programming error to append to a closed appender.

Implements log4cplus::Appender.

◆ write_console()

void log4cplus::Win32ConsoleAppender::write_console	(	void *	,
		tchar const *	,
		std::size_t
	)

protected

◆ write_handle()

void log4cplus::Win32ConsoleAppender::write_handle	(	void *	,
		tchar const *	,
		std::size_t
	)

protected

Member Data Documentation

◆ alloc_console

bool log4cplus::Win32ConsoleAppender::alloc_console

protected

Definition at line 80 of file win32consoleappender.h.

◆ log_to_std_err

bool log4cplus::Win32ConsoleAppender::log_to_std_err

protected

Definition at line 81 of file win32consoleappender.h.

◆ text_color

unsigned int log4cplus::Win32ConsoleAppender::text_color

protected

Definition at line 82 of file win32consoleappender.h.

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

win32consoleappender.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Properties

Constructor & Destructor Documentation

◆ Win32ConsoleAppender() [1/2]

◆ Win32ConsoleAppender() [2/2]

◆ ~Win32ConsoleAppender()

Member Function Documentation

◆ append()

◆ close()

◆ write_console()

◆ write_handle()

Member Data Documentation

◆ alloc_console

◆ log_to_std_err

◆ text_color