log4cpp  1.1
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
log4cpp::Appender Class Referenceabstract

Implement this interface for your own strategies for printing log statements. More...

#include <Appender.hh>

Inheritance diagram for log4cpp::Appender:
log4cpp::AppenderSkeleton 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

Classes

class  AppenderMapStorage
 
class  AppenderMapStorageInitializer
 

Public Member Functions

virtual ~Appender ()
 Destructor for Appender. More...
 
virtual void doAppend (const LoggingEvent &event)=0
 Log in Appender specific way. More...
 
virtual bool reopen ()=0
 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...
 
const std::string & getName () const
 Get the name of this appender. More...
 
virtual void setThreshold (Priority::Value priority)=0
 Set the threshold priority of this Appender. More...
 
virtual Priority::Value getThreshold ()=0
 Get the threshold priority of this Appender. More...
 
virtual void setFilter (Filter *filter)=0
 Set a Filter for this appender. More...
 
virtual FiltergetFilter ()=0
 Get the Filter for this appender. More...
 

Static Public Member Functions

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...
 

Protected Member Functions

 Appender (const std::string &name)
 Constructor for Appender. More...
 

Friends

class Category
 

Detailed Description

Implement this interface for your own strategies for printing log statements.

Constructor & Destructor Documentation

◆ Appender()

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

Constructor for Appender.

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

Parameters
nameThe name of this Appender.

◆ ~Appender()

log4cpp::Appender::~Appender ( )
virtual

Destructor for Appender.

Member Function Documentation

◆ close()

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

◆ closeAll()

void log4cpp::Appender::closeAll ( )
static

Call reopen() on all existing Appenders.

Returns
true if all Appenders returned true on their reopen() call.

◆ doAppend()

virtual void log4cpp::Appender::doAppend ( const LoggingEvent event)
pure virtual

Log in Appender specific way.

Parameters
eventThe LoggingEvent to log.

Implemented in log4cpp::AppenderSkeleton.

◆ getAppender()

Appender * log4cpp::Appender::getAppender ( const std::string &  name)
static

Get a pointer to an exitsing Appender.

Parameters
nameThe name of the Appender to return.
Returns
a pointer to an existing Appender, or NULL if no appender with the specfied name exists.

◆ getFilter()

virtual Filter* log4cpp::Appender::getFilter ( )
pure virtual

Get the Filter for this appender.

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

Implemented in log4cpp::AppenderSkeleton.

◆ getName()

const std::string& log4cpp::Appender::getName ( ) const
inline

Get the name of this appender.

The name identifies the appender.

Returns
the name of the appender.

◆ getThreshold()

virtual Priority::Value log4cpp::Appender::getThreshold ( )
pure virtual

Get the threshold priority of this Appender.

Returns
the threshold

Implemented in log4cpp::AppenderSkeleton.

◆ reopen()

virtual bool log4cpp::Appender::reopen ( )
pure 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.

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

◆ reopenAll()

bool log4cpp::Appender::reopenAll ( )
static

Call reopen() on all existing Appenders.

Returns
true if all Appenders returned true on their reopen() call.

◆ requiresLayout()

virtual bool log4cpp::Appender::requiresLayout ( ) const
pure virtual

Check if the appender uses a layout.

Returns
true if the appender implementation requires a layout.

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

◆ setFilter()

virtual void log4cpp::Appender::setFilter ( Filter filter)
pure virtual

Set a Filter for this appender.

Implemented in log4cpp::AppenderSkeleton.

◆ setLayout()

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

Set the Layout for this appender.

Parameters
layoutThe layout to use.

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

◆ setThreshold()

virtual void log4cpp::Appender::setThreshold ( Priority::Value  priority)
pure 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.

Implemented in log4cpp::AppenderSkeleton.

Friends And Related Function Documentation

◆ Category

friend class Category
friend

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