appenderskeleton.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_SKELETON_H
#define _LOG4CXX_APPENDER_SKELETON_H

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


#include <log4cxx/appender.h>
#include <log4cxx/layout.h>
#include <log4cxx/spi/errorhandler.h>
#include <log4cxx/spi/filter.h>
#include <log4cxx/helpers/object.h>
#include <log4cxx/helpers/pool.h>
#include <log4cxx/level.h>

namespace log4cxx
{
class LOG4CXX_EXPORT AppenderSkeleton :
    public virtual Appender,
    public virtual helpers::Object
{
    protected:
        LayoutPtr layout;

        LogString name;

        LevelPtr threshold;

        spi::ErrorHandlerPtr errorHandler;

        spi::FilterPtr headFilter;

        spi::FilterPtr tailFilter;

        bool closed;

        log4cxx::helpers::Pool pool;
        mutable log4cxx::shared_mutex mutex;

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

        void doAppendImpl(const spi::LoggingEventPtr& event, log4cxx::helpers::Pool& pool);

    public:
        DECLARE_ABSTRACT_LOG4CXX_OBJECT(AppenderSkeleton)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(AppenderSkeleton)
        LOG4CXX_CAST_ENTRY(Appender)
        LOG4CXX_CAST_ENTRY(spi::OptionHandler)
        END_LOG4CXX_CAST_MAP()

        AppenderSkeleton();
        AppenderSkeleton(const LayoutPtr& layout);

        void finalize();

        virtual void activateOptions(log4cxx::helpers::Pool& /* pool */) {}
        virtual void setOption(const LogString& option, const LogString& value);

        void addFilter(const spi::FilterPtr& newFilter) ;

    public:
        void clearFilters();

        const spi::ErrorHandlerPtr& getErrorHandler() const
        {
            return errorHandler;
        }

        spi::FilterPtr getFilter() const
        {
            return headFilter;
        }

        const spi::FilterPtr& getFirstFilter() const
        {
            return headFilter;
        }

        LayoutPtr getLayout() const
        {
            return layout;
        }


        LogString getName() const
        {
            return name;
        }

        const LevelPtr& getThreshold() const
        {
            return threshold;
        }

        bool isAsSevereAsThreshold(const LevelPtr& level) const;


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

        void setErrorHandler(const spi::ErrorHandlerPtr eh);

        void setLayout(const LayoutPtr& layout1)
        {
            this->layout = layout1;
        }

        void setName(const LogString& name1)
        {
            this->name.assign(name1);
        }


        void setThreshold(const LevelPtr& threshold);

}; // class AppenderSkeleton
}  // namespace log4cxx

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


#endif //_LOG4CXX_APPENDER_SKELETON_H