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
 
#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_NS
{

class LOG4CXX_EXPORT AppenderSkeleton
#if LOG4CXX_ABI_VERSION <= 15
    : public virtual Appender
    , public virtual helpers::Object
#else
    : public Appender
#endif
{
    protected:
        LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(AppenderSkeletonPrivate, m_priv)
        AppenderSkeleton(LOG4CXX_PRIVATE_PTR(AppenderSkeletonPrivate) priv);

        virtual void append( LOG4CXX_APPEND_FORMAL_PARAMETERS ) = 0;

        void doAppendImpl( LOG4CXX_APPEND_FORMAL_PARAMETERS );
        bool isAccepted(const spi::LoggingEventPtr& event) const;
 
    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);
        virtual ~AppenderSkeleton();
 
#if LOG4CXX_ABI_VERSION <= 15
        [[ deprecated( "The derived appender destructor needs to implement its cleanup" ) ]]
        void finalize();
#endif
 
        using spi::OptionHandler::activateOptions;
        void activateOptions( LOG4CXX_ACTIVATE_OPTIONS_FORMAL_PARAMETERS ) override;

        void setOption(const LogString& option, const LogString& value) override;

        void addFilter(const spi::FilterPtr newFilter) override;
 
    public:
        void clearFilters() override;

        const spi::ErrorHandlerPtr getErrorHandler() const;

        spi::FilterPtr getFilter() const override;

        const spi::FilterPtr getFirstFilter() const;

        LayoutPtr getLayout() const override;
 

        LogString getName() const override;

        const LevelPtr getThreshold() const;

        bool isAsSevereAsThreshold(const LevelPtr& level) const;
 

        void doAppend( LOG4CXX_APPEND_FORMAL_PARAMETERS ) override;

        void setErrorHandler(const spi::ErrorHandlerPtr eh);

        void setLayout(const LayoutPtr layout1) override;

        void setName(const LogString& name1) override;
 

        void setThreshold(const LevelPtr& threshold);
 
}; // class AppenderSkeleton
 
LOG4CXX_PTR_DEF(AppenderSkeleton);
}  // namespace log4cxx
 
#endif //_LOG4CXX_APPENDER_SKELETON_H