log4cpp  1.1.3
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:
Inheritance graph
[legend]
Collaboration diagram for log4cpp::AppenderSkeleton:
Collaboration graph
[legend]

Public Member Functions

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

Protected Member Functions

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

Additional Inherited Members

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

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::SyslogAppender, log4cpp::StringQueueAppender, log4cpp::RemoteSyslogAppender, log4cpp::OstreamAppender, log4cpp::NTEventLogAppender, log4cpp::IdsaAppender, log4cpp::FileAppender, and log4cpp::AbortAppender.

◆ 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::NTEventLogAppender, log4cpp::LayoutAppender, log4cpp::IdsaAppender, and log4cpp::AbortAppender.

◆ 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::LayoutAppender, log4cpp::NTEventLogAppender, log4cpp::IdsaAppender, and log4cpp::AbortAppender.

◆ 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: