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
 
#include <log4cxx/appenderskeleton.h>
#include <log4cxx/helpers/appenderattachableimpl.h>
#include <log4cxx/spi/loggingevent.h>
 
namespace LOG4CXX_NS
{
LOG4CXX_LIST_DEF(LoggingEventList, spi::LoggingEventPtr);

class LOG4CXX_EXPORT AsyncAppender :
    public virtual spi::AppenderAttachable,
    public virtual AppenderSkeleton
{
    protected:
        struct AsyncAppenderPriv;
 
    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) override;
 
        void doAppend(const spi::LoggingEventPtr& event,
            helpers::Pool& pool1) override;
 
        void append(const spi::LoggingEventPtr& event, helpers::Pool& p) override;

        void close() override;

        AppenderList getAllAppenders() const override;

        AppenderPtr getAppender(const LogString& name) const override;

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

        void removeAllAppenders() override;

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

        bool replaceAppender(const AppenderPtr& oldAppender, const AppenderPtr& newAppender) LOG4CXX_16_VIRTUAL_SPECIFIER;

        void replaceAppenders(const AppenderList& newList) LOG4CXX_16_VIRTUAL_SPECIFIER;

        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) override;
 
 
    private:
        AsyncAppender(const AsyncAppender&);
        AsyncAppender& operator=(const AsyncAppender&);

        void dispatch();
 
}; // class AsyncAppender
LOG4CXX_PTR_DEF(AsyncAppender);
}  //  namespace log4cxx
 
#endif//  _LOG4CXX_ASYNC_APPENDER_H