rollingfileappenderskeleton.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_SKELETON_H)
#define _LOG4CXX_ROLLING_ROLLING_FILE_APPENDER_SKELETON_H

#include <log4cxx/portability.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
{
namespace rolling
{


class LOG4CXX_EXPORT RollingFileAppenderSkeleton : public FileAppender
{
        DECLARE_LOG4CXX_OBJECT(RollingFileAppenderSkeleton)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(RollingFileAppenderSkeleton)
        LOG4CXX_CAST_ENTRY_CHAIN(FileAppender)
        END_LOG4CXX_CAST_MAP()

        
        TriggeringPolicyPtr triggeringPolicy;

        RollingPolicyPtr rollingPolicy;

        size_t fileLength;

        spi::LoggingEventPtr* _event;
    public:
        RollingFileAppenderSkeleton();

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


        bool rollover(log4cxx::helpers::Pool& p);

    protected:

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

        bool rolloverInternal(log4cxx::helpers::Pool& p);

    protected:

        RollingPolicyPtr getRollingPolicy() const;

        TriggeringPolicyPtr getTriggeringPolicy() const;

        void setRollingPolicy(const RollingPolicyPtr& policy);

        void setTriggeringPolicy(const TriggeringPolicyPtr& policy);

    public:
        void close();

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

    public:



        size_t getFileLength() const;

#ifdef LOG4CXX_MULTI_PROCESS

        void setFileLength(size_t length);

        void releaseFileLock(apr_file_t* lock_file);
        void reopenLatestFile(log4cxx::helpers::Pool& p);
#endif

        void incrementFileLength(size_t increment);

};


LOG4CXX_PTR_DEF(RollingFileAppenderSkeleton);

}
}

#endif