rollingfileappender.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.
 */
 
#if !defined(_LOG4CXX_ROLLING_ROLLING_FILE_APPENDER_H)
#define _LOG4CXX_ROLLING_ROLLING_FILE_APPENDER_H
 
#include <log4cxx/fileappender.h>
#include <log4cxx/spi/optionhandler.h>
#include <log4cxx/fileappender.h>
#include <log4cxx/rolling/triggeringpolicy.h>
#include <log4cxx/rolling/rollingpolicy.h>
#include <log4cxx/rolling/action.h>
 
namespace LOG4CXX_NS
{
namespace rolling
{
 

class LOG4CXX_EXPORT RollingFileAppender : public FileAppender
{
        DECLARE_LOG4CXX_OBJECT(RollingFileAppender)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(RollingFileAppender)
        LOG4CXX_CAST_ENTRY_CHAIN(FileAppender)
        END_LOG4CXX_CAST_MAP()
    protected:
        struct RollingFileAppenderPriv;
 
    public:
        RollingFileAppender();
        RollingFileAppender( std::unique_ptr<RollingFileAppenderPriv> priv );

        int getMaxBackupIndex() const;

        size_t getMaximumFileSize() const;
 

        void setMaxBackupIndex( int maxBackupIndex );

        void setMaxFileSize( const LogString& value );
 
        void setMaximumFileSize( size_t value );

        void setDatePattern(const LogString& pattern);
 
        LogString makeFileNamePattern(const LogString& datePattern);

        void setOption( const LogString& option, const LogString& value ) override;
 
        using spi::OptionHandler::activateOptions;
        void activateOptions( LOG4CXX_ACTIVATE_OPTIONS_FORMAL_PARAMETERS ) override;

        bool rollover(LOG4CXX_NS::helpers::Pool& p);
 
    protected:

        void subAppend(const spi::LoggingEventPtr& event, helpers::Pool& p) override;
 
        bool rolloverInternal(LOG4CXX_NS::helpers::Pool& p);
 
    public:
        RollingPolicyPtr getRollingPolicy() const;

        TriggeringPolicyPtr getTriggeringPolicy() const;

        void setRollingPolicy(const RollingPolicyPtr& policy);

        void setTriggeringPolicy(const TriggeringPolicyPtr& policy);
 
    public:
        void close() override;
 
    protected:
        helpers::WriterPtr createWriter(LOG4CXX_16_CONST helpers::OutputStreamPtr& os) override;
 
    public:
        size_t getFileLength() const;

        void incrementFileLength(size_t increment);
 
};
 
LOG4CXX_PTR_DEF(RollingFileAppender);
 
}
}
 
#endif