Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
log4cpp::Appender Class Referenceabstract

#include <Appender.hh>

Inheritance diagram for log4cpp::Appender:
Inheritance graph

Public Member Functions

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

Static Public Member Functions

static void closeAll ()
static AppendergetAppender (const std::string &name)
static bool reopenAll ()

Protected Member Functions

 Appender (const std::string &name)

Private Types

typedef std::map< std::string, Appender * > AppenderMap

Static Private Member Functions

static void _addAppender (Appender *appender)
static void _deleteAllAppenders ()
static AppenderMap_getAllAppenders ()
static void _removeAppender (Appender *appender)

Private Attributes

const std::string _name

Static Private Attributes

static AppenderMap_allAppenders = 0
static threading::Mutex _appenderMapMutex

Detailed Description

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

Definition at line 33 of file Appender.hh.

Member Typedef Documentation

typedef std::map<std::string, Appender*> log4cpp::Appender::AppenderMap

Definition at line 134 of file Appender.hh.

Constructor & Destructor Documentation

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

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

nameThe name of this Appender.

Definition at line 75 of file Appender.cpp.

log4cpp::Appender::~Appender ( )

Destructor for Appender.

Definition at line 80 of file Appender.cpp.

Member Function Documentation

void log4cpp::Appender::_addAppender ( Appender appender)

Definition at line 32 of file Appender.cpp.

void log4cpp::Appender::_deleteAllAppenders ( )

Definition at line 65 of file Appender.cpp.

Appender::AppenderMap & log4cpp::Appender::_getAllAppenders ( )

Definition at line 18 of file Appender.cpp.

void log4cpp::Appender::_removeAppender ( Appender appender)

Definition at line 38 of file Appender.cpp.

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

Call reopen() on all existing Appenders.

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

Definition at line 57 of file Appender.cpp.

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

Log in Appender specific way.

eventThe LoggingEvent to log.

Implemented in log4cpp::AppenderSkeleton.

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

Get a pointer to an exitsing Appender.

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

Definition at line 25 of file Appender.cpp.

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

Get the Filter for this appender.

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

Implemented in log4cpp::AppenderSkeleton.

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

Get the name of this appender. The name identifies the appender.

the name of the appender.

Definition at line 106 of file Appender.hh.

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

Get the threshold priority of this Appender.

the threshold

Implemented in log4cpp::AppenderSkeleton.

virtual bool log4cpp::Appender::reopen ( )
pure virtual

Reopens the output destination of this Appender, e.g. the logfile or TCP socket.

false if an error occured during reopening, true otherwise.

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

bool log4cpp::Appender::reopenAll ( )

Call reopen() on all existing Appenders.

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

Definition at line 46 of file Appender.cpp.

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

Check if the appender uses a layout.

true if the appender implementation requires a layout.

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

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

Set a Filter for this appender.

Implemented in log4cpp::AppenderSkeleton.

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

Set the Layout for this appender.

layoutThe layout to use.

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

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.

priorityThe priority to set.

Implemented in log4cpp::AppenderSkeleton.

Member Data Documentation

Appender::AppenderMap * log4cpp::Appender::_allAppenders = 0

Definition at line 136 of file Appender.hh.

threading::Mutex log4cpp::Appender::_appenderMapMutex

Definition at line 137 of file Appender.hh.

const std::string log4cpp::Appender::_name

Definition at line 144 of file Appender.hh.

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

Author(s): Stephen Roderick, Bastiaan Bakker, Cedric Le Goater, Steve Ostlind, Marcel Harkema, Walter Stroebel, Glenn Scott and Tony Cheung
autogenerated on Sun Jun 23 2019 19:10:00