appender.h

/*
 * 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
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _LOG4CXX_APPENDER_H
#define _LOG4CXX_APPENDER_H

#if defined(_MSC_VER)
    #pragma warning ( push )
    #pragma warning ( disable: 4231 4251 4275 4786 )
#endif


#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;


class LOG4CXX_EXPORT Appender :
    public virtual spi::OptionHandler
{
    public:
        DECLARE_ABSTRACT_LOG4CXX_OBJECT(Appender)

        virtual ~Appender() {}

        virtual void addFilter(const spi::FilterPtr& newFilter) = 0;

        virtual spi::FilterPtr getFilter() const = 0;

        virtual void clearFilters() = 0;

        virtual void close() = 0;

        virtual void doAppend(const spi::LoggingEventPtr& event,
            log4cxx::helpers::Pool& pool) = 0;


        virtual LogString getName() const = 0;


        virtual void setLayout(const LayoutPtr& layout) = 0;

        virtual LayoutPtr getLayout() const = 0;


        virtual void setName(const LogString& name) = 0;

        virtual bool requiresLayout() const = 0;
};

LOG4CXX_PTR_DEF(Appender);
LOG4CXX_LIST_DEF(AppenderList, AppenderPtr);

}

#if defined(_MSC_VER)
    #pragma warning ( pop )
#endif

#endif //_LOG4CXX_APPENDER_H