writerappender.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_WRITER_APPENDER_H
#define _LOG4CXX_WRITER_APPENDER_H

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

#include <log4cxx/appenderskeleton.h>
#include <log4cxx/helpers/outputstreamwriter.h>
#include <log4cxx/boost-std-configuration.h>
#include <atomic>

namespace log4cxx
{

namespace helpers
{
class Transcoder;
}

class LOG4CXX_EXPORT WriterAppender : public AppenderSkeleton
{
    private:
        std::atomic<bool> immediateFlush;

        LogString encoding;

        log4cxx::helpers::WriterPtr writer;


    public:
        DECLARE_ABSTRACT_LOG4CXX_OBJECT(WriterAppender)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(WriterAppender)
        LOG4CXX_CAST_ENTRY_CHAIN(AppenderSkeleton)
        END_LOG4CXX_CAST_MAP()

        
        WriterAppender();
    protected:
        WriterAppender(const LayoutPtr& layout,
            log4cxx::helpers::WriterPtr& writer);
        WriterAppender(const LayoutPtr& layout);

    public:
        ~WriterAppender();

        virtual void activateOptions(log4cxx::helpers::Pool& pool);

        void setImmediateFlush(bool value);
        bool getImmediateFlush() const
        {
            return immediateFlush;
        }

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


    protected:
        virtual bool checkEntryConditions() const;


    public:
        virtual void close();

    protected:
        void closeWriter();

        virtual log4cxx::helpers::WriterPtr createWriter(
            log4cxx::helpers::OutputStreamPtr& os);

    public:
        LogString getEncoding() const;
        void setEncoding(const LogString& value);
        void setOption(const LogString& option,
            const LogString& value);

        void setWriter(const log4cxx::helpers::WriterPtr& writer);
#ifdef LOG4CXX_MULTI_PROCESS
        const log4cxx::helpers::WriterPtr getWriter()
        {
            return writer;
        };
#endif

        virtual bool requiresLayout() const;

    protected:
        virtual void subAppend(const spi::LoggingEventPtr& event, log4cxx::helpers::Pool& p);


        virtual void writeFooter(log4cxx::helpers::Pool& p);

        virtual void writeHeader(log4cxx::helpers::Pool& p);

        void setWriterInternal(const log4cxx::helpers::WriterPtr& writer);

    private:
        //
        //  prevent copy and assignment
        WriterAppender(const WriterAppender&);
        WriterAppender& operator=(const WriterAppender&);
};

LOG4CXX_PTR_DEF(WriterAppender);

}  //namespace log4cxx

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

#endif //_LOG4CXX_WRITER_APPENDER_H