appender.h

Go to the documentation of this file.

// -*- C++ -*-
// Module:  Log4CPLUS
// File:    appender.h
// Created: 6/2001
// Author:  Tad E. Smith
//
//
// Copyright 2001-2017 Tad E. Smith
//
// Licensed 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 LOG4CPLUS_APPENDER_HEADER_
#define LOG4CPLUS_APPENDER_HEADER_
 
#include <log4cplus/config.hxx>
 
#if defined (LOG4CPLUS_HAVE_PRAGMA_ONCE)
#pragma once
#endif
 
#include <log4cplus/layout.h>
#include <log4cplus/loglevel.h>
#include <log4cplus/tstring.h>
#include <log4cplus/helpers/pointer.h>
#include <log4cplus/spi/filter.h>
#include <log4cplus/helpers/lockfile.h>
 
#include <memory>
#include <mutex>
#include <atomic>
#include <condition_variable>
 
 
namespace log4cplus {
 
 
    namespace helpers
    {
 
        class Properties;
 
    }
 
 
    class LOG4CPLUS_EXPORT ErrorHandler
    {
    public:
        ErrorHandler ();
        virtual ~ErrorHandler() = 0;
        virtual void error(const log4cplus::tstring& err) = 0;
        virtual void reset() = 0;
    };
 
 
    class LOG4CPLUS_EXPORT OnlyOnceErrorHandler
        : public ErrorHandler
    {
    public:
      // Ctor
        OnlyOnceErrorHandler();
        virtual ~OnlyOnceErrorHandler ();
        virtual void error(const log4cplus::tstring& err);
        virtual void reset();
 
    private:
        bool firstTime;
    };
 
 
    class LOG4CPLUS_EXPORT Appender
        : public virtual log4cplus::helpers::SharedObject
    {
    public:
      // Ctor
        Appender();
        Appender(const log4cplus::helpers::Properties & properties);
 
      // Dtor
        virtual ~Appender();
 
        void destructorImpl();
 
      // Methods
        virtual void close() = 0;
 
        bool isClosed() const;
 
        void syncDoAppend(const log4cplus::spi::InternalLoggingEvent& event);
 
        void asyncDoAppend(const log4cplus::spi::InternalLoggingEvent& event);
 
        void doAppend(const log4cplus::spi::InternalLoggingEvent& event);
 
        virtual log4cplus::tstring getName();
 
        virtual void setName(const log4cplus::tstring& name);
 
        virtual void setErrorHandler(std::unique_ptr<ErrorHandler> eh);
 
        virtual ErrorHandler* getErrorHandler();
 
        virtual void setLayout(std::unique_ptr<Layout> layout);
 
        virtual Layout* getLayout();
 
        void setFilter(log4cplus::spi::FilterPtr f);
 
        log4cplus::spi::FilterPtr getFilter() const;
 
        void addFilter (log4cplus::spi::FilterPtr f);
 
        void addFilter (std::function<
            spi::FilterResult (const log4cplus::spi::InternalLoggingEvent &)>);
 
        LogLevel getThreshold() const { return threshold; }
 
        void setThreshold(LogLevel th) { threshold = th; }
 
        bool isAsSevereAsThreshold(LogLevel ll) const {
            return ((ll != NOT_SET_LOG_LEVEL) && (ll >= threshold));
        }
 
        void waitToFinishAsyncLogging();
 
    protected:
      // Methods
        virtual void append(const log4cplus::spi::InternalLoggingEvent& event) = 0;
 
        tstring & formatEvent (const log4cplus::spi::InternalLoggingEvent& event) const;
 
      // Data
        std::unique_ptr<Layout> layout;
 
        log4cplus::tstring name;
 
        LogLevel threshold;
 
        log4cplus::spi::FilterPtr filter;
 
        std::unique_ptr<ErrorHandler> errorHandler;
 
        std::unique_ptr<helpers::LockFile> lockFile;
 
        bool useLockFile;
 
        bool async;
#if ! defined (LOG4CPLUS_SINGLE_THREADED)
        std::atomic<std::size_t> in_flight;
        std::mutex in_flight_mutex;
        std::condition_variable in_flight_condition;
#endif
 
        bool closed;
 
    private:
#if ! defined (LOG4CPLUS_SINGLE_THREADED)
        void subtract_in_flight();
#endif
    };
 
    typedef helpers::SharedObjectPtr<Appender> SharedAppenderPtr;
 
} // end namespace log4cplus
 
#endif // LOG4CPLUS_APPENDER_HEADER_