log4cpp 1.1
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | List of all members
log4cpp::LayoutAppender Class Reference

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

#include <LayoutAppender.hh>

Inheritance diagram for log4cpp::LayoutAppender:
log4cpp::AppenderSkeleton log4cpp::Appender log4cpp::BufferingAppender log4cpp::FileAppender log4cpp::OstreamAppender log4cpp::RemoteSyslogAppender log4cpp::StringQueueAppender log4cpp::SyslogAppender log4cpp::Win32DebugAppender log4cpp::DailyRollingFileAppender log4cpp::RollingFileAppender

Public Types

typedef BasicLayout DefaultLayoutType
 

Public Member Functions

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

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from log4cpp::Appender
static AppendergetAppender (const std::string &name)
 Get a pointer to an exitsing Appender.
 
static bool reopenAll ()
 Call reopen() on all existing Appenders.
 
static void closeAll ()
 Call reopen() on all existing Appenders.
 

Detailed Description

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

Member Typedef Documentation

◆ DefaultLayoutType

Constructor & Destructor Documentation

◆ LayoutAppender()

log4cpp::LayoutAppender::LayoutAppender ( const std::string &  name)

◆ ~LayoutAppender()

log4cpp::LayoutAppender::~LayoutAppender ( )
virtual

Member Function Documentation

◆ _getLayout()

Layout & log4cpp::LayoutAppender::_getLayout ( )
protected

Return the layout of the appender.

This method is the Layout accessor for subclasses of LayoutAppender.

Returns
the Layout.

◆ requiresLayout()

bool log4cpp::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 log4cpp::AppenderSkeleton.

◆ setLayout()

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

Set the Layout for this appender.

Parameters
layoutThe layout to use.

Implements log4cpp::AppenderSkeleton.


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