filewatchdog.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_HELPERS_FILEWATCHDOG_H
#define _LOG4CXX_HELPERS_FILEWATCHDOG_H
 
#include <log4cxx/logstring.h>
#include <log4cxx/file.h>
#include <log4cxx/spi/configurator.h>
 
namespace LOG4CXX_NS
{
namespace helpers
{
class FileWatchdog;
LOG4CXX_PTR_DEF(FileWatchdog);

class LOG4CXX_EXPORT FileWatchdog
{
    public:
        virtual ~FileWatchdog();
        static long DEFAULT_DELAY /*= 60000 ms*/;
 
    protected:
        FileWatchdog
            ( const File&                     filename
            , const spi::ConfiguratorPtr&     processor = {}
            , const spi::LoggerRepositoryPtr& target = {}
            );

        virtual void doOnChange();

        void checkAndConfigure();

        const File& file();
 
    public:
        FileWatchdogPtr getSharedPtr();

        spi::ConfigurationStatus getStatus();

        void setDelay(long millisecondDelay);

        void setFile(const File& filename);

        void start();

        void stop();

        bool is_active();

        static void stopAll();

        static auto startWatching
            ( const File&                     filename
            , const spi::ConfiguratorPtr&     processor
            , const spi::LoggerRepositoryPtr& target
            , long                            millisecondDelay
            ) -> spi::ConfigurationStatus;
    private:
 
        FileWatchdog(const FileWatchdog&);
        FileWatchdog& operator=(const FileWatchdog&);
 
        struct FileWatchdogPrivate;
        LOG4CXX_DECLARE_PRIVATE_MEMBER(std::shared_ptr<FileWatchdogPrivate>, m_priv)
};
}  // namespace helpers
} // namespace log4cxx
 
 
#endif // _LOG4CXX_HELPERS_FILEWATCHDOG_H