timebasedrollingpolicy.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_TIME_BASED_ROLLING_POLICY_H)
#define _LOG4CXX_ROLLING_TIME_BASED_ROLLING_POLICY_H

#include <log4cxx/portability.h>
#include <log4cxx/rolling/rollingpolicybase.h>
#include <log4cxx/rolling/triggeringpolicy.h>
#include <log4cxx/writerappender.h>
#include <log4cxx/helpers/outputstream.h>
#include <apr_mmap.h>

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

namespace log4cxx
{

namespace rolling
{



class LOG4CXX_EXPORT TimeBasedRollingPolicy : public RollingPolicyBase,
    public TriggeringPolicy
{
        DECLARE_LOG4CXX_OBJECT(TimeBasedRollingPolicy)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(TimeBasedRollingPolicy)
        LOG4CXX_CAST_ENTRY_CHAIN(RollingPolicyBase)
        LOG4CXX_CAST_ENTRY_CHAIN(TriggeringPolicy)
        END_LOG4CXX_CAST_MAP()

    private:
        log4cxx_time_t nextCheck;

        LogString lastFileName;

        apr_mmap_t* _mmap;

        /*
         * pool for mmap handler
         * */
        log4cxx::helpers::Pool* _mmapPool;

        apr_file_t* _file_map;

        std::string _mapFileName;

        /*
         * lock file handle
         * */
        apr_file_t* _lock_file;

        bool bAlreadyInitialized;

        /*
         * If the current file name contains date information, retrieve the current writting file from mmap
         * */
        bool bRefreshCurFile;

        /*
         * mmap file name
         * */
        LogString _fileNamePattern;

        int suffixLength;

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

#ifdef LOG4CXX_MULTI_PROCESS
        virtual ~TimeBasedRollingPolicy();

        int createMMapFile(const std::string& lastfilename, log4cxx::helpers::Pool& pool);

        bool isMapFileEmpty(log4cxx::helpers::Pool& pool);

        void initMMapFile(const LogString& lastFileName, log4cxx::helpers::Pool& pool);

        int lockMMapFile(int type);

        int unLockMMapFile();

        const std::string createFile(const std::string& filename, const std::string& suffix, log4cxx::helpers::Pool& pool);
#endif

        RolloverDescriptionPtr initialize(
            const   LogString&              currentActiveFile,
            const   bool                    append,
            log4cxx::helpers::Pool& pool);

        RolloverDescriptionPtr rollover(
            const   LogString&              currentActiveFile,
            const   bool                    append,
            log4cxx::helpers::Pool& pool);

        virtual bool isTriggeringEvent(
            Appender* appender,
            const log4cxx::spi::LoggingEventPtr& event,
            const LogString& filename,
            size_t fileLength);

    protected:
        log4cxx::pattern::PatternMap getFormatSpecifiers() const;

};

LOG4CXX_PTR_DEF(TimeBasedRollingPolicy);

}
}

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

#endif