asyncappender.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_ASYNC_APPENDER_H
#define _LOG4CXX_ASYNC_APPENDER_H

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


#include <log4cxx/appenderskeleton.h>
#include <log4cxx/helpers/appenderattachableimpl.h>
#include <deque>
#include <log4cxx/spi/loggingevent.h>
#include <thread>
#include <condition_variable>

#if defined(NON_BLOCKING)
    #include <boost/lockfree/queue.hpp>
#endif

namespace log4cxx
{
LOG4CXX_LIST_DEF(LoggingEventList, log4cxx::spi::LoggingEventPtr);

class LOG4CXX_EXPORT AsyncAppender :
    public virtual spi::AppenderAttachable,
    public virtual AppenderSkeleton
{
    public:
        DECLARE_LOG4CXX_OBJECT(AsyncAppender)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(AsyncAppender)
        LOG4CXX_CAST_ENTRY_CHAIN(AppenderSkeleton)
        LOG4CXX_CAST_ENTRY(spi::AppenderAttachable)
        END_LOG4CXX_CAST_MAP()

        
        AsyncAppender();

        virtual ~AsyncAppender();

        void addAppender(const AppenderPtr newAppender);

        virtual void doAppend(const spi::LoggingEventPtr& event,
            log4cxx::helpers::Pool& pool1);

        void append(const spi::LoggingEventPtr& event, log4cxx::helpers::Pool& p);

        void close();

        AppenderList getAllAppenders() const;

        AppenderPtr getAppender(const LogString& name) const;

        bool getLocationInfo() const;
        bool isAttached(const AppenderPtr appender) const;

        virtual bool requiresLayout() const;

        void removeAllAppenders();

        void removeAppender(const AppenderPtr appender);
        void removeAppender(const LogString& name);

        void setLocationInfo(bool flag);

        void setBufferSize(int size);

        int getBufferSize() const;

        void setBlocking(bool value);

        bool getBlocking() const;


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


    private:
        AsyncAppender(const AsyncAppender&);
        AsyncAppender& operator=(const AsyncAppender&);
        enum { DEFAULT_BUFFER_SIZE = 128 };

#if defined(NON_BLOCKING)
        boost::lockfree::queue<log4cxx::spi::LoggingEvent* > buffer;
        std::atomic<size_t> discardedCount;
#else
        LoggingEventList buffer;
#endif

        std::mutex bufferMutex;

#if defined(NON_BLOCKING)
        ::log4cxx::helpers::Semaphore bufferNotFull;
        ::log4cxx::helpers::Semaphore bufferNotEmpty;
#else
        std::condition_variable bufferNotFull;
        std::condition_variable bufferNotEmpty;
#endif
        class DiscardSummary
        {
            private:
                ::log4cxx::spi::LoggingEventPtr maxEvent;

                int count;

            public:
                DiscardSummary(const ::log4cxx::spi::LoggingEventPtr& event);
                DiscardSummary(const DiscardSummary& src);
                DiscardSummary& operator=(const DiscardSummary& src);

                void add(const ::log4cxx::spi::LoggingEventPtr& event);

                ::log4cxx::spi::LoggingEventPtr createEvent(::log4cxx::helpers::Pool& p);

                static
				::log4cxx::spi::LoggingEventPtr createEvent(::log4cxx::helpers::Pool& p,
                    size_t discardedCount);
        };

        typedef std::map<LogString, DiscardSummary> DiscardMap;
        DiscardMap* discardMap;

        int bufferSize;

        helpers::AppenderAttachableImplPtr appenders;

        std::thread dispatcher;

        bool locationInfo;

        bool blocking;

        void dispatch();

}; // class AsyncAppender
LOG4CXX_PTR_DEF(AsyncAppender);
}  //  namespace log4cxx

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


#endif//  _LOG4CXX_ASYNC_APPENDER_H