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/rolling/rollingpolicybase.h>
#include <log4cxx/rolling/triggeringpolicy.h>
#include <log4cxx/writerappender.h>
#include <log4cxx/helpers/outputstream.h>
#include <functional>
 
namespace LOG4CXX_NS
{
 
namespace rolling
{
 
 

class LOG4CXX_EXPORT TimeBasedRollingPolicy
#if LOG4CXX_ABI_VERSION <= 15
    : public virtual RollingPolicyBase
    , public virtual TriggeringPolicy
#else
    : public RollingPolicyBase
    , public virtual TriggeringPolicy
#endif
{
        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_DECLARE_PRIVATE_MEMBER_PTR(TimeBasedRollingPolicyPrivate, m_priv)
 
    public:
        TimeBasedRollingPolicy();
        virtual ~TimeBasedRollingPolicy();
 
        using RollingPolicyBase::activateOptions;
        void activateOptions( LOG4CXX_ACTIVATE_OPTIONS_FORMAL_PARAMETERS) override;
 
        void setMultiprocess(bool multiprocess);

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

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

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

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

        bool isLastFileNameUnchanged();

        void loadLastFileName();
 
    protected:
        LOG4CXX_NS::pattern::PatternMap getFormatSpecifiers() const override;
 
    private:

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

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

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

        int lockMMapFile(int type);

        int unLockMMapFile();

        const std::string createFile(const std::string& filename, const std::string& suffix, LOG4CXX_NS::helpers::Pool& pool);
 
};
 
LOG4CXX_PTR_DEF(TimeBasedRollingPolicy);
 
}
}
 
#endif