fileappender.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_FILE_APPENDER_H
#define _LOG4CXX_FILE_APPENDER_H
 
#include <log4cxx/logger.h>
#include <log4cxx/logstring.h>
#include <log4cxx/writerappender.h>
#include <log4cxx/file.h>
#include <log4cxx/helpers/pool.h>
 
namespace LOG4CXX_NS
{
namespace helpers
{
class Pool;
}

class LOG4CXX_EXPORT FileAppender : public WriterAppender
{
    protected:
        struct FileAppenderPriv;
 
    public:
        DECLARE_LOG4CXX_OBJECT(FileAppender)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(FileAppender)
        LOG4CXX_CAST_ENTRY_CHAIN(WriterAppender)
        END_LOG4CXX_CAST_MAP()
 
        
        FileAppender();

        FileAppender(const LayoutPtr& layout, const LogString& filename, bool append,
            bool bufferedIO, int bufferSize);

        FileAppender(const LayoutPtr& layout, const LogString& filename, bool append);

        FileAppender(const LayoutPtr& layout, const LogString& filename);
 
        ~FileAppender();

        virtual void setFile(const LogString& file);

        bool getAppend() const;

        LogString getFile() const;
 
        using WriterAppender::activateOptions;
        void activateOptions( LOG4CXX_ACTIVATE_OPTIONS_FORMAL_PARAMETERS ) override;

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

        bool getBufferedIO() const;

        int getBufferSize() const;

        int getBufferedSeconds() const;

        void setAppend(bool newValue);

        void setBufferedIO(bool newValue);

        void setBufferSize(int newValue);

        void setBufferedSeconds(int newValue);

        static LogString stripDuplicateBackslashes(const LogString& name);
 
    protected:
        void activateOptionsInternal();

        void setFileInternal(const LogString& file, bool append,
            bool bufferedIO, size_t bufferSize);
 
        void setFileInternal(const LogString& file);
 
#if LOG4CXX_ABI_VERSION <= 15
        void activateOptionsInternal(helpers::Pool& p);
        void setFileInternal(const LogString& file, bool append,
            bool bufferedIO, size_t bufferSize,
            helpers::Pool& p);
#endif
    private:
        FileAppender(const FileAppender&);
        FileAppender& operator=(const FileAppender&);
    protected:
        FileAppender(std::unique_ptr<FileAppenderPriv> priv);
 
}; // class FileAppender
LOG4CXX_PTR_DEF(FileAppender);
 
}  // namespace log4cxx
 
#endif