log4cpp 1.1
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
log4cpp::AppenderSkeleton Class Referenceabstract

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

#include <AppenderSkeleton.hh>

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

Public Member Functions

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

 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

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

Constructor & Destructor Documentation

◆ AppenderSkeleton()

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

Constructor for AppenderSkeleton.

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

Parameters
nameThe name of this Appender.

◆ ~AppenderSkeleton()

log4cpp::AppenderSkeleton::~AppenderSkeleton ( )
virtual

Destructor for AppenderSkeleton.

Member Function Documentation

◆ _append()

virtual void log4cpp::AppenderSkeleton::_append ( const LoggingEvent event)
protectedpure virtual

◆ close()

virtual void log4cpp::AppenderSkeleton::close ( )
pure virtual

◆ doAppend()

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

Log in Appender specific way.

Parameters
eventThe LoggingEvent to log.

Implements log4cpp::Appender.

◆ getFilter()

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.

◆ getThreshold()

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

Get the threshold priority of this Appender.

Returns
the threshold

Implements log4cpp::Appender.

◆ reopen()

bool log4cpp::AppenderSkeleton::reopen ( )
virtual

Reopens the output destination of this Appender, e.g.

the logfile or TCP socket.

Returns
false if an error occured during reopening, true otherwise.

Implements log4cpp::Appender.

Reimplemented in log4cpp::AbortAppender, log4cpp::FileAppender, log4cpp::IdsaAppender, log4cpp::NTEventLogAppender, log4cpp::OstreamAppender, log4cpp::RemoteSyslogAppender, log4cpp::StringQueueAppender, and log4cpp::SyslogAppender.

◆ requiresLayout()

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, and log4cpp::NTEventLogAppender.

◆ setFilter()

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

Set a Filter for this appender.

Implements log4cpp::Appender.

◆ setLayout()

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

Set the Layout for this appender.

Parameters
layoutThe layout to use.

Implements log4cpp::Appender.

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

◆ setThreshold()

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
priorityThe priority to set.

Implements log4cpp::Appender.


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