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.

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. bool isClosed () const
Check if this appender is in closed state. void syncDoAppend (const log4cplus::spi::InternalLoggingEvent &event)
This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific append method. void asyncDoAppend (const log4cplus::spi::InternalLoggingEvent &event)
This method performs book keeping related to asynchronous logging and executes syncDoAppend() to do the actual logging. void doAppend (const log4cplus::spi::InternalLoggingEvent &event)
This function checks async flag. virtual log4cplus::tstring getName ()
Get the name of this appender. virtual void setName (const log4cplus::tstring &name)
Set the name of this appender. virtual void setErrorHandler (std::unique_ptr< ErrorHandler > eh)
Set the ErrorHandler for this Appender. virtual ErrorHandler * getErrorHandler ()
Return the currently set ErrorHandler for this Appender. virtual void setLayout (std::unique_ptr< Layout > layout)
Set the layout for this appender. virtual Layout * getLayout ()
Returns the layout of this appender. void setFilter (log4cplus::spi::FilterPtr f)
Set the filter chain on this Appender. log4cplus::spi::FilterPtr getFilter () const
Get the filter chain on this Appender. void addFilter (log4cplus::spi::FilterPtr f)
Add filter at the end of the filters chain. void addFilter (std::function< spi::FilterResult(const log4cplus::spi::InternalLoggingEvent &)>)
Add filter at the end of the filters chain. LogLevel getThreshold () const
Returns this appenders threshold LogLevel. void setThreshold (LogLevel th)
Set the threshold LogLevel. bool isAsSevereAsThreshold (LogLevel ll) const
Check whether the message LogLevel is below the appender's threshold. void waitToFinishAsyncLogging ()
This method waits for all events that are being asynchronously logged to finish.

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. 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. log4cplus::tstring name
Appenders are named. LogLevel threshold
There is no LogLevel threshold filtering by default. log4cplus::spi::FilterPtr filter
The first filter in the filter chain. std::unique_ptr< ErrorHandler > errorHandler
It is assumed and enforced that errorHandler is never null. std::unique_ptr< helpers::LockFile > lockFile
Optional system wide synchronization lock. bool useLockFile
Use lock file for inter-process synchronization of access to log file. bool async
Asynchronous append. std::atomic< std::size_t > in_flight
std::mutex in_flight_mutex
std::condition_variable in_flight_condition
bool closed
Is this appender closed?

Additional Inherited Members

Public Attributes inherited from log4cplus::helpers::SharedObject
thread::Mutex access_mutex

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.

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

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

virtual log4cplus::Win32ConsoleAppender::~Win32ConsoleAppender () [virtual]

virtual void log4cplus::Win32ConsoleAppender::append (spi::InternalLoggingEvent const & event) [protected], [virtual]

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

See also

Implements log4cplus::Appender.

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.

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

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

bool log4cplus::Win32ConsoleAppender::alloc_console [protected]

Definition at line 80 of file win32consoleappender.h.

bool log4cplus::Win32ConsoleAppender::log_to_std_err [protected]

Definition at line 81 of file win32consoleappender.h.

unsigned int log4cplus::Win32ConsoleAppender::text_color [protected]

Definition at line 82 of file win32consoleappender.h.