Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | Class Members | Related Pages

Appender Class Reference

Inheritance diagram for Appender:

Inheritance graph
[legend]
Collaboration diagram for Appender:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void addFilter (const spi::FilterPtr &newFilter)=0
virtual const spi::FilterPtr & getFilter () const=0
virtual void clearFilters ()=0
virtual void close ()=0
virtual void doAppend (const spi::LoggingEventPtr &event)=0
virtual const String & getName () const=0
virtual void setErrorHandler (const spi::ErrorHandlerPtr &errorHandler)=0
virtual const spi::ErrorHandlerPtr & getErrorHandler () const=0
virtual void setLayout (const LayoutPtr &layout)=0
virtual const LayoutPtr & getLayout () const=0
virtual void setName (const String &name)=0
virtual bool requiresLayout () const=0

Detailed Description

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

Member Function Documentation

virtual void addFilter (  const spi::FilterPtr &  newFilter  )  [pure virtual]
 

Add a filter to the end of the filter list.

Implemented in AppenderSkeleton.

virtual void clearFilters (   )  [pure virtual]
 

Clear the list of filters by removing all the filters in it.

Implemented in AppenderSkeleton.

virtual void close (   )  [pure virtual]
 

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

It is a programming error to append to a closed appender.

Implemented in AsyncAppender, ODBCAppender, SMTPAppender, SocketAppender, SocketHubAppender, SyslogAppender, TelnetAppender, XMLSocketAppender, NTEventLogAppender, and WriterAppender.

virtual void doAppend (  const spi::LoggingEventPtr &  event  )  [pure virtual]
 

Log in Appender specific way. When appropriate, Loggers will call the doAppend method of appender implementations in order to log.

Implemented in AppenderSkeleton.

virtual const spi::ErrorHandlerPtr& getErrorHandler (   )  const [pure virtual]
 

Returns the ErrorHandler for this appender.

Implemented in AppenderSkeleton.

virtual const spi::FilterPtr& getFilter (   )  const [pure virtual]
 

Returns the head Filter. The Filters are organized in a linked list and so all Filters on this Appender are available through the result.

Returns:
the head Filter or null, if no Filters are present

Implemented in AppenderSkeleton.

virtual const LayoutPtr& getLayout (   )  const [pure virtual]
 

Returns this appenders layout.

Implemented in AppenderSkeleton.

virtual const String& getName (   )  const [pure virtual]
 

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

Implemented in AppenderSkeleton.

virtual bool requiresLayout (   )  const [pure virtual]
 

Configurators call this method to determine if the appender requires a layout. If this method returns true, meaning that layout is required, then the configurator will configure an layout using the configuration information at its disposal. If this method returns false, meaning that a layout is not required, then layout configuration will be skipped even if there is available layout configuration information at the disposal of the configurator..

In the rather exceptional case, where the appender implementation admits a layout but can also work without it, then the appender should return true.

Implemented in AsyncAppender, ODBCAppender, SMTPAppender, SocketAppender, SocketHubAppender, SyslogAppender, TelnetAppender, XMLSocketAppender, NTEventLogAppender, and WriterAppender.

virtual void setErrorHandler (  const spi::ErrorHandlerPtr &  errorHandler  )  [pure virtual]
 

Set the ErrorHandler for this appender.

Implemented in AppenderSkeleton.

virtual void setLayout (  const LayoutPtr &  layout  )  [pure virtual]
 

Set the Layout for this appender.

Implemented in AppenderSkeleton.

virtual void setName (  const String &  name  )  [pure virtual]
 

Set the name of this appender. The name is used by other components to identify this appender.

Implemented in AppenderSkeleton.

The documentation for this class was generated from the following file:
  • appender.h
Copyright © 1999-2004, Apache Software Foundation