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

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

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

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

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

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)

virtual	~AppenderSkeleton ()

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

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

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

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

void	clearFilters () override
	Clear the filters chain.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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, helpers::Pool &p) override
	Subclasses of `AppenderSkeleton` should implement this method to perform actual logging.

void	addRegistryInfo ()

Protected Member Functions inherited from log4cxx::AppenderSkeleton
	AppenderSkeleton (LOG4CXX_PRIVATE_PTR(AppenderSkeletonPrivate) priv)

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

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)

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

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

overridevirtual

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

Reimplemented from log4cxx::AppenderSkeleton.

◆ addRegistryInfo()

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

protected

◆ append()

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

overrideprotectedvirtual

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

See also AppenderSkeleton::doAppend method.

Implements log4cxx::AppenderSkeleton.

◆ close()

void log4cxx::nt::NTEventLogAppender::close ( )

overridevirtual

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

◆ getServer()

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

◆ getSource()

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

◆ requiresLayout()

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

inlineoverridevirtual

The SocketAppender does not use a layout.

Hence, this method returns false.

Implements log4cxx::Appender.

◆ setLog()

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

◆ setOption()

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

overridevirtual

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 )

◆ setSource()

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

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

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