blob: 8fd798ef5d43c67e638e96bb71c9ba08aa657467 [file] [log] [blame]
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#if defined(_MSC_VER)
#pragma warning ( push )
#pragma warning ( disable: 4231 4251 4275 4786 )
#include <log4cxx/spi/optionhandler.h>
#include <log4cxx/helpers/objectptr.h>
#include <log4cxx/helpers/object.h>
#include <vector>
namespace log4cxx
// Forward declarations
namespace spi
class LoggingEvent;
typedef helpers::ObjectPtrT<LoggingEvent> LoggingEventPtr;
class Filter;
typedef helpers::ObjectPtrT<Filter> FilterPtr;
class ErrorHandler;
typedef log4cxx::helpers::ObjectPtrT<ErrorHandler> ErrorHandlerPtr;
class Layout;
typedef log4cxx::helpers::ObjectPtrT<Layout> LayoutPtr;
Implement this interface for your own strategies for outputting log
class LOG4CXX_EXPORT Appender :
public virtual spi::OptionHandler
virtual ~Appender() {}
Add a filter to the end of the filter list.
virtual void addFilter(const spi::FilterPtr& newFilter) = 0;
Returns the head Filter. The Filters are organized in a linked list
and so all Filters on this Appender are available through the result.
@return the head Filter or null, if no Filters are present
virtual spi::FilterPtr getFilter() const = 0;
Clear the list of filters by removing all the filters in it.
virtual void clearFilters() = 0;
Release any resources allocated within the appender such as file
handles, network connections, etc.
<p>It is a programming error to append to a closed appender.
virtual void close() = 0;
Log in <code>Appender</code> specific way. When appropriate,
Loggers will call the <code>doAppend</code> method of appender
implementations in order to log.
virtual void doAppend(const spi::LoggingEventPtr& event,
log4cxx::helpers::Pool& pool) = 0;
Get the name of this appender. The name uniquely identifies the
virtual LogString getName() const = 0;
Set the Layout for this appender.
virtual void setLayout(const LayoutPtr& layout) = 0;
Returns this appenders layout.
virtual LayoutPtr getLayout() const = 0;
Set the name of this appender. The name is used by other
components to identify this appender.
virtual void setName(const LogString& name) = 0;
Configurators call this method to determine if the appender
requires a layout. If this method returns <code>true</code>,
meaning that layout is required, then the configurator will
configure an layout using the configuration information at its
disposal. If this method returns <code>false</code>, 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..
<p>In the rather exceptional case, where the appender
implementation admits a layout but can also work without it, then
the appender should return <code>true</code>.
virtual bool requiresLayout() const = 0;
LOG4CXX_LIST_DEF(AppenderList, AppenderPtr);
#if defined(_MSC_VER)
#pragma warning ( pop )