log4shib 2.0.0

Public Member Functions | Protected Member Functions | List of all members
log4shib::Win32DebugAppender Class Reference

Win32DebugAppender simply sends the log message to the default system debugger on Win32 systems. More...

`#include <Win32DebugAppender.hh>`

Inheritance diagram for log4shib::Win32DebugAppender:
[legend]
Collaboration diagram for log4shib::Win32DebugAppender:
[legend]

## Public Member Functions
| Win32DebugAppender (const std::string &name)
| Constructor. More...
virtual | ~Win32DebugAppender ()
| Destructor. More...
virtual void | close ()
| Close method. More...
Public Member Functions inherited from log4shib::LayoutAppender
| LayoutAppender (const std::string &name)
virtual | ~LayoutAppender ()
virtual bool | requiresLayout () const
| Check if the appender requires a layout. More...
virtual void | setLayout (Layout *layout=NULL)
| Set the Layout for this appender. More...
Public Member Functions inherited from log4shib::AppenderSkeleton
virtual | ~AppenderSkeleton ()
| Destructor for AppenderSkeleton. More...
virtual void | doAppend (const LoggingEvent &event)
| Log in Appender specific way. More...
virtual bool | reopen ()
| Reopens the output destination of this Appender, e.g. More...
virtual void | close ()=0
| Release any resources allocated within the appender such as file handles, network connections, etc. More...
virtual bool | requiresLayout () const =0
| Check if the appender uses a layout. More...
virtual void | setLayout (Layout *layout)=0
| Set the Layout for this appender. More...
virtual void | setThreshold (Priority::Value priority)
| Set the threshold priority of this Appender. More...
virtual Priority::Value | getThreshold ()
| Get the threshold priority of this Appender. More...
virtual void | setFilter (Filter *filter)
| Set a Filter for this appender. More...
virtual Filter * | getFilter ()
| Get the Filter for this appender. More...
Public Member Functions inherited from log4shib::Appender
virtual | ~Appender ()
| Destructor for Appender. More...
virtual void | doAppend (const LoggingEvent &event)=0
| Log in Appender specific way. More...
virtual bool | reopen ()=0
| Reopens the output destination of this Appender, e.g. More...
virtual void | close ()=0
| Release any resources allocated within the appender such as file handles, network connections, etc. More...
virtual bool | requiresLayout () const =0
| Check if the appender uses a layout. More...
virtual void | setLayout (Layout *layout)=0
| Set the Layout for this appender. More...
const std::string & | getName () const
| Get the name of this appender. More...
virtual void | setThreshold (Priority::Value priority)=0
| Set the threshold priority of this Appender. More...
virtual Priority::Value | getThreshold ()=0
| Get the threshold priority of this Appender. More...
virtual void | setFilter (Filter *filter)=0
| Set a Filter for this appender. More...
virtual Filter * | getFilter ()=0
| Get the Filter for this appender. More...

## Protected Member Functions
virtual void | _append (const LoggingEvent &event)
| Method that does the actual work. More...
Protected Member Functions inherited from log4shib::LayoutAppender
Layout & | _getLayout ()
| Return the layout of the appender. More...
Protected Member Functions inherited from log4shib::AppenderSkeleton
| AppenderSkeleton (const std::string &name)
| Constructor for AppenderSkeleton. More...
virtual void | _append (const LoggingEvent &event)=0
| Log in Appender specific way. More...
Protected Member Functions inherited from log4shib::Appender
| Appender (const std::string &name)
| Constructor for Appender. More...

## Additional Inherited Members
Public Types inherited from log4shib::LayoutAppender
typedef BasicLayout | DefaultLayoutType
Static Public Member Functions inherited from log4shib::Appender
static Appender * | getAppender (const std::string &name)
| Get a pointer to an exitsing Appender. More...
static bool | reopenAll ()
| Call reopen() on all existing Appenders. More...
static void | closeAll ()
| Call reopen() on all existing Appenders. More...

## Detailed Description

Win32DebugAppender simply sends the log message to the default system debugger on Win32 systems.

This is useful for users of MSVC and Borland because the log messages will show up in the debugger window.
NB: This class is only available on Win32 platforms.

## Constructor & Destructor Documentation

## ◆ Win32DebugAppender()

log4shib::Win32DebugAppender::Win32DebugAppender | ( | const std::string & | name | ) |

Constructor.

Parameters

  name | Name used by the base classes only.

## ◆ ~Win32DebugAppender()

log4shib::Win32DebugAppender::~Win32DebugAppender | ( |  | ) |
| virtual

Destructor.

## Member Function Documentation

## ◆ _append()

void log4shib::Win32DebugAppender::_append | ( | const LoggingEvent & | event | ) |
| protected virtual

Method that does the actual work.

In this case, it simply sets up the layout and calls the OutputDebugString API.

Parameters

  event | Event for which we are logging.

Implements log4shib::AppenderSkeleton.

## ◆ close()

void log4shib::Win32DebugAppender::close | ( |  | ) |
| virtual

Close method.

This is called by the framework, but there is nothing to do for the OutputDebugString API, so it simply returns.

Implements log4shib::AppenderSkeleton.

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

- Win32DebugAppender.hh
- Win32DebugAppender.cpp