log4cpp::AppenderSkeleton Class Reference

#include <AppenderSkeleton.hh>

Inheritance diagram for log4cpp::AppenderSkeleton:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual void close ()=0
virtual void close ()=0
virtual void doAppend (const LoggingEvent &event)
virtual void doAppend (const LoggingEvent &event)
virtual FiltergetFilter ()
virtual FiltergetFilter ()
virtual Priority::Value getThreshold ()
virtual Priority::Value getThreshold ()
virtual bool reopen ()
virtual bool reopen ()
virtual bool requiresLayout () const =0
virtual bool requiresLayout () const =0
virtual void setFilter (Filter *filter)
virtual void setFilter (Filter *filter)
virtual void setLayout (Layout *layout)=0
virtual void setLayout (Layout *layout)=0
virtual void setThreshold (Priority::Value priority)
virtual void setThreshold (Priority::Value priority)
virtual ~AppenderSkeleton ()
virtual ~AppenderSkeleton ()

Protected Member Functions

virtual void _append (const LoggingEvent &event)=0
virtual void _append (const LoggingEvent &event)=0
 AppenderSkeleton (const std::string &name)
 AppenderSkeleton (const std::string &name)

Private Attributes

Filter_filter
Priority::Value _threshold

Detailed Description

AppenderSkeleton is a helper class, simplifying implementation of Appenders: it already takes care of handling of Thresholds and Filters.

Definition at line 24 of file include/log4cpp/AppenderSkeleton.hh.


Constructor & Destructor Documentation

log4cpp::AppenderSkeleton::AppenderSkeleton ( const std::string &  name  )  [protected]

Constructor for AppenderSkeleton. Will only be used in getAppender() (and in derived classes of course).

Parameters:
name The name of this Appender.

Definition at line 15 of file AppenderSkeleton.cpp.

log4cpp::AppenderSkeleton::~AppenderSkeleton (  )  [virtual]

Destructor for AppenderSkeleton.

Definition at line 21 of file AppenderSkeleton.cpp.

log4cpp::AppenderSkeleton::AppenderSkeleton ( const std::string &  name  )  [protected]

Constructor for AppenderSkeleton. Will only be used in getAppender() (and in derived classes of course).

Parameters:
name The name of this Appender.
virtual log4cpp::AppenderSkeleton::~AppenderSkeleton (  )  [virtual]

Destructor for AppenderSkeleton.


Member Function Documentation

virtual void log4cpp::AppenderSkeleton::_append ( const LoggingEvent event  )  [protected, pure virtual]
virtual void log4cpp::AppenderSkeleton::_append ( const LoggingEvent event  )  [protected, pure virtual]
virtual void log4cpp::AppenderSkeleton::close (  )  [pure virtual]
virtual void log4cpp::AppenderSkeleton::close (  )  [pure virtual]
virtual void log4cpp::AppenderSkeleton::doAppend ( const LoggingEvent event  )  [virtual]

Log in Appender specific way.

Parameters:
event The LoggingEvent to log.

Implements log4cpp::Appender.

void log4cpp::AppenderSkeleton::doAppend ( const LoggingEvent event  )  [virtual]

Log in Appender specific way.

Parameters:
event The LoggingEvent to log.

Implements log4cpp::Appender.

Definition at line 30 of file AppenderSkeleton.cpp.

virtual Filter* log4cpp::AppenderSkeleton::getFilter (  )  [virtual]

Get the Filter for this appender.

Returns:
the filter, or NULL if no filter has been set.

Implements log4cpp::Appender.

Filter * log4cpp::AppenderSkeleton::getFilter (  )  [virtual]

Get the Filter for this appender.

Returns:
the filter, or NULL if no filter has been set.

Implements log4cpp::Appender.

Definition at line 55 of file AppenderSkeleton.cpp.

virtual Priority::Value log4cpp::AppenderSkeleton::getThreshold (  )  [virtual]

Get the threshold priority of this Appender.

Returns:
the threshold

Implements log4cpp::Appender.

Priority::Value log4cpp::AppenderSkeleton::getThreshold (  )  [virtual]

Get the threshold priority of this Appender.

Returns:
the threshold

Implements log4cpp::Appender.

Definition at line 42 of file AppenderSkeleton.cpp.

virtual bool log4cpp::AppenderSkeleton::reopen (  )  [virtual]
bool log4cpp::AppenderSkeleton::reopen (  )  [virtual]
virtual bool log4cpp::AppenderSkeleton::requiresLayout (  )  const [pure virtual]

Check if the appender uses a layout.

Returns:
true if the appender implementation requires a layout.

Implements log4cpp::Appender.

Implemented in log4cpp::AbortAppender, log4cpp::IdsaAppender, log4cpp::LayoutAppender, log4cpp::AbortAppender, log4cpp::IdsaAppender, and log4cpp::LayoutAppender.

virtual bool log4cpp::AppenderSkeleton::requiresLayout (  )  const [pure virtual]

Check if the appender uses a layout.

Returns:
true if the appender implementation requires a layout.

Implements log4cpp::Appender.

Implemented in log4cpp::AbortAppender, log4cpp::IdsaAppender, log4cpp::LayoutAppender, log4cpp::AbortAppender, log4cpp::IdsaAppender, and log4cpp::LayoutAppender.

virtual void log4cpp::AppenderSkeleton::setFilter ( Filter filter  )  [virtual]

Set a Filter for this appender.

Implements log4cpp::Appender.

void log4cpp::AppenderSkeleton::setFilter ( Filter filter  )  [virtual]

Set a Filter for this appender.

Implements log4cpp::Appender.

Definition at line 46 of file AppenderSkeleton.cpp.

virtual void log4cpp::AppenderSkeleton::setLayout ( Layout layout  )  [pure virtual]

Set the Layout for this appender.

Parameters:
layout The layout to use.

Implements log4cpp::Appender.

Implemented in log4cpp::AbortAppender, log4cpp::IdsaAppender, log4cpp::LayoutAppender, log4cpp::AbortAppender, log4cpp::IdsaAppender, and log4cpp::LayoutAppender.

virtual void log4cpp::AppenderSkeleton::setLayout ( Layout layout  )  [pure virtual]

Set the Layout for this appender.

Parameters:
layout The layout to use.

Implements log4cpp::Appender.

Implemented in log4cpp::AbortAppender, log4cpp::IdsaAppender, log4cpp::LayoutAppender, log4cpp::AbortAppender, log4cpp::IdsaAppender, and log4cpp::LayoutAppender.

virtual void log4cpp::AppenderSkeleton::setThreshold ( Priority::Value  priority  )  [virtual]

Set the threshold priority of this Appender. The Appender will not appender LoggingEvents with a priority lower than the threshold. Use Priority::NOTSET to disable threshold checking.

Parameters:
priority The priority to set.

Implements log4cpp::Appender.

void log4cpp::AppenderSkeleton::setThreshold ( Priority::Value  priority  )  [virtual]

Set the threshold priority of this Appender. The Appender will not appender LoggingEvents with a priority lower than the threshold. Use Priority::NOTSET to disable threshold checking.

Parameters:
priority The priority to set.

Implements log4cpp::Appender.

Definition at line 38 of file AppenderSkeleton.cpp.


Member Data Documentation

Definition at line 107 of file include/log4cpp/AppenderSkeleton.hh.

Definition at line 106 of file include/log4cpp/AppenderSkeleton.hh.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


log4cpp
Author(s): Stephen Roderick
autogenerated on Fri Jan 11 09:51:54 2013