Apache Log4cxx  Version 2.0.0
Loading...
Searching...
No Matches
log4cxx::nt::NTEventLogAppender Class Reference

Appends log events to NT EventLog. More...

#include <nteventlogappender.h>

Inheritance diagram for log4cxx::nt::NTEventLogAppender:
log4cxx::AppenderSkeleton log4cxx::Appender log4cxx::spi::OptionHandler log4cxx::helpers::Object

Public Member Functions

 NTEventLogAppender ()
 NTEventLogAppender (const LogString &server, const LogString &log, const LogString &source, const LayoutPtr &layout)
virtual ~NTEventLogAppender ()
void activateOptions () override
 Activate the options that were previously set with calls to option setters.
void setOption (const LogString &option, const LogString &value) override
 Override this method to set option to value.
void setSource (const LogString &source)
const LogString & getSource () const
void setLog (const LogString &log)
const LogString & getLog () const
void setServer (const LogString &server)
const LogString & getServer () const
void activateOptions (helpers::Pool &)
Public Member Functions inherited from log4cxx::AppenderSkeleton
 AppenderSkeleton (const LayoutPtr &layout={})
virtual ~AppenderSkeleton ()
void addFilter (const spi::FilterPtr &newFilter) override
 Add newFilter to end of the spi::Filter chain.
void clearFilters () override
 Clear the spi::Filter chain.
void close () override
 Release any resources allocated within the appender such as file handles, network connections, etc.
const spi::ErrorHandlerPtr getErrorHandler () const
 The currently set spi::ErrorHandler for this Appender.
spi::FilterPtr getFilter () const override
 The first spi::Filter in the filter chain for this Appender.
const spi::FilterPtr getFirstFilter () const
 The first spi::Filter in the filter chain for this Appender.
LayoutPtr getLayout () const override
 The currently set Layout for this appender.
LogString getName () const override
 The name of this Appender.
const LevelPtr getThreshold () const
 This appender's current threshold level.
bool isAsSevereAsThreshold (const LevelPtr &level) const
 Is level greater than or equal to this appender's threshold?
void doAppend (const spi::LoggingEventPtr &event) override
 Call doAppendImpl after acquiring a lock that prevents other threads from concurrently executing doAppendImpl.
void setErrorHandler (const spi::ErrorHandlerPtr &newValue)
 Use newValue as the spi::ErrorHandler for this Appender.
void setLayout (const LayoutPtr &newValue) override
 Use newValue as the layout for this appender.
void setName (const LogString &newValue) override
 Use newValue for the name of this Appender.
void setThreshold (const LevelPtr &newValue)
 Use newValue as this appender's threshold level.
void activateOptions (helpers::Pool &)
Public Member Functions inherited from log4cxx::Appender
virtual ~Appender ()
void doAppend (const spi::LoggingEventPtr &event, helpers::Pool &pool)
virtual bool requiresLayout () const
Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual ~OptionHandler ()
void activateOptions (helpers::Pool &)
Public Member Functions inherited from log4cxx::helpers::Object
virtual ~Object ()
virtual const helpers::Class & getClass () const =0
virtual bool instanceof (const Class &clazz) const =0
virtual const void * cast (const Class &clazz) const =0

Protected Types

typedef void SID
typedef void * HANDLE

Protected Member Functions

void append (const spi::LoggingEventPtr &event) override
 Subclasses of AppenderSkeleton must implement this method to perform actual logging.
void addRegistryInfo ()
Protected Member Functions inherited from log4cxx::AppenderSkeleton
 AppenderSkeleton (LOG4CXX_PRIVATE_PTR(AppenderSkeletonPrivate) priv)
void doAppendImpl (const spi::LoggingEventPtr &event)
 Call the AppenderSkeleton::append method if the level of event is not lower than this appender's threshold and no attached spi::Filter indicates event is rejected.
bool isAccepted (const spi::LoggingEventPtr &event) const
 Does no attached filter deny event or does an attached filter accept event?

Static Protected Member Functions

static unsigned short getEventType (const spi::LoggingEventPtr &event)
static unsigned short getEventCategory (const spi::LoggingEventPtr &event)
static LogString getErrorString (const LogString &function)

Detailed Description

Appends log events to NT EventLog.

Member Typedef Documentation

◆ HANDLE

typedef void* log4cxx::nt::NTEventLogAppender::HANDLE
protected

◆ SID

typedef void log4cxx::nt::NTEventLogAppender::SID
protected

Constructor & Destructor Documentation

◆ NTEventLogAppender() [1/2]

log4cxx::nt::NTEventLogAppender::NTEventLogAppender ( )

◆ NTEventLogAppender() [2/2]

log4cxx::nt::NTEventLogAppender::NTEventLogAppender ( const LogString & server,
const LogString & log,
const LogString & source,
const LayoutPtr & layout )

◆ ~NTEventLogAppender()

virtual log4cxx::nt::NTEventLogAppender::~NTEventLogAppender ( )
virtual

Member Function Documentation

◆ activateOptions() [1/2]

void log4cxx::nt::NTEventLogAppender::activateOptions ( )
overridevirtual

Activate the options that were previously set with calls to option setters.

Calls RegisterEventSource.

Reimplemented from log4cxx::AppenderSkeleton.

◆ activateOptions() [2/2]

Deprecated
This function is deprecated and will be removed in a future version.
Deprecated
Use activateOptions() without parameters instead

◆ addRegistryInfo()

void log4cxx::nt::NTEventLogAppender::addRegistryInfo ( )
protected

◆ append()

void log4cxx::nt::NTEventLogAppender::append ( const spi::LoggingEventPtr & event)
overrideprotectedvirtual

Subclasses of AppenderSkeleton must implement this method to perform actual logging.

See also AppenderSkeleton::doAppend method.

Implements log4cxx::AppenderSkeleton.

◆ getErrorString()

LogString log4cxx::nt::NTEventLogAppender::getErrorString ( const LogString & function)
staticprotected

◆ getEventCategory()

unsigned short log4cxx::nt::NTEventLogAppender::getEventCategory ( const spi::LoggingEventPtr & event)
staticprotected

◆ getEventType()

unsigned short log4cxx::nt::NTEventLogAppender::getEventType ( const spi::LoggingEventPtr & event)
staticprotected

◆ getLog()

const LogString & log4cxx::nt::NTEventLogAppender::getLog ( ) const

◆ getServer()

const LogString & log4cxx::nt::NTEventLogAppender::getServer ( ) const

◆ getSource()

const LogString & log4cxx::nt::NTEventLogAppender::getSource ( ) const

◆ setLog()

void log4cxx::nt::NTEventLogAppender::setLog ( const LogString & log)

◆ setOption()

void log4cxx::nt::NTEventLogAppender::setOption ( const LogString & option,
const LogString & value )
overridevirtual

Override this method to set option to value.

Supported options Supported values Default value
Server (1) NULL
Source (1) -
Log (2) Application

(1) Passed to the Win32 API method RegisterEventSource.

(2) An event log name.

See also
AppenderSkeleton::setOption()

Reimplemented from log4cxx::AppenderSkeleton.

◆ setServer()

void log4cxx::nt::NTEventLogAppender::setServer ( const LogString & server)

◆ setSource()

void log4cxx::nt::NTEventLogAppender::setSource ( const LogString & source)

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