syslogappender.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_NET_SYSLOG_APPENDER_H
#define _LOG4CXX_NET_SYSLOG_APPENDER_H

#include <log4cxx/appenderskeleton.h>
#include <log4cxx/helpers/syslogwriter.h>

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

namespace log4cxx
{
namespace net
{
class LOG4CXX_EXPORT SyslogAppender : public AppenderSkeleton
{
    public:
        DECLARE_LOG4CXX_OBJECT(SyslogAppender)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(SyslogAppender)
        LOG4CXX_CAST_ENTRY_CHAIN(AppenderSkeleton)
        END_LOG4CXX_CAST_MAP()



        SyslogAppender();
        SyslogAppender(const LayoutPtr& layout, int syslogFacility);
        SyslogAppender(const LayoutPtr& layout,
            const LogString& syslogHost, int syslogFacility);
        ~SyslogAppender();
        void close();

        static LogString getFacilityString(int syslogFacility);

        static int getFacility(const LogString& facilityName);

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

        void activateOptions(log4cxx::helpers::Pool& p);
        void setOption(const LogString& option, const LogString& value);

        virtual bool requiresLayout() const
        {
            return true;
        }

        void setSyslogHost(const LogString& syslogHost);

        inline const LogString& getSyslogHost() const
        {
            return syslogHost;
        }

        void setFacility(const LogString& facilityName);

        inline LogString getFacility() const
        {
            return getFacilityString(syslogFacility);
        }

        inline void setFacilityPrinting(bool facilityPrinting1)
        {
            this->facilityPrinting = facilityPrinting1;
        }

        inline bool getFacilityPrinting() const
        {
            return facilityPrinting;
        }

        inline void setMaxMessageLength(int maxMessageLength1)
        {
            maxMessageLength = maxMessageLength1;
        }

        inline int getMaxMessageLength() const
        {
            return maxMessageLength;
        }

    protected:
        void initSyslogFacilityStr();

        int syslogFacility; // Have LOG_USER as default
        LogString facilityStr;
        bool facilityPrinting;
        helpers::SyslogWriter* sw;
        LogString syslogHost;
        int syslogHostPort;
        int maxMessageLength;
    private:
        SyslogAppender(const SyslogAppender&);
        SyslogAppender& operator=(const SyslogAppender&);
}; // class SyslogAppender
LOG4CXX_PTR_DEF(SyslogAppender);
} // namespace net
} // namespace log4cxx

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

#endif // _LOG4CXX_NET_SYSLOG_APPENDER_H