AppenderSkeleton is a helper class, simplifying implementation of Appenders: it already takes care of handling of Thresholds and Filters. More...
#include <AppenderSkeleton.hh>
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 Filter * | getFilter () |
| 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. | |
AppenderSkeleton is a helper class, simplifying implementation of Appenders: it already takes care of handling of Thresholds and Filters.
| log4shib::AppenderSkeleton::AppenderSkeleton | ( | const std::string & | name | ) | [protected] |
Constructor for AppenderSkeleton.
Will only be used in getAppender() (and in derived classes of course).
| name | The name of this Appender. |
| log4shib::AppenderSkeleton::~AppenderSkeleton | ( | ) | [virtual] |
Destructor for AppenderSkeleton.
| virtual void log4shib::AppenderSkeleton::_append | ( | const LoggingEvent & | event | ) | [protected, pure virtual] |
Log in Appender specific way.
Subclasses of Appender should implement this method to perform actual logging.
| event | The LoggingEvent to log. |
Implemented in log4shib::AbortAppender, log4shib::FileAppender, log4shib::IdsaAppender, log4shib::NTEventLogAppender, log4shib::OstreamAppender, log4shib::RemoteSyslogAppender, log4shib::RollingFileAppender, log4shib::StringQueueAppender, log4shib::SyslogAppender, and log4shib::Win32DebugAppender.
| virtual void log4shib::AppenderSkeleton::close | ( | ) | [pure virtual] |
Release any resources allocated within the appender such as file handles, network connections, etc.
Implements log4shib::Appender.
Implemented in log4shib::AbortAppender, log4shib::FileAppender, log4shib::IdsaAppender, log4shib::NTEventLogAppender, log4shib::OstreamAppender, log4shib::RemoteSyslogAppender, log4shib::StringQueueAppender, log4shib::SyslogAppender, and log4shib::Win32DebugAppender.
| void log4shib::AppenderSkeleton::doAppend | ( | const LoggingEvent & | event | ) | [virtual] |
Log in Appender specific way.
| event | The LoggingEvent to log. |
Implements log4shib::Appender.
| Filter * log4shib::AppenderSkeleton::getFilter | ( | ) | [virtual] |
Get the Filter for this appender.
Implements log4shib::Appender.
| Priority::Value log4shib::AppenderSkeleton::getThreshold | ( | ) | [virtual] |
| bool log4shib::AppenderSkeleton::reopen | ( | ) | [virtual] |
Reopens the output destination of this Appender, e.g.
the logfile or TCP socket.
Implements log4shib::Appender.
Reimplemented in log4shib::AbortAppender, log4shib::FileAppender, log4shib::IdsaAppender, log4shib::NTEventLogAppender, log4shib::OstreamAppender, log4shib::RemoteSyslogAppender, log4shib::StringQueueAppender, and log4shib::SyslogAppender.
| virtual bool log4shib::AppenderSkeleton::requiresLayout | ( | ) | const [pure virtual] |
Check if the appender uses a layout.
Implements log4shib::Appender.
Implemented in log4shib::AbortAppender, log4shib::IdsaAppender, log4shib::LayoutAppender, and log4shib::NTEventLogAppender.
| void log4shib::AppenderSkeleton::setFilter | ( | Filter * | filter | ) | [virtual] |
Set a Filter for this appender.
Implements log4shib::Appender.
| virtual void log4shib::AppenderSkeleton::setLayout | ( | Layout * | layout | ) | [pure virtual] |
Set the Layout for this appender.
| layout | The layout to use. |
Implements log4shib::Appender.
Implemented in log4shib::AbortAppender, log4shib::IdsaAppender, log4shib::LayoutAppender, and log4shib::NTEventLogAppender.
| 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.
| priority | The priority to set. |
Implements log4shib::Appender.
1.6.1