appender.h

Go to the documentation of this file.

// Module:  Log4CPLUS
// File:    appender.h
// Created: 6/2001
// Author:  Tad E. Smith
//
//
// Copyright (C) Tad E. Smith  All rights reserved.
//
// This software is published under the terms of the Apache Software
// License version 1.1, a copy of which has been included with this
// distribution in the LICENSE.APL file.
//

#ifndef _LOG4CPLUS_APPENDER_HEADER_
#define _LOG4CPLUS_APPENDER_HEADER_

#include <log4cplus/config.h>
#include <log4cplus/layout.h>
#include <log4cplus/loglevel.h>
#include <log4cplus/tstring.h>
#include <log4cplus/helpers/logloguser.h>
#include <log4cplus/helpers/pointer.h>
#include <log4cplus/helpers/property.h>
#include <log4cplus/spi/filter.h>

#include <memory>


namespace log4cplus {

    class LOG4CPLUS_EXPORT ErrorHandler {
    public:
        virtual ~ErrorHandler();
        virtual void error(const log4cplus::tstring& err) = 0;
    };



    class LOG4CPLUS_EXPORT OnlyOnceErrorHandler : public ErrorHandler,
                                                  protected log4cplus::helpers::LogLogUser
    {
    public:
      // Ctor
        OnlyOnceErrorHandler() : firstTime(true){}

        virtual void error(const log4cplus::tstring& err);

    private:
        bool firstTime;
    };


    class LOG4CPLUS_EXPORT Appender : public log4cplus::helpers::SharedObject,
                                      protected log4cplus::helpers::LogLogUser

    {
    public:
      // Ctor
        Appender();
        Appender(const log4cplus::helpers::Properties properties);

      // Dtor
        virtual ~Appender(){};

        void destructorImpl();

      // Methods
        virtual void close() = 0;

        void doAppend(const log4cplus::spi::InternalLoggingEvent& event);

        virtual log4cplus::tstring getName();

        virtual void setName(const log4cplus::tstring& name);

        virtual void setErrorHandler(std::auto_ptr<ErrorHandler> eh);

        virtual ErrorHandler* getErrorHandler();

        virtual void setLayout(std::auto_ptr<Layout> layout);

        virtual Layout* getLayout();

        void setFilter(log4cplus::spi::FilterPtr f) { filter = f; }

        log4cplus::spi::FilterPtr getFilter() const { return filter; }

        LogLevel getThreshold() const { return threshold; }

        void setThreshold(LogLevel th) { threshold = th; }

        bool isAsSevereAsThreshold(LogLevel ll) const {
            return ((ll != NOT_SET_LOG_LEVEL) && (ll >= threshold));
        }

    protected:
      // Methods
        virtual void append(const log4cplus::spi::InternalLoggingEvent& event) = 0;

      // Data
        std::auto_ptr<Layout> layout;

        log4cplus::tstring name;

        LogLevel threshold;

        log4cplus::spi::FilterPtr filter;

        std::auto_ptr<ErrorHandler> errorHandler;

        bool closed;
    };

    typedef helpers::SharedObjectPtr<Appender> SharedAppenderPtr;

} // end namespace log4cplus

#endif // _LOG4CPLUS_APPENDER_HEADER_

---