Appends log events to NT EventLog. More...

#include <nteventlogappender.h>

Inheritance diagram for log4cxx::nt::NTEventLogAppender:

Public Member Functions
	NTEventLogAppender ()

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

virtual	~NTEventLogAppender ()

virtual void	activateOptions (log4cxx::helpers::Pool &p)
	Derived appenders should override this method if option structure requires it. More...

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

virtual void	setOption (const LogString &option, const LogString &value)
	Set `option` to `value`. More...

bool	requiresLayout () const
	The SocketAppender does not use a layout. More...

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

Public Member Functions inherited from log4cxx::AppenderSkeleton
	AppenderSkeleton ()

	AppenderSkeleton (const LayoutPtr &layout)

void	finalize ()
	Finalize this appender by calling the derived class' `close` method. More...

virtual void	activateOptions (log4cxx::helpers::Pool &)
	Derived appenders should override this method if option structure requires it. More...

virtual void	setOption (const LogString &option, const LogString &value)
	Set `option` to `value`. More...

void	addFilter (const spi::FilterPtr &newFilter)
	Add a filter to end of the filter list. More...

void	clearFilters ()
	Clear the filters chain. More...

const spi::ErrorHandlerPtr &	getErrorHandler () const
	Return the currently set spi::ErrorHandler for this Appender. More...

spi::FilterPtr	getFilter () const
	Returns the head Filter. More...

const spi::FilterPtr &	getFirstFilter () const
	Return the first filter in the filter chain for this Appender. More...

LayoutPtr	getLayout () const
	Returns the layout of this appender. More...

LogString	getName () const
	Returns the name of this Appender. More...

const LevelPtr &	getThreshold () const
	Returns this appenders threshold level. More...

bool	isAsSevereAsThreshold (const LevelPtr &level) const
	Check whether the message level is below the appender's threshold. More...

virtual void	doAppend (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool)
	This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific AppenderSkeleton::append method. More...

void	setErrorHandler (const spi::ErrorHandlerPtr eh)
	Set the `ErrorHandler` for this Appender. More...

void	setLayout (const LayoutPtr &layout1)
	Set the layout for this appender. More...

void	setName (const LogString &name1)
	Set the name of this Appender. More...

void	setThreshold (const LevelPtr &threshold)
	Set the threshold level. More...

Public Member Functions inherited from log4cxx::Appender
virtual	~Appender ()

void	asdf ()

virtual void	addFilter (const spi::FilterPtr &newFilter)=0
	Add a filter to the end of the filter list. More...

virtual spi::FilterPtr	getFilter () const =0
	Returns the head Filter. More...

virtual void	clearFilters ()=0
	Clear the list of filters by removing all the filters in it. More...

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

virtual void	doAppend (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool)=0
	Log in `Appender` specific way. More...

virtual LogString	getName () const =0
	Get the name of this appender. More...

virtual void	setLayout (const LayoutPtr &layout)=0
	Set the Layout for this appender. More...

virtual LayoutPtr	getLayout () const =0
	Returns this appenders layout. More...

virtual void	setName (const LogString &name)=0
	Set the name of this appender. More...

virtual bool	requiresLayout () const =0
	Configurators call this method to determine if the appender requires a layout. More...

Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual	~OptionHandler ()

virtual void	activateOptions (log4cxx::helpers::Pool &p)=0
	Activate the options that were previously set with calls to option setters. More...

virtual void	setOption (const LogString &option, const LogString &value)=0
	Set `option` to `value`. More...

Public Member Functions inherited from log4cxx::helpers::Object
virtual	~Object ()

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
virtual void	append (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p)
	Subclasses of `AppenderSkeleton` should implement this method to perform actual logging. More...

void	addRegistryInfo ()

Protected Member Functions inherited from log4cxx::AppenderSkeleton
virtual void	append (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p)=0
	Subclasses of `AppenderSkeleton` should implement this method to perform actual logging. More...

void	doAppendImpl (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool)

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)

Protected Attributes
LogString	server

LogString	log

LogString	source

HANDLE	hEventLog

SID *	pCurrentUserSID

Protected Attributes inherited from log4cxx::AppenderSkeleton
LayoutPtr	layout
	The layout variable does not need to be set if the appender implementation has its own layout. More...

LogString	name
	Appenders are named. More...

LevelPtr	threshold
	There is no level threshold filtering by default. More...

spi::ErrorHandlerPtr	errorHandler
	It is assumed and enforced that errorHandler is never null. More...

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

spi::FilterPtr	tailFilter
	The last filter in the filter chain. More...

bool	closed
	Is this appender closed? More...

log4cxx::helpers::Pool	pool

std::recursive_mutex	mutex

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()

virtual void log4cxx::nt::NTEventLogAppender::activateOptions ( log4cxx::helpers::Pool & )

virtual

Derived appenders should override this method if option structure requires it.

Reimplemented from log4cxx::AppenderSkeleton.

◆ addRegistryInfo()

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

protected

◆ append()

virtual void log4cxx::nt::NTEventLogAppender::append	(	const spi::LoggingEventPtr &	event,
		log4cxx::helpers::Pool &	p
	)

protectedvirtual

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

See also AppenderSkeleton::doAppend method.

Implements log4cxx::AppenderSkeleton.

◆ close()

virtual void log4cxx::nt::NTEventLogAppender::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 log4cxx::Appender.

◆ getErrorString()

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

staticprotected

◆ getEventCategory()

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

staticprotected

◆ getEventType()

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

staticprotected

◆ getLog()

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

inline

◆ getServer()

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

inline

◆ getSource()

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

inline

◆ requiresLayout()

bool log4cxx::nt::NTEventLogAppender::requiresLayout ( ) const

inlinevirtual

The SocketAppender does not use a layout.

Hence, this method returns false.

Implements log4cxx::Appender.

◆ setLog()

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

inline

◆ setOption()

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

virtual

Set option to value.

The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when activateOptions is called.

Reimplemented from log4cxx::AppenderSkeleton.

◆ setServer()

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

inline

◆ setSource()

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

inline

Member Data Documentation

◆ hEventLog

HANDLE log4cxx::nt::NTEventLogAppender::hEventLog

protected

◆ log

LogString log4cxx::nt::NTEventLogAppender::log

protected

◆ pCurrentUserSID

SID* log4cxx::nt::NTEventLogAppender::pCurrentUserSID

protected

◆ server

LogString log4cxx::nt::NTEventLogAppender::server

protected

◆ source

LogString log4cxx::nt::NTEventLogAppender::source

protected

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

nteventlogappender.h

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ HANDLE

◆ SID

Constructor & Destructor Documentation

◆ NTEventLogAppender() [1/2]

◆ NTEventLogAppender() [2/2]

◆ ~NTEventLogAppender()

Member Function Documentation

◆ activateOptions()

◆ addRegistryInfo()

◆ append()

◆ close()

◆ getErrorString()

◆ getEventCategory()

◆ getEventType()

◆ getLog()

◆ getServer()

◆ getSource()

◆ requiresLayout()

◆ setLog()

◆ setOption()

◆ setServer()

◆ setSource()

Member Data Documentation

◆ hEventLog

◆ log

◆ pCurrentUserSID

◆ server

◆ source