appender.h

Go to the documentation of this file.

/*
 * 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
 
#include <log4cxx/spi/optionhandler.h>
#include <log4cxx/helpers/object.h>
#include <vector>
 
 
namespace LOG4CXX_NS
{
// Forward declarations
namespace spi
{
class LoggingEvent;
typedef std::shared_ptr<LoggingEvent> LoggingEventPtr;
 
class Filter;
typedef std::shared_ptr<Filter> FilterPtr;
 
class ErrorHandler;
typedef std::shared_ptr<ErrorHandler> ErrorHandlerPtr;
}
 
class Layout;
typedef std::shared_ptr<Layout> LayoutPtr;
 
 
class LOG4CXX_EXPORT Appender
#if LOG4CXX_ABI_VERSION <= 15
    : public virtual spi::OptionHandler
#else
    : public spi::OptionHandler
#endif
{
    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;
 
#if LOG4CXX_ABI_VERSION <= 15
#define LOG4CXX_APPEND_FORMAL_PARAMETERS const spi::LoggingEventPtr& event, helpers::Pool& p
#define LOG4CXX_APPEND_PARAMETERS event, p
        void doAppend(const spi::LoggingEventPtr& event);
        virtual void doAppend(const spi::LoggingEventPtr& event,
            LOG4CXX_NS::helpers::Pool& pool) = 0;
#else
#define LOG4CXX_APPEND_FORMAL_PARAMETERS const spi::LoggingEventPtr& event
#define LOG4CXX_APPEND_PARAMETERS event
        virtual void doAppend(const spi::LoggingEventPtr& event) = 0;
        [[deprecated("Use doAppend() without a Pool parameter instead")]]
        void doAppend(const spi::LoggingEventPtr& event, helpers::Pool& pool);
#endif
 
        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);
 
}
 
#endif //_LOG4CXX_APPENDER_H