LayoutAppender Class Reference

LayoutAppender is a common superclass for all Appenders that require a Layout. More...

#include <LayoutAppender.hh>

Inheritance diagram for LayoutAppender:

Public Types
typedef BasicLayout	DefaultLayoutType

Public Member Functions
	LayoutAppender (const std::string &name)
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...
virtual	~LayoutAppender ()
Public Member Functions inherited from AppenderSkeleton
virtual void	close ()=0
	Release any resources allocated within the appender such as file handles, network connections, etc. More...
virtual void	doAppend (const LoggingEvent &event)
	Log in Appender specific way. More...
virtual Filter *	getFilter ()
	Get the Filter for this appender. More...
virtual Priority::Value	getThreshold ()
	Get the threshold priority of this Appender. More...
virtual bool	reopen ()
	Reopens the output destination of this Appender, e.g. More...
virtual void	setFilter (Filter *filter)
	Set a Filter for this appender. More...
virtual void	setThreshold (Priority::Value priority)
	Set the threshold priority of this Appender. More...
virtual	~AppenderSkeleton ()
	Destructor for AppenderSkeleton. More...
Public Member Functions inherited from Appender
const std::string &	getName () const
	Get the name of this appender. More...
virtual	~Appender ()
	Destructor for Appender. More...

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

Private Member Functions
LayoutAppender &	operator= (const LayoutAppender &)

Private Attributes
Layout *	_layout

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

Detailed Description

LayoutAppender is a common superclass for all Appenders that require a Layout.

Definition at line 24 of file LayoutAppender.hh.

Member Typedef Documentation

typedef BasicLayout LayoutAppender::DefaultLayoutType

Definition at line 27 of file LayoutAppender.hh.

Constructor & Destructor Documentation

LayoutAppender::LayoutAppender

(

const std::string &

name

)

virtual LayoutAppender::~LayoutAppender ( )

virtual

Member Function Documentation

Layout& LayoutAppender::_getLayout ( )

protected

Return the layout of the appender.

This method is the Layout accessor for subclasses of LayoutAppender.

Returns

the Layout.

LayoutAppender& LayoutAppender::operator= ( const LayoutAppender &  )

private

virtual bool LayoutAppender::requiresLayout ( ) const

virtual

Check if the appender requires a layout.

All LayoutAppenders do, therefore this method returns true for all subclasses.

Returns

true.

Implements AppenderSkeleton.

virtual void LayoutAppender::setLayout ( Layout *  layout = NULL )

virtual

Set the Layout for this appender.

Parameters

layout

The layout to use.

Implements AppenderSkeleton.

Member Data Documentation

Layout* LayoutAppender::_layout

private

Definition at line 50 of file LayoutAppender.hh.

---

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

• LayoutAppender.hh