Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
AppenderSkeleton Class Reference

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 AppenderSkeleton:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual void close ()=0
 Release any resources allocated within the appender such as file handles, network connections, etc.
virtual void doAppend (const LoggingEvent &event)
 Log in Appender specific way.
virtual FiltergetFilter ()
 Get the Filter for this appender.
virtual Priority::Value getThreshold ()
 Get the threshold priority of this Appender.
virtual bool reopen ()
 Reopens the output destination of this Appender, e.g.
virtual bool requiresLayout () const =0
 Check if the appender uses a layout.
virtual void setFilter (Filter *filter)
 Set a Filter for this appender.
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 ~AppenderSkeleton ()
 Destructor for AppenderSkeleton.

Protected Member Functions

virtual void _append (const LoggingEvent &event)=0
 Log in Appender specific way.
 AppenderSkeleton (const std::string &name)
 Constructor for AppenderSkeleton.

Private Member Functions

AppenderSkeletonoperator= (const AppenderSkeleton &)

Private Attributes

Filter_filter
Priority::Value _threshold

Detailed Description

AppenderSkeleton is a helper class, simplifying implementation of Appenders: it already takes care of handling of Thresholds and Filters.

Definition at line 24 of file AppenderSkeleton.hh.


Constructor & Destructor Documentation

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.
virtual AppenderSkeleton::~AppenderSkeleton ( ) [virtual]

Destructor for AppenderSkeleton.


Member Function Documentation

virtual void AppenderSkeleton::_append ( const LoggingEvent event) [protected, pure virtual]

Log in Appender specific way.

Subclasses of Appender should implement this method to perform actual logging.

Parameters:
eventThe LoggingEvent to log.

Implemented in RemoteSyslogAppender, FileAppender, SyslogAppender, IdsaAppender, StringQueueAppender, AbortAppender, RollingFileAppender, OstreamAppender, and BufferingAppender.

virtual void AppenderSkeleton::close ( ) [pure virtual]

Release any resources allocated within the appender such as file handles, network connections, etc.

Implements Appender.

Implemented in RemoteSyslogAppender, SyslogAppender, FileAppender, IdsaAppender, StringQueueAppender, AbortAppender, OstreamAppender, and BufferingAppender.

virtual void AppenderSkeleton::doAppend ( const LoggingEvent event) [virtual]

Log in Appender specific way.

Parameters:
eventThe LoggingEvent to log.

Implements Appender.

virtual Filter* AppenderSkeleton::getFilter ( ) [virtual]

Get the Filter for this appender.

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

Implements Appender.

Get the threshold priority of this Appender.

Returns:
the threshold

Implements Appender.

AppenderSkeleton& AppenderSkeleton::operator= ( const AppenderSkeleton ) [private]
virtual bool 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 Appender.

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

virtual bool AppenderSkeleton::requiresLayout ( ) const [pure virtual]

Check if the appender uses a layout.

Returns:
true if the appender implementation requires a layout.

Implements Appender.

Implemented in IdsaAppender, LayoutAppender, and AbortAppender.

virtual void AppenderSkeleton::setFilter ( Filter filter) [virtual]

Set a Filter for this appender.

Implements Appender.

virtual void AppenderSkeleton::setLayout ( Layout layout) [pure virtual]

Set the Layout for this appender.

Parameters:
layoutThe layout to use.

Implements Appender.

Implemented in IdsaAppender, AbortAppender, and LayoutAppender.

virtual void 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 Appender.


Member Data Documentation

Definition at line 107 of file AppenderSkeleton.hh.

Definition at line 106 of file AppenderSkeleton.hh.


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


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Thu Jun 6 2019 18:42:48