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
 
#include <log4cxx/appenderskeleton.h>
#include <log4cxx/helpers/outputstreamwriter.h>
#include <atomic>
 
namespace LOG4CXX_NS
{

class LOG4CXX_EXPORT WriterAppender : public AppenderSkeleton
{
    protected:
        struct WriterAppenderPriv;
    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:
#if LOG4CXX_ABI_VERSION <= 15
        WriterAppender(const LayoutPtr& layout, helpers::WriterPtr& writer);
        WriterAppender(const LayoutPtr& layout);
#else
        WriterAppender(const LayoutPtr& layout, const helpers::WriterPtr& writer = helpers::WriterPtr());
#endif
        WriterAppender(std::unique_ptr<WriterAppenderPriv> priv);
 
    public:
        ~WriterAppender();

        void activateOptions(helpers::Pool& pool) override;

        void setImmediateFlush(bool value);
        bool getImmediateFlush() const;

        void append(const spi::LoggingEventPtr& event, helpers::Pool& p) override;
 
 
    protected:
        virtual bool checkEntryConditions() const;
 
 
    public:
        void close() override;
 
    protected:
        void closeWriter();

        virtual helpers::WriterPtr createWriter(LOG4CXX_16_CONST helpers::OutputStreamPtr& os);
 
    public:
        LogString getEncoding() const;
        void setEncoding(const LogString& value);

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

        void setWriter(const helpers::WriterPtr& writer);
 
        const helpers::WriterPtr getWriter() const;
 
        bool requiresLayout() const override;
 
    protected:
        virtual void subAppend(const spi::LoggingEventPtr& event, helpers::Pool& p);
 

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

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

        void setWriterInternal(const helpers::WriterPtr& writer);
 
    private:
        //
        //  prevent copy and assignment
        WriterAppender(const WriterAppender&);
        WriterAppender& operator=(const WriterAppender&);
};
 
LOG4CXX_PTR_DEF(WriterAppender);
 
}  //namespace log4cxx
 
#endif //_LOG4CXX_WRITER_APPENDER_H