log4shib 2.0.1
Loading...
Searching...
No Matches
log4shib::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 log4shib::AppenderSkeleton:
log4shib::Appender log4shib::AbortAppender log4shib::IdsaAppender log4shib::LayoutAppender log4shib::FileAppender log4shib::NTEventLogAppender log4shib::OstreamAppender log4shib::RemoteSyslogAppender log4shib::StringQueueAppender log4shib::SyslogAppender log4shib::Win32DebugAppender log4shib::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 log4shib::Appender
virtual ~Appender ()
 Destructor for Appender.
 
const std::string & getName () const
 Get the name of 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 log4shib::Appender
 Appender (const std::string &name)
 Constructor for Appender.
 

Additional Inherited Members

- Static Public Member Functions inherited from log4shib::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()

log4shib::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()

log4shib::AppenderSkeleton::~AppenderSkeleton ( )
virtual

Destructor for AppenderSkeleton.

Member Function Documentation

◆ _append()

virtual void log4shib::AppenderSkeleton::_append ( const LoggingEvent & event)
protectedpure virtual

◆ close()

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

◆ doAppend()

void log4shib::AppenderSkeleton::doAppend ( const LoggingEvent & event)
virtual

Log in Appender specific way.

Parameters
eventThe LoggingEvent to log.

Implements log4shib::Appender.

◆ getFilter()

Filter * log4shib::AppenderSkeleton::getFilter ( )
virtual

Get the Filter for this appender.

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

Implements log4shib::Appender.

◆ getThreshold()

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

Get the threshold priority of this Appender.

Returns
the threshold

Implements log4shib::Appender.

◆ reopen()

bool log4shib::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 log4shib::Appender.

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

◆ requiresLayout()

virtual bool log4shib::AppenderSkeleton::requiresLayout ( ) const
pure virtual

Check if the appender uses a layout.

Returns
true if the appender implementation requires a layout.

Implements log4shib::Appender.

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

◆ setFilter()

void log4shib::AppenderSkeleton::setFilter ( Filter * filter)
virtual

Set a Filter for this appender.

Implements log4shib::Appender.

◆ setLayout()

virtual void log4shib::AppenderSkeleton::setLayout ( Layout * layout)
pure virtual

Set the Layout for this appender.

Parameters
layoutThe layout to use.

Implements log4shib::Appender.

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

◆ setThreshold()

void log4shib::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 log4shib::Appender.


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